C2數(shù)據(jù)標(biāo)準(zhǔn)接口規(guī)范

1、目錄TOC o 1-5 h z概述1接口介紹2流程描述2SOAP消息定義2XML文件規(guī)范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數(shù)據(jù)轉(zhuǎn)換24歷史數(shù)據(jù)25 概述我方的數(shù)據(jù)分析系統(tǒng)由于無法主動獲取基礎(chǔ)數(shù)據(jù)，例如點(diǎn)播欄目信息、直播節(jié)目單等。因此，造成了數(shù)據(jù)分析

3、系統(tǒng)無基礎(chǔ)數(shù)據(jù)可用，影響了分析結(jié)果的展現(xiàn)。為了解決此問題，我方數(shù)據(jù)分析系統(tǒng)按照C2接口規(guī)范封裝數(shù)據(jù)獲取接口，模擬LSP采用SOAP協(xié)議+XML指令文件的方式獲取基礎(chǔ)數(shù)據(jù)信息。2接口介紹2.1流程描述數(shù)據(jù)獲取接口采用SOAP協(xié)議+XML指令文檔的方式。其中，SOAP消息是與具體指令內(nèi)容無關(guān)的通用消息，僅僅用于表達(dá)命令請求。而具體的命令及參數(shù)利用獨(dú)立的XML文檔來描述。采用與具體指令無關(guān)的通用SOAP消息有利于指令擴(kuò)展及在異步環(huán)境中實(shí)現(xiàn)通用的可靠消息傳遞機(jī)制。CSP以SOAP協(xié)議+XML指令文檔的方式主動向LSP發(fā)送基礎(chǔ)數(shù)據(jù)信息，LSP根據(jù)SOAP消息中的文件URL獲取XML并解析執(zhí)行。CSPSO

4、AP:ExecCmdReq-LSP二SOAP:ExecCmdRes下層獲取XML指令文件.發(fā)起工作流或一直接執(zhí)行指令執(zhí)行過程可能包括下載圖片媒體文件產(chǎn)SOAP:ResultNotifyReqSOAP:ResultNotifyRes2.2SOAP消息定義執(zhí)行指令請求：ExecCmdReq消息方向：CSPbLSP名稱說明數(shù)據(jù)類型是否必選CSPID互相約定的上層標(biāo)識String(32)MLSPID互相約定的下層標(biāo)識String(32)MCorrelatelD相關(guān)性標(biāo)識，用于關(guān)聯(lián)指令執(zhí)行請求消息和結(jié)果通知消息。對于重發(fā)的指令，該字段值保持一致，對于不同的指令，該字段在同層內(nèi)具有唯一性。String(3

5、2)MCmdFileURLXML指令文件的URLURLM執(zhí)行指令響應(yīng)：ExecCmdRes消息方向：CSPGLSP名稱說明數(shù)據(jù)類型是否必選Result接收消息結(jié)果：0：成功-1：失敗IntMErrorDescription錯誤信息詳細(xì)描述StringO結(jié)果通知請求：ResultNotifyReq消息方向：CSPGLSP名稱說明數(shù)據(jù)類型是否必選CSPID互相約定的上層標(biāo)識String(32)MLSPID互相約定的下層標(biāo)識String(32)MCorrelateID相關(guān)性標(biāo)識，用于關(guān)聯(lián)指令執(zhí)行請求消息和結(jié)果通知消息。String(32)MCmdResult命令執(zhí)行結(jié)果：0：成功-1：通常失敗其他結(jié)

6、果待定義IntMResultFileURL查詢結(jié)果XML文件的URL，該字段僅針對查詢結(jié)果通知消息出現(xiàn)。URLO結(jié)果通知響應(yīng)：ResultNotifyRes消息方向：CSP3LSP名稱說明數(shù)據(jù)類型是否必選Result接收消息結(jié)果：0：成功-1：失敗IntMErrorDescription錯誤信息詳細(xì)描述StringO2.3XML文件規(guī)范概述ADI/Objects/Mappings是接口XML的通用基礎(chǔ)框架，基于該通用框架定義不同的Object.ElementType和不同的Property.Name來滿足對不同對象的定義需求。請注意本規(guī)范的描述中應(yīng)用以下規(guī)則：Object.ElementTyp

