VMS接口协议文档.doc

VMS系统接口协议(草稿)
1. 概述
VMS系统接口协议如下：
接口类型：请求采用HTTP协议提交，请求方法为POST或GET方式。
返回参数描述：
返回参数名
描述
status
调用接口返回结果，0：操作成功； 其它值表示失败。
message
返回结果对应的描述信息。
result
操作返回的详细内容，如查询结果列表内容。
0
成功。
-1
失败:参数不正确。
-2
失败: 接口发生异常。
20
失败:参数不正确。
30
失败：内容不存在。
40
失败：内容信息不完整。
返回结果描述：
返回值
描述
response
<?xml version="" 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
推荐类型（必填）（）
Mo