C2数据标准接口规范

1、目录TOC o 1-5 h z概述1接口介绍2流程描述2SOAP消息定义2XML文件规范4概述4 HYPERLINK l bookmark3 ADI定义5 HYPERLINK l bookmark5 OBJECTS定义5 HYPERLINK l bookmark7 PROGRAM定义6 HYPERLINK l bookmark9 MOVIE定义8 HYPERLINK l bookmark11 HTMLCONTENT定义.10 HYPERLINK l bookmark13 CHANNEL定义10 HYPERLINK l bookmark15 PHYSICALCHANNEL定义12 HYPERLI

2、NK l bookmark17 SCHEDULE定义13 HYPERLINK l bookmark19 PICTURE定义15 HYPERLINK l bookmark21 CATEGORY定义15 HYPERLINK l bookmark23 SERIES定义16 HYPERLINK l bookmark25 PACKAGE定义18 HYPERLINK l bookmark27 MAPPINGS定义20 HYPERLINK l bookmark29 REPLY定义23数据转换24历史数据25 概述我方的数据分析系统由于无法主动获取基础数据，例如点播栏目信息、直播节目单等。因此，造成了数据分析

3、系统无基础数据可用，影响了分析结果的展现。为了解决此问题，我方数据分析系统按照C2接口规范封装数据获取接口，模拟LSP采用SOAP协议+XML指令文件的方式获取基础数据信息。2接口介绍2.1流程描述数据获取接口采用SOAP协议+XML指令文档的方式。其中，SOAP消息是与具体指令内容无关的通用消息，仅仅用于表达命令请求。而具体的命令及参数利用独立的XML文档来描述。采用与具体指令无关的通用SOAP消息有利于指令扩展及在异步环境中实现通用的可靠消息传递机制。CSP以SOAP协议+XML指令文档的方式主动向LSP发送基础数据信息，LSP根据SOAP消息中的文件URL获取XML并解析执行。CSPSO

4、AP:ExecCmdReq-LSP二SOAP:ExecCmdRes下层获取XML指令文件.发起工作流或一直接执行指令执行过程可能包括下载图片媒体文件产SOAP:ResultNotifyReqSOAP:ResultNotifyRes2.2SOAP消息定义执行指令请求：ExecCmdReq消息方向：CSPbLSP名称说明数据类型是否必选CSPID互相约定的上层标识String(32)MLSPID互相约定的下层标识String(32)MCorrelatelD相关性标识，用于关联指令执行请求消息和结果通知消息。对于重发的指令，该字段值保持一致，对于不同的指令，该字段在同层内具有唯一性。String(3

5、2)MCmdFileURLXML指令文件的URLURLM执行指令响应：ExecCmdRes消息方向：CSPGLSP名称说明数据类型是否必选Result接收消息结果：0：成功-1：失败IntMErrorDescription错误信息详细描述StringO结果通知请求：ResultNotifyReq消息方向：CSPGLSP名称说明数据类型是否必选CSPID互相约定的上层标识String(32)MLSPID互相约定的下层标识String(32)MCorrelateID相关性标识，用于关联指令执行请求消息和结果通知消息。String(32)MCmdResult命令执行结果：0：成功-1：通常失败其他结

6、果待定义IntMResultFileURL查询结果XML文件的URL，该字段仅针对查询结果通知消息出现。URLO结果通知响应：ResultNotifyRes消息方向：CSP3LSP名称说明数据类型是否必选Result接收消息结果：0：成功-1：失败IntMErrorDescription错误信息详细描述StringO2.3XML文件规范概述ADI/Objects/Mappings是接口XML的通用基础框架，基于该通用框架定义不同的Object.ElementType和不同的Property.Name来满足对不同对象的定义需求。请注意本规范的描述中应用以下规则：Object.ElementTyp

7、e与Object.ID联合起来在接口中唯一定位一个对象实例，它们是一个接口中针对对象进行任何操作的唯一索引。当对象之间有父子关系或多对多关系的时候，Object.ID也被用做关联引用标识。部分对象的Property属性中定义了Code属性，表示跨系统的全局唯一标识，LSP应保留备用。对于任何符合Schema(见附件)的XML文件，LSP应该忽略那些不能识别的Property或XMLTag或属性。(4)以下对象中标识为”必填项”的属性，仅仅是针对REGIST操作。而UPDATE操作进行的是增量修改，缺少某必填项，仅为表示不需要对此项进行修改，而不能修改此项为空。DELETE操作只出现Elemen