7、e與Object.ID聯(lián)合起來在接口中唯一定位一個(gè)對象實(shí)例，它們是一個(gè)接口中針對對象進(jìn)行任何操作的唯一索引。當(dāng)對象之間有父子關(guān)系或多對多關(guān)系的時(shí)候，Object.ID也被用做關(guān)聯(lián)引用標(biāo)識。部分對象的Property屬性中定義了Code屬性，表示跨系統(tǒng)的全局唯一標(biāo)識，LSP應(yīng)保留備用。對于任何符合Schema(見附件)的XML文件，LSP應(yīng)該忽略那些不能識別的Property或XMLTag或?qū)傩浴?4)以下對象中標(biāo)識為”必填項(xiàng)”的屬性，僅僅是針對REGIST操作。而UPDATE操作進(jìn)行的是增量修改，缺少某必填項(xiàng)，僅為表示不需要對此項(xiàng)進(jìn)行修改，而不能修改此項(xiàng)為空。DELETE操作只出現(xiàn)Elemen

8、tType、ID、Code屬性，其他屬性不需要。(5)接收方若收到某對象的REGIST操作，若系統(tǒng)中該對象已經(jīng)存在，則應(yīng)當(dāng)作UPDATE操作處理。該需求包括Mapping對象。(6)接收方若收至UProgram、Movie、Series、Category、Package、Channel、Schedule對象的DELETE操作，應(yīng)自動刪除該對象關(guān)聯(lián)的Picture、Movie、及該對象與其他對象的Mapping關(guān)系。XML文件內(nèi)容的編碼全部采用UTF-8格式。以下章節(jié)描述了XML的詳細(xì)定義。在其中att表示XML屬性，el表示XML元素，pn表示Property節(jié)點(diǎn)的Name)。ADI定義ADI

9、是XML的根元素。NoTag名/屬性描述必填(Y/N)長度注釋1ADI根元素2Objectsel操作對象3Mappingsel映射對象4Replyel應(yīng)答對象應(yīng)答文件包含Objects定義Objects是操作對象。操作類型REGIST表示增加新對象，UPDATE表示修改對象內(nèi)容，DELETE表示刪除對象。Objects.ElementType定義：序號ElementType取值說明是否必要基本內(nèi)容管理1Program節(jié)目信息必要2Movie媒體內(nèi)容信息必要3HTMLContent圖文內(nèi)容信息必要4ChannelTV頻道信息必要5PhysicalChannel頻道物理參數(shù)信息必要6Schedul

10、eTV時(shí)刻表信息必要7Picture圖片信息非必要8Category編排目錄信息必要9Series連續(xù)劇必要業(yè)務(wù)套餐管理9Package包信息必要Program定義NoProperty名/屬性描述必填(Y/N)長度注釋1Program2日ementTypeat“Program”Y3IDat接口中的唯一標(biāo)識Y324Actionat操作類型注冊一REGIST更新UPDATE刪除一DELETEY5Codeat全局唯一標(biāo)識Y326Namep節(jié)目名稱Y1287OrderNumberp節(jié)目訂購編號108OriginalNamep原名1289SortNamep索引發(fā)布時(shí)間供界面排序12810SearchNa

11、mep搜索名稱供界面搜索12811ActorDisplayp演員列表（只供顯示）25612WriterDisplayp作者列表（只供顯示）25613OriginalCountrp國家地區(qū)64yn14Languagep語言6415ReleaseYearp上映年份416OrgAirDatep首播時(shí)間2017LicensingWindowStartp有效開始時(shí)間(YYYYMMDDHH24MiSS)Y1418LicensingWindowEndp有效結(jié)束時(shí)間(YYYYMMDDHH24MiSS)Y1419DisplayAsNewp新到天數(shù)320DisplayAsLastChancep剩余天數(shù)321Mac

