VMS接口协议文档教学教材.doc

VMS系统接口协议(草稿) 1. 概述VMS系统接口协议如下： 接口类型：请求采用HTTP协议提交，请求方法为POST或GET方式。 返回参数描述：返回参数名描述status调用接口返回结果，0：操作成功； 其它值表示失败。message返回结果对应的描述信息。result操作返回的详细内容，如查询结果列表内容。0成功。-1失败:参数不正确。-2失败: 接口发生异常。20失败:参数不正确。30失败：内容不存在。40失败：内容信息不完整。返回结果描述：返回值描述response0操作成功XXXXXXXXXXXX其中$datanode返回数据的父节点，用于客户端解析, 统一使用节点组织内容2. 影片基本信息接口接口类型：请求采用HTTP协议提交。接口url：http:/host:port/app name/ clientapi/getBaseInfo接口参数名：参数名描述ContentID内容标识（必填） 节点描述： 返回节点值返回节点描述contentID内容标识name内容名称eName内容英文名称director导演，多个用逗号隔开actors主演，多个用逗号隔开publishDate出品时间contentType内容类型language电影语言publishArea出品地区duration电影片长tags标签1，标签2（中间用半角逗号分隔）salePoint影片亮点描述desc剧情介绍picUrl (用urldecode下,中间用|分隔，如果是电视剧则为分集剧照)playUrl播放地址用urldecode,多个的话用|分隔开guidUuid编号（废弃）spid服务商标识playCounts播放次数lastUser观看人数saveCounts收藏次数postCounts评论次数avgSorce评论总分（打分总数/人次）3. 观看过某影片的用户信息接口接口类型：请求采用HTTP协议提交。接口url：http:/host:port/app name/ clientapi/getUsernfoByID接口参数名：参数名描述ContentID内容标识（必填） 节点描述： 返回节点值返回节点描述lastUser最后观看影片的四位用户信息，返回结果详细信息见下。注：每位用户信息都以开始，结束。多位用户组成多个。如: XXXXXXXXXXXX4. 影片播放后接口接口类型：请求采用HTTP协议提交。接口url：http:/host:port/app name/ clientapi/savePlayUserInfo接口参数名：参数名描述ContentID内容标识（必填）UserID观看用户ID（必填）UserName观看用户名称（必填）PlayTime播放时间（必填） 节点描述： 返回节点值返回节点描述无无5. 推荐影片接口接口类型：请求采用HTTP协议提交。接口url：http:/host:port/app name/ clientapi/getRuleMovieInfo接口参数名：参数名描述RuleType推荐类型（必填）（详细信息见9.推荐类型备注）MovieNumber影片个数（必填） 节点描述： 返回节点值返回节点描述contentID内容IDname电影中文名称picUrl海报地址salePoint亮点playUrl影片地址director导演，多个用逗号隔开actors主演，多个用逗号隔开 如：每部影片信息都以开始，结束。多部影片组成多个。如: XXXXXXXXXXXXXXXXXXXXXXXX6. 编目影片接口接口类型：请求采用HTTP协议提交。接口url：http:/host:port/app name/ clientapi/getCataLogMovieInfo接口参数名：参数名描述CatalogType编目类型（必填）（详细信息见10编目类型备注）StartIndex起始索引号（如果IsParent为1，此字段不做判断使用）RowNum一次取得影片个数（如果IsParent为1，此字段不做判断使用）IsParent0：子节点（影片总数）；1：父节点（影片内容信息） 返回节点描述：（1）.当IsParent为0时， 节点描述返回节点值返回节点描述totalNumber影片总数 节点描述：返回节点值返回节点描述contentID内容IDname电影中文名称picUrl海报地址salePoint亮点playUrl影片地址totalNumber影片总数 （2）.当IsParent为1时， 返回节点值返回节点描述catalogID编目IDcatalogName编目名称IsParent为0时如：每部影片信息都以开始，结束。多部影片组成多个。如: X XXXXXXXXXXXXXXXXXXXXXXXXIsParent为1时 XXXXXX7. 我看过影片接口接口类型：请求采用HTTP协议提交。接口url：http:/host:port/app name/ clientapi/getSeenMovieInfo接口参数名：参数名描述UserID用户IDRowNum一次取得影片个数 节点描述： 返回节点值返回节点描述contentID内容IDcontentName内容名称viewTime观看时间contentLink影片链接 8. 用户交互接口接口类型：请求采用HTTP协议提交。接口url：http:/host:port/app name/ clientapi/customerService接口参数名：参数名描述UserID用户IDContentID内容IDServiceType交互类型（0：评论；1：评分；2：印象）DetailInfo交互内容 节点描述： 返回节点值返回节点描述无无9. 推荐类型备注推荐类型值类型描述homePageAll首页推荐-规则随机显示一组高清影片信息-不分电视剧和电影homepageMovie首页推荐-规则随机显示一组高清影片信息-只有电影homepageSerial首页推荐-规则随机显示一组高清影片信息-只有电视剧homepageOldMovie经典怀旧-规则随机显示一组高清影片信息-只有电影homepageOldSerial经典怀旧-规则随机显示一组高清影片信息-只有电视剧movieChartsDay电影排行榜-按天movieChartsWeek电影排行榜-按周movieChartsAll电影排行榜-所有serialChartsDay电视剧排行榜-按天serialChartsWeek电视剧排行榜-按周serialChartsAll电视剧排行榜-所有hotMovie显示后台设置的电影hotSerial显示后台设置的电视剧newMovie显示后台设置的电影newSerial显示后台设置的电视剧listChineseMovieDay电影华语排行榜-按天listChineseMovieWeek电影华语排行榜-按周listEuropeMovieDay电影欧美排行榜-按天listEuropeMovieWeek电影欧美排行榜-按周10. 编目类型备注编目类型值类型描述areaInland内地（不分电影，电视剧）areaEurope欧美（不分电影，电视剧）comedyType喜剧（不分电影，电视剧）tragedyType悲剧（不分电影，电视剧）comedyInland内地喜剧areaType_01|classType_01|contentType_01表示按照出品地区，影片类型和内容类型检索，检索的类型放在符号”_”后面，如不需要作为检索条件，则省略。