8、tType、ID、Code属性，其他属性不需要。(5)接收方若收到某对象的REGIST操作，若系统中该对象已经存在，则应当作UPDATE操作处理。该需求包括Mapping对象。(6)接收方若收至UProgram、Movie、Series、Category、Package、Channel、Schedule对象的DELETE操作，应自动删除该对象关联的Picture、Movie、及该对象与其他对象的Mapping关系。XML文件内容的编码全部采用UTF-8格式。以下章节描述了XML的详细定义。在其中att表示XML属性，el表示XML元素，pn表示Property节点的Name)。ADI定义ADI

9、是XML的根元素。NoTag名/属性描述必填(Y/N)长度注释1ADI根元素2Objectsel操作对象3Mappingsel映射对象4Replyel应答对象应答文件包含Objects定义Objects是操作对象。操作类型REGIST表示增加新对象，UPDATE表示修改对象内容，DELETE表示删除对象。Objects.ElementType定义：序号ElementType取值说明是否必要基本内容管理1Program节目信息必要2Movie媒体内容信息必要3HTMLContent图文内容信息必要4ChannelTV频道信息必要5PhysicalChannel频道物理参数信息必要6Schedul

10、eTV时刻表信息必要7Picture图片信息非必要8Category编排目录信息必要9Series连续剧必要业务套餐管理9Package包信息必要Program定义NoProperty名/属性描述必填(Y/N)长度注释1Program2日ementTypeat“Program”Y3IDat接口中的唯一标识Y324Actionat操作类型注册一REGIST更新UPDATE删除一DELETEY5Codeat全局唯一标识Y326Namep节目名称Y1287OrderNumberp节目订购编号108OriginalNamep原名1289SortNamep索引发布时间供界面排序12810SearchNa

11、mep搜索名称供界面搜索12811ActorDisplayp演员列表（只供显示）25612WriterDisplayp作者列表（只供显示）25613OriginalCountrp国家地区64yn14Languagep语言6415ReleaseYearp上映年份416OrgAirDatep首播时间2017LicensingWindowStartp有效开始时间(YYYYMMDDHH24MiSS)Y1418LicensingWindowEndp有效结束时间(YYYYMMDDHH24MiSS)Y1419DisplayAsNewp新到天数320DisplayAsLastChancep剩余天数321Mac

12、rovisionp拷贝保护标志0:无拷贝保护1:有拷贝保护122Descriptionp节目描述400023PriceTaxInp列表定价12,224Statusp状态标志0:失效1:生效125SourceTypep1:视频类节目2:图文类节目126SeriesFlagp0:影片1:单集127Kpeoplep150n28Directorp导演5029Scriptwriterp编剧5030Comperep节目主持人5031Guestp受访者5032Reporterp记者5033OPInchargep其他责任人5034Resultp0:成功其他：错误代码1应答文件包含35ErrorDescript

13、ionp错误描述1024应答文件包含Movie定义NoProperty名/属性描述必填(Y/N)长度注释1Movie2at“Movie”Y3IDat接口中的唯一标识Y324Actionat操作类型发布一REGIST更新UPDATEY删除一DELETE5Codeat全局唯一标识Y326TypeP媒体类型1:正片2:预览片Y17FileURLP媒体文件URLftP：/username：PasswordiP：Port/.标准FTP协议Y10248SourceDRMTypeP0:NoDRM1:BESDRM19DestDRMTypP0:NoDRM1:BESDRM110AudioTypeP0：其他Mona

14、ural单声道Stereo多声道Two-nationmonaural双单声道Two-nationstereo双多声道AC3(5:1channel)AC3声道211ScreenFormatP0:4x31:16x9(Wide)112ClosedCaptioningP字幕标志0:无字幕1:有字幕113ResultP0:成功其他：错误代码1应答文件包含14ErrorDescriptionP错误描述1024应答文件包含HTMLContent定义NoProperty名/属性描述必填(Y/N)长度注释1HTMLContent2日ementTypeatt“HTMLContent”Y3IDatt接口中的唯一标识

