C2数据标准接口规范.docx
《C2数据标准接口规范.docx》由会员分享，可在线阅读，更多相关《C2数据标准接口规范.docx（37页珍藏版）》请在冰豆网上搜索。
C2数据标准接口规范
数据分析系统基础数据获取方案
1概述
我方的数据分析系统由于无法主动获取基础数据，例如点播栏目信息、直播节目单等。
因此，造成了数据分析系统无基础数据可用，影响了分析结果的展现。
为了解决此问题，我方数据分析系统按照C2接口规范封装数据获取接口，模拟LSP采用SOAP协议+XML指令文件的方式获取基础数据信息。
2接口介绍
2.1流程描述
数据获取接口采用SOAP协议+XML指令文档的方式。
其中，SOAP消息是与具体指令内容无关的通用消息，仅仅用于表达命令请求。
而具体的命令及参数利用独立的XML文档来描述。
采用与具体指令无关的通用SOAP消息有利于指令扩展及在异步环境中实现通用的可靠消息传递机制。
CSP以SOAP协议+XML指令文档的方式主动向LSP发送基础数据信息，LSP根据SOAP消息中的文件URL获取XML并解析执行。
2.2SOAP消息定义
执行指令请求：
ExecCmdReq
消息方向：
CSPLSP
名称
说明
数据类型
是否必选
CSPID
互相约定的上层标识
String（32）
M
LSPID
互相约定的下层标识
String（32）
M
CorrelateID
相关性标识，用于关联指令执行请求消息和结果通知消息。
对于重发的指令，该字段值保持一致，对于不同的指令，该字段在同层内具有唯一性。
String（32）
M
CmdFileURL
XML指令文件的URL
URL
M
执行指令响应：
ExecCmdRes
消息方向：
CSPßLSP
名称
说明
数据类型
是否必选
Result
接收消息结果：
0：
成功
-1：
失败
Int
M
ErrorDescription
错误信息详细描述
String
O
结果通知请求：
ResultNotifyReq
消息方向：
CSPßLSP
名称
说明
数据类型
是否必选
CSPID
互相约定的上层标识
String（32）
M
LSPID
互相约定的下层标识
String（32）
M
CorrelateID
相关性标识，用于关联指令执行请求消息和结果通知消息。
String（32）
M
CmdResult
命令执行结果：
0：
成功
-1：
通常失败
其他结果待定义
Int
M
ResultFileURL
查询结果XML文件的URL，该字段仅针对查询结果通知消息出现。
URL
O
结果通知响应：
ResultNotifyRes
消息方向：
CSPàLSP
名称
说明
数据类型
是否必选
Result
接收消息结果：
0：
成功
-1：
失败
Int
M
ErrorDescription
错误信息详细描述
String
O
2.3XML文件规范
2.3.1概述
ADI/Objects/Mappings是接口XML的通用基础框架，基于该通用框架定义不同的Object.ElementType和不同的Property.Name来满足对不同对象的定义需求。
请注意本规范的描述中应用以下规则：
（1）Object.ElementType与Object.ID联合起来在接口中唯一定位一个对象实例，它们是一个接口中针对对象进行任何操作的唯一索引。
当对象之间有父子关系或多对多关系的时候，Object.ID也被用做关联引用标识。
（2）部分对象的Property属性中定义了Code属性，表示跨系统的全局唯一标识，LSP应保留备用。
（3）对于任何符合Schema（见附件）的XML文件，LSP应该忽略那些不能识别的Property或XMLTag或属性。
（4）以下对象中标识为”必填项”的属性，仅仅是针对REGIST操作。
而UPDATE操作进行的是增量修改，缺少某必填项，仅为表示不需要对此项进行修改，而不能修改此项为空。
DELETE操作只出现ElementType、ID、Code属性，其他属性不需要。
（5）接收方若收到某对象的REGIST操作，若系统中该对象已经存在，则应当作UPDATE操作处理。
该需求包括Mapping对象。
（6）接收方若收到Program、Movie、Series、Category、Package、Channel、Schedule对象的DELETE操作，应自动删除该对象关联的Picture、Movie、及该对象与其他对象的Mapping关系。
（7）XML文件内容的编码全部采用UTF-8格式。
以下章节描述了XML的详细定义。
在其中att表示XML属性,el表示XML元素,pn表示Property节点的Name）。
2.3.2ADI定义
ADI是XML的根元素。
No
Tag名/属性
描述
必填（Y/N）
长度
注释
1
ADI
根元素
2
Objects
el
操作对象
3
Mappings
el
映射对象
4
Reply
el
应答对象
应答文件包含
2.3.3Objects定义
Objects是操作对象。
操作类型REGIST表示增加新对象，UPDATE表示修改对象内容，DELETE表示删除对象。
Objects.ElementType定义：
序号
ElementType取值
说明
是否必要
基本内容管理
1
Program
节目信息
必要
2
Movie
媒体内容信息
必要
3
HTMLContent
图文内容信息
必要
4
Channel
TV频道信息
必要
5
PhysicalChannel
频道物理参数信息
必要
6
Schedule
TV时刻表信息
必要
7
Picture
图片信息
非必要
8
Category
编排目录信息
必要
9
Series
连续剧
必要
业务套餐管理
9
Package
包信息
必要
2.3.4Program定义
No
Property名/属性
描述
必填（Y/N）
长度
注释
1
Program
2
ElementType
att
“Program”
Y
3
ID
att
接口中的唯一标识
Y
32
4
Action
att
操作类型
注册－REGIST
更新－UPDATE
删除－DELETE
Y
5
Code
att
全局唯一标识
Y
32
6
Name
pn
节目名称
Y
128
7
OrderNumber
pn
节目订购编号
10
8
OriginalName
pn
原名
128
9
SortName
pn
索引发布时间供界面排序
128
10
SearchName
pn
搜索名称供界面搜索
128
11
ActorDisplay
pn
演员列表（只供显示）
256
12
WriterDisplay
pn
作者列表（只供显示）
256
13
OriginalCountry
pn
国家地区
64
14
Language
pn
语言
64
15
ReleaseYear
pn
上映年份
4
16
OrgAirDate
pn
首播时间
20
17
LicensingWindowStart
pn
有效开始时间
（YYYYMMDDHH24MiSS）
Y
14
18
LicensingWindowEnd
pn
有效结束时间
（YYYYMMDDHH24MiSS）
Y
14
19
DisplayAsNew
pn
新到天数
3
20
DisplayAsLastChance
pn
剩余天数
3
21
Macrovision
pn
拷贝保护标志
0:
无拷贝保护
1:
有拷贝保护
1
22
Description
pn
节目描述
4000
23
PriceTaxIn
pn
列表定价
12,2
24
Status
pn
状态标志
0:
失效1:
生效
1
25
SourceType
pn
1:
视频类节目
2:
图文类节目
1
26
SeriesFlag
pn
0:
影片
1:
单集
1
27
Kpeople
pn
主要人物
150
28
Director
pn
导演
50
29
ScriptWriter
pn
编剧
50
30
Compere
pn
节目主持人
50
31
Guest
pn
受访者
50
32
Reporter
pn
记者
50
33
OPIncharge
pn
其他责任人
50
34
Result
pn
0:
成功
其他:
错误代码
1
应答文件包含
35
ErrorDescription
pn
错误描述
1024
应答文件包含
2.3.5Movie定义
No
Property名/属性
描述
必填（Y/N）
长度
注释
1
Movie
2
ElementType
att
“Movie”
Y
3
ID
att
接口中的唯一标识
Y
32
4
Action
att
操作类型
发布－REGIST
更新－UPDATE
删除－DELETE
Y
5
Code
att
全局唯一标识
Y
32
6
Type
pn
媒体类型1:
正片2:
预览片
Y
1
7
FileURL
pn
媒体文件URL
ftp:
//username:
password@ip:
port/...标准FTP协议
Y
1024
8
SourceDRMType
pn
0:
NoDRM
1:
BESDRM
1
9
DestDRMType
pn
0:
NoDRM
1:
BESDRM
1
10
AudioType
pn
0:
其他
1:
Monaural单声道
2:
Stereo多声道
3:
Two-nationmonaural双单声道
4:
Two-nationstereo双多声道
5:
AC3（5:
1channel）AC3声道
2
11
ScreenFormat
pn
0:
4x3
1:
16x9（Wide）
1
12
ClosedCaptioning
pn
字幕标志
0:
无字幕
1:
有字幕
1
13
Result
pn
0:
成功
其他:
错误代码
1
应答文件包含
14
ErrorDescription
pn
错误描述
1024
应答文件包含
2.3.6HTMLContent定义
No
Property名/属性
描述
必填（Y/N）
长度
注释
1
HTMLContent
2
ElementType
att
“HTMLContent”
升级会员 