12、rovisionp拷貝保護(hù)標(biāo)志0:無拷貝保護(hù)1:有拷貝保護(hù)122Descriptionp節(jié)目描述400023PriceTaxInp列表定價(jià)12,224Statusp狀態(tài)標(biāo)志0:失效1:生效125SourceTypep1:視頻類節(jié)目2:圖文類節(jié)目126SeriesFlagp0:影片1:單集127Kpeoplep150n28Directorp導(dǎo)演5029Scriptwriterp編劇5030Comperep節(jié)目主持人5031Guestp受訪者5032Reporterp記者5033OPInchargep其他責(zé)任人5034Resultp0:成功其他：錯誤代碼1應(yīng)答文件包含35ErrorDescript

13、ionp錯誤描述1024應(yīng)答文件包含Movie定義NoProperty名/屬性描述必填(Y/N)長度注釋1Movie2at“Movie”Y3IDat接口中的唯一標(biāo)識Y324Actionat操作類型發(fā)布一REGIST更新UPDATEY刪除一DELETE5Codeat全局唯一標(biāo)識Y326TypeP媒體類型1:正片2:預(yù)覽片Y17FileURLP媒體文件URLftP：/username：PasswordiP：Port/.標(biāo)準(zhǔn)FTP協(xié)議Y10248SourceDRMTypeP0:NoDRM1:BESDRM19DestDRMTypP0:NoDRM1:BESDRM110AudioTypeP0：其他Mona

14、ural單聲道Stereo多聲道Two-nationmonaural雙單聲道Two-nationstereo雙多聲道AC3(5:1channel)AC3聲道211ScreenFormatP0:4x31:16x9(Wide)112ClosedCaptioningP字幕標(biāo)志0:無字幕1:有字幕113ResultP0:成功其他：錯誤代碼1應(yīng)答文件包含14ErrorDescriptionP錯誤描述1024應(yīng)答文件包含HTMLContent定義NoProperty名/屬性描述必填(Y/N)長度注釋1HTMLContent2日ementTypeatt“HTMLContent”Y3IDatt接口中的唯一標(biāo)識

15、Y324Actionatt操作類型發(fā)布一REGIST更新UPDATE刪除一DELETEY5Codeatt全局唯一標(biāo)識Y326FileURLpn圖文節(jié)目的HTMLTAR包文件URLftp:/username:passwordip:port/.標(biāo)準(zhǔn)FTP協(xié)議Y1024下平臺從此URL獲取圖文節(jié)目包7ResultPn0:成功其他：錯誤代碼1應(yīng)答文件包含8ErrorDescriptionPn錯誤描述1024應(yīng)答文件包含Channel定義NoProperty名/屬性描述必填(Y/N)長度注釋1Channel2日ementTypeatt“Channel”Y3IDatt接口中的唯一標(biāo)識Y4Actionatt

16、操作類型Y發(fā)布一REGISI更新UPDATE刪除一DELETE5Codeatt全局唯一標(biāo)識Y326ChannelNumberpn建議頻道號37Namepn頻道名稱Y648CallSignpn臺標(biāo)名稱109TimeShiftpn時(shí)移標(biāo)志0:不生效1:生效110StorageDurationpn存儲時(shí)長，單位小時(shí)9該頻道的錄制節(jié)目保存時(shí)長，可用于時(shí)移和回看。11TimeShiftDuration默認(rèn)時(shí)移時(shí)長，單位分鐘(Reserved)僅僅對Timeshift有效12Descriptionpn描述信息102413Countrypn國家1013Statepn州/省1014Citypn城市1015Zi