15、Y324Actionatt操作类型发布一REGIST更新UPDATE删除一DELETEY5Codeatt全局唯一标识Y326FileURLpn图文节目的HTMLTAR包文件URLftp:/username:passwordip:port/.标准FTP协议Y1024下平台从此URL获取图文节目包7ResultPn0:成功其他：错误代码1应答文件包含8ErrorDescriptionPn错误描述1024应答文件包含Channel定义NoProperty名/属性描述必填(Y/N)长度注释1Channel2日ementTypeatt“Channel”Y3IDatt接口中的唯一标识Y4Actionatt

16、操作类型Y发布一REGISI更新UPDATE删除一DELETE5Codeatt全局唯一标识Y326ChannelNumberpn建议频道号37Namepn频道名称Y648CallSignpn台标名称109TimeShiftpn时移标志0:不生效1:生效110StorageDurationpn存储时长，单位小时9该频道的录制节目保存时长，可用于时移和回看。11TimeShiftDuration默认时移时长，单位分钟(Reserved)仅仅对Timeshift有效12Descriptionpn描述信息102413Countrypn国家1013Statepn州/省1014Citypn城市1015Zi

17、pCodepn邮编1016Typepn频道类型1：直播频道Y117SubTypepn当Type为1(直播频道)1：信号源来自live2:信号源来自virtual119Languagepn语言12819Statuspn状态标志0:失效1:生效Y120StartTimepn播放开始时间(HH24MI)421EndTimepn播放结束时间(HH24MI)422Macrovisionpn拷贝保护标志0:无拷贝保护1:有拷贝保护123VideoTypepn视频参数（参考4.1）1024AudioTypepn音频参数（参考4.1）1025StreamTypepn码流标志（参考4.1）126Bilingua

18、lpn双语标志（0/1）127Resultpn0：成功其他：错误代码1应答文件包含28ErrorDescriptionpn错误描述1024应答文件包含PhysicalChannel定义NoProperty名/属性描述必填(Y/N)长度注释1PhysicalChannel2ElementTypeat“PhysicalChannel”Y3IDat唯一IDY324Actionat操作类型发布一REGIST更新UPDATE删除一DELETEY5Codeat全局唯一标识Y326ChannelCodep频道CodeY327ChannelIDp频道IDN328BitRateTypeP码流2:2M4:4M19

19、MultiCastIPP组播IPY6410MultiCastPortP组播端口Y511ResultP0：成功其他：错误代码1应答文件包含12ErrorDescriptionP错误描述1024应答文件包含Schedule定义NoProPerty名/属性描述必填(Y/N)长度注释1Schedule2日ementTypeat“Schedule”Y3IDat接口中的唯一标识Y324Actionat操作类型发布一REGIST更新UPDATE删除一DELETEY5Codeat全局唯一标识Y326ChannelCodeP逻辑频道CodeY327ChannelIDP逻辑频道ID328ProgramNamepn

20、节目名称1289StartDatePn节目开播日期(丫丫丫丫乂乂口口)Y810StartTimePn节目开播时间(HH24MISS)Y611DurationPn节目时长(HH24MISS)Y612StorageDurationPnTVOD保存时长(小时)缺省为空该时间段的TVOD保存时长，如果该字段为空或小于Channel.StorageDuration，贝U应以Channel.StorageDuration为准。13StatusPn状态标志0:失效1:生效Y114DescriptionPn描述信息102415GenrePn节目的分类标签，如“体育”，多个标签用空格或“;”区分12816Res

21、ultPn0:成功其他：错误代码1应答文件包含17ErrorDescriptionPn错误描述1024应答文件包含说明：对于REGIST/UPDATE操作的Schedule,如果和原有Schedule有时间重叠，接受方应自动删除原有的Schedule以自动覆盖。2.3.10Picture定义NoProperty名/属性描述必填(Y/N)长度注释1Picture2ElementTypeat“Picture”Y3IDat接口中的唯一标识Y324Actionat操作类型发布一REGIST更新UPDATE删除一DELETEY5Codeat全局唯一标识Y325FileURLP图片文件URL10246DescriptionP描述10247ResultP0:成功其他：错误代码1应答文件包含8ErrorDescriptionP错误描述1024应答文件包含2.3.11Category定义NoProperty名/属性描述必填(Y/N)长度注释1Category2ElementTypeatt“Category”Y3IDatt