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

VMS系统接口协议(草稿)
1. 概述
VMS系统接口协议如下：
接口类型：请求采用HTTP协议提交，请求方法为POST或GET方式。
返回参数描述：
返回参数名
描述
status
调用接口返回结果，0：操作成功； 其它值表示失败。
message
返回结果对应的描述信息。
result
操作返回的详细内容，如查询结果列表内容。
0
成功。
-1
失败:参数不正确。
-2
失败: 接口发生异常。
20
失败:参数不正确。
30
失败：内容不存在。
40
失败：内容信息不完整。
返回结果描述：
返回值
描述
response
<?xml version="1.0" encoding="UTF-8"?>
<response >
<status>0</status>
<message>操作成功</message>
<${datanode}>
XXXXXXXXXXXX
</${datanode}>
</response>
其中$datanode返回数据的父节点，用于客户端解析, 统一使用<vmsdata>节点组织内容

2. 影片基本信息接口

接口类型：请求采用HTTP协议提交。
接口url：http://{host}:{port}/{app name}/ clientapi/getBaseInfo
接口参数名：
参数名
描述
ContentID
内容标识（必填）
<vmsdata>节点描述：

返回节点值
返回节点描述
contentID
内容标识
name
内容名称
eName
内容英文名称
director
导演，多个用逗号隔开
actors
主演，多个用逗号隔开
publishDate
出品时间
contentType
内容类型
language
电影语言
publishArea
出品地区
duration
电影片长
tags
标签1，标签2（中间用半角逗号分隔）
salePoint
影片亮点描述
desc
剧情介绍
picUrl
(用urldecode下,中间用|分隔，如果是电视剧则为分集剧照)
playUrl
播放地址用urldecode,多个的话用|分隔开
guid
Uuid编号（废弃）
spid
服务商标识
playCounts
播放次数
lastUser
观看人数
saveCounts
收藏次数
postCounts
评论次数
avgSorce
评论总分（打分总数/人次）

3. 观看过某影片的用户信息接口

接口类型：请求采用HTTP协议提交。
接口url：http://{host}:{port}/{app name}/ clientapi/getUsernfoByID
接口参数名：
参数名
描述
ContentID
内容标识（必填）
<vmsdata>节点描述：

返回节点值
返回节点描述
lastUser
最后观看影片的四位用户信息，返回结果详细信息见下。

注：每位用户信息都以< vmsdata >开始，</ vmsdata >结束。多位用户组成多个<vmsdata>。如:
<vmsdata >
<userID>XXX</ userID >
<userName >XXX</ userName >
</ vmsdata >
<vmsdata >
< userID >XXX</ userID >
<userName >XXX</userName >
</ vmsdata >
4. 影片播放后接口

接口类型：请求采用HTTP协议提交。
接口url：http://{host}:{port}/{app name}/ clientapi/savePlayUserInfo
接口参数名：
参数名
描述
ContentID
内容标识（必填）
UserID
观看用户ID（必填）
UserName
观看用户名称（必填）
PlayTime
播放时间（必填）
<vmsdata>节点描述：

返回节点值
返回节点描述
无
无

5. 推荐影片接口

接口类型：请求采用HTTP协议提交。
接口url：http://{host}:{port}/{app name}/ clientapi/getRuleMovieInfo
接口参数名：
参数名
描述
RuleType
推荐类型（必填）（详细信息见9.推荐类型备注）
MovieNumber
影片个数（必填）
<vmsdata>节点描述：

返回节点值
返回节点描述
contentID
内容ID
name
电影中文名称
picUrl
海报地址
salePoint
亮点
playUrl
影片地址
director
导演，多个用逗号隔开
actors
主演，多个用逗号隔开

如：每部影片信息都以< vmsdata >开始，</ vmsdata >结束。多部影片组成多个<vmsdata>。如:
<vmsdata >
<name>XXX</name>
<picUrl >XXX</picUrl >
<salePoint >XXX</salePoint >
<playUrl >XXX</playUrl >
</ vmsdata >
<vmsdata >
<name>XXX</name>
<picUrl >XXX</picUrl >
<salePoint >XXX</salePoint >
<playUrl >XXX</playUrl >
</ vmsdata >

6. 编目影片接口

接口类型：请求采用HTTP协议提交。
接口url：http://{host}:{port}/{app name}/ clientapi/getCataLogMovieInfo
接口参数名：
参数名
描述
CatalogType
编目类型（必填）（详细信息见10编目类型备注）
StartIndex
起始索引号（如果IsParent为1，此字段不做判断使用）
RowNum
一次取得影片个数（如果IsParent为1，此字段不做判断使用）
IsParent
0：子节点（影片总数）；1：父节点（影片内容信息）

返回节点描述：

（1）.当IsParent为0时，

<totalNumber>节点描述
返回节点值
返回节点描述
totalNumber
影片总数

<vmsdata>节点描述：
返回节点值
返回节点描述
contentID
内容ID
name
电影中文名称
picUrl
海报地址
salePoint
亮点
playUrl
影片地址
totalNumber
影片总数

（2）.当IsParent为1时，

返回节点值
返回节点描述
catalogID
编目ID
catalogName
编目名称

IsParent为0时
如：每部影片信息都以< vmsdata >开始，</ vmsdata >结束。多部影片组成多个<vmsdata>。如:
<totalNumber>X<totalNumber>
<vmsdata >
<name>XXX</name>
<picUrl >XXX</picUrl >
<salePoint >XXX</salePoint >
<playUrl >XXX</playUrl >
</ vmsdata >
<vmsdata >
<name>XXX</name>
<picUrl >XXX</picUrl >
<salePoint >XXX</salePoint >
<playUrl >XXX</playUrl >
</ vmsdata >

IsParent为1时
<vmsdata >
<catalogID >XXX</catalogID >
<catalogName >XXX</catalogName >
</ vmsdata >

7. 我看过影片接口

接口类型：请求采用HTTP协议提交。
接口url：http://{host}:{port}/{app name}/ clientapi/getSeenMovieInfo
接口参数名：
参数名
描述
UserID
用户ID
RowNum
一次取得影片个数
<vmsdata>节点描述：

返回节点值
返回节点描述
contentID
内容ID
contentName
内容名称
viewTime
观看时间
contentLink
影片链接

8. 用户交互接口

接口类型：请求采用HTTP协议提交。
接口url：http://{host}:{port}/{app name}/ clientapi/customerService
接口参数名：
参数名
描述
UserID
用户ID
ContentID
内容ID
ServiceType
交互类型（0：评论；1：评分；2：印象）
DetailInfo
交互内容
<vmsdata>节点描述：

返回节点值
返回节点描述
无
无

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
表示按照出品地区，影片类型和内容类型检索，检索的类型放在符号”_”后面，如不需要作为检索条件，则省略。