17、pCodepn郵編1016Typepn頻道類型1：直播頻道Y117SubTypepn當(dāng)Type為1(直播頻道)1：信號源來自live2:信號源來自virtual119Languagepn語言12819Statuspn狀態(tài)標(biāo)志0:失效1:生效Y120StartTimepn播放開始時(shí)間(HH24MI)421EndTimepn播放結(jié)束時(shí)間(HH24MI)422Macrovisionpn拷貝保護(hù)標(biāo)志0:無拷貝保護(hù)1:有拷貝保護(hù)123VideoTypepn視頻參數(shù)（參考4.1）1024AudioTypepn音頻參數(shù)（參考4.1）1025StreamTypepn碼流標(biāo)志（參考4.1）126Bilingua

18、lpn雙語標(biāo)志（0/1）127Resultpn0：成功其他：錯誤代碼1應(yīng)答文件包含28ErrorDescriptionpn錯誤描述1024應(yīng)答文件包含PhysicalChannel定義NoProperty名/屬性描述必填(Y/N)長度注釋1PhysicalChannel2ElementTypeat“PhysicalChannel”Y3IDat唯一IDY324Actionat操作類型發(fā)布一REGIST更新UPDATE刪除一DELETEY5Codeat全局唯一標(biāo)識Y326ChannelCodep頻道CodeY327ChannelIDp頻道IDN328BitRateTypeP碼流2:2M4:4M19

19、MultiCastIPP組播IPY6410MultiCastPortP組播端口Y511ResultP0：成功其他：錯誤代碼1應(yīng)答文件包含12ErrorDescriptionP錯誤描述1024應(yīng)答文件包含Schedule定義NoProPerty名/屬性描述必填(Y/N)長度注釋1Schedule2日ementTypeat“Schedule”Y3IDat接口中的唯一標(biāo)識Y324Actionat操作類型發(fā)布一REGIST更新UPDATE刪除一DELETEY5Codeat全局唯一標(biāo)識Y326ChannelCodeP邏輯頻道CodeY327ChannelIDP邏輯頻道ID328ProgramNamepn

20、節(jié)目名稱1289StartDatePn節(jié)目開播日期(丫丫丫丫乂乂口口)Y810StartTimePn節(jié)目開播時(shí)間(HH24MISS)Y611DurationPn節(jié)目時(shí)長(HH24MISS)Y612StorageDurationPnTVOD保存時(shí)長(小時(shí))缺省為空該時(shí)間段的TVOD保存時(shí)長，如果該字段為空或小于Channel.StorageDuration，貝U應(yīng)以Channel.StorageDuration為準(zhǔn)。13StatusPn狀態(tài)標(biāo)志0:失效1:生效Y114DescriptionPn描述信息102415GenrePn節(jié)目的分類標(biāo)簽，如“體育”，多個(gè)標(biāo)簽用空格或“;”區(qū)分12816Res

21、ultPn0:成功其他：錯誤代碼1應(yīng)答文件包含17ErrorDescriptionPn錯誤描述1024應(yīng)答文件包含說明：對于REGIST/UPDATE操作的Schedule,如果和原有Schedule有時(shí)間重疊，接受方應(yīng)自動刪除原有的Schedule以自動覆蓋。2.3.10Picture定義NoProperty名/屬性描述必填(Y/N)長度注釋1Picture2ElementTypeat“Picture”Y3IDat接口中的唯一標(biāo)識Y324Actionat操作類型發(fā)布一REGIST更新UPDATE刪除一DELETEY5Codeat全局唯一標(biāo)識Y325FileURLP圖片文件URL10246DescriptionP描述10247ResultP0:成功其他：錯誤代碼1應(yīng)答文件包含8ErrorDescriptionP錯誤描述1024應(yīng)答文件包含2.3.11Category定義NoProperty名/屬性描述必填(Y/N)長度注釋1Category2ElementTypeatt“Category”Y3IDatt