同州if-10ipg與ipg之間的接口

1、IPG與IPG之間的IF-10接口擬制:日期：yyyy-mm-dd審核:日期：yyyy-mm-dd批準:日期：yyyy-mm-dd文件名稱密級IPG與IPG之間的IF-10接口文件版本共 15 頁修訂日期修訂版本修改描述作者2012-2-6V1.011、IF-10-01：欄目審核同步接口增加了字段 AttributionID、GOODS_CODE、ProviderCode2012-03-26V1.021、 IF-10-01:欄目審核同步接口 請求參數(shù)增加了 OffLineN ist 字 段 ， 糾 正 DelN ist參數(shù)說明為“要刪除的欄目列表”,Node字樣修改為Column；2、 增加接

2、口IF-10-03：影片 同步接口；IF-10-04：影片關(guān)聯(lián)同步接口3、 IF-10-02：影片審核同步接口刪除請求字段MEND2012-05-14V1.031、增加IF-10-05：影片排序點播次數(shù)同步接口2012-05-24V1.04修改了IF-10-05：影片排序點播次數(shù)同步接口名稱修改為欄目影片排序點播次數(shù)同步接口；增加字段OperateType、OperateValue和 ColumnID2012-07-26V1.051、 增加模板元數(shù)據(jù)同步接口；2、 增加模板元數(shù)據(jù)刪除接口；2012-08-30V1.0.71、 欄目審核同步接口增加海報信息2、 增加IF-10-08：欄目模板關(guān)聯(lián)

3、關(guān)系同步接口2012-11-01V 1.081、IF-10-02:影片審核同步接口增加了 ColumnMa、GoodsID、ResourceR字段2、IF-10-03：影片同步接口增加了mendID字段3、IF-10-04：影片關(guān)聯(lián)同步接口增加了 RelationID字段目錄IPG 與 IPG 之間的 IF-10 接口1概述5數(shù)據(jù)類型5請求消息5消息格式5參數(shù)定義6舉例71.1.3.響應(yīng)消息7消息格式7參數(shù)定義8舉例8默認響應(yīng)消息9消息格式9舉例9參考資料10術(shù)語與縮寫10文檔約束11語法標記11典型業(yè)務(wù)流程.6.7.8.接口. 11接口定義128.1.運營商資料接口（Reg

4、OperatorInfo）錯誤！未定義書簽。簡介錯誤！未定義書簽。接口方向錯誤！未定義書簽。通信協(xié)議錯誤！未定義書簽。接口定義錯誤！未定義書簽。CP 同步接口（SynCPInfo）錯誤！未定義書簽。簡介錯誤！未定義書簽。接口方向錯誤！未定義書簽。通信協(xié)議錯誤！未定義書簽。接口定義錯誤！未定義書簽。SP 同步接口（SynSPInfo）128.3.1.簡介12接口方向12通信協(xié)議12接口定義12關(guān)系同步接口（SynAut hRelation）錯誤！未定義書簽。.8.4.簡介錯誤！未定義書簽。接口方向錯誤！未定義書簽。通信協(xié)議錯誤！未定義書簽。接口定義錯誤！未定義書簽。. 278.4.

5、..4.4.9.參考資料錯誤碼描述表2710.1.IF-4 接口的錯誤碼描述2710.1. 概述1.1. 數(shù)據(jù)類型本接口文檔中使用到的數(shù)據(jù)類型包括：1.字符2.數(shù)字3.時間時間類型用如下類型的字符串標識：格式：YYYY-MM-DD HH:MM:SS其中：YYYY 年MM 月DD 日HH 小時MM 分鐘SS 秒對于接口中字符類型字段的取值，若為枚舉值的話，需要嚴格遵照大小寫約定。1.2. 請求消息1.2.1. 消息格式?xml verTranVerionIDTranionIDVerTimestOpCodeMsgType對于包含單條數(shù)據(jù)的消息，body節(jié)點中包含對象名節(jié)

6、點，對象名節(jié)點中列舉各個字段名，如：43432對于包含多條數(shù)據(jù)的消息，body節(jié)點中包含列表節(jié)點，列表節(jié)點中包含多個對象節(jié)點，如節(jié)點名為List的情況：4343243431后文中的接口定義若未定義消息格式，則默認為包含單條數(shù)據(jù)的消息。1.2.2. 參數(shù)定義參數(shù)名必選/可選參數(shù)類型最大長度參數(shù)說明TranionID必選字符20消息流水號，接口雙方以 TranionID唯一標識一條消息。Ver必選字符5消息的版本號Timest必須時間20消息發(fā)送的時間戳OpCode必須字符20操作碼系統(tǒng)名+”_”+接口名MsgType必須字符10消息類型 REQ：消息請求 RESP：消息響應(yīng)1.2.3. 舉例?x

7、ml verTranVerionIDD000333981.02007-04-25 02:08:35AAA_Query_UserREQU000339391.3. 響應(yīng)消息1.3.1. 消息格式?xml verTranionIDTranionIDTimestOpCodeMsgTypeReturnCodeErrorMessage對于包含單條數(shù)據(jù)的消息，body節(jié)點中包含對象名節(jié)點，對象名節(jié)點中列舉各個字段名，如：43432對于包含多條數(shù)據(jù)的消息，body節(jié)點中包含列表節(jié)點，列表節(jié)點中包含多個對象節(jié)點，如節(jié)點名為List的情況：4343243431后文中的接口定義若未定義消息格式，則默認為包含單條數(shù)據(jù)

8、的消息1.3.2. 參數(shù)定義1.3.3. 舉例?xml verTranionIDD000333982007-04-25 02:08:35AAA_Query_UserRESP參數(shù)名必選/可選參數(shù)類型最大長度參數(shù)說明TranionID必選字符20消息流水號，接口雙方以 TranionID唯一標識一條消息Timest必選時間20消息發(fā)送的時間戳OpCode必須字符20操作碼系統(tǒng)名+”_”+接口名MsgType必須字符10消息類型 REQ：消息請求 RESP：消息響應(yīng)ReturnCode必選數(shù)字8返回碼，具體定義請參見附錄：錯誤碼描述表ErrorMessage可選字符1000發(fā)生錯誤時的錯誤描述000

9、0CHARGE_2009082112_00000001.txt; CHARGE_2009082112_0000000002.txt1.4. 默認響應(yīng)消息1.4.1. 消息格式當(dāng)響應(yīng)消息不需要做擴展時的默認響應(yīng)格式如下：?xml verTranionIDTranionIDTimestOpCodeMsgTypeReturnCodeErrorMessage1.4.2. 舉例?xml verTranionIDD000333982007-04-25 02:08:35AAA_Query_UserRESP00002. 參考資料3. 術(shù)語與縮寫如此定義如下術(shù)語：縮略語全稱說明DHMDTV Headend Mi

10、ddleware數(shù)字電視前端中間件iEPGeractive Electronic Program Guide互動電子指南AAAAuthentication, Authorization, Accounting鑒權(quán)、計費合稱 AAABMSBusiness Management System業(yè)務(wù)管理系統(tǒng)CMSContent Management System內(nèi)容管理系統(tǒng)VSServer服務(wù)器SBusiness and Operationpport System業(yè)務(wù)運營支撐系統(tǒng)OCGObject Carousel Generator對象輪播產(chǎn)生器NMSNetwork Management Syste

11、m系統(tǒng)VODOn Demand點播RTSPReal Time Streaming Protocol實時流協(xié)議CITVeractiveevi交互(數(shù)字)電視TSTransport Stream傳輸流，MPEG2 系統(tǒng)流的一種STBSet-Tox機頂盒HTTPHypertext Transfrotocol超文本傳輸協(xié)議HTTPSHypertext Transfrotocol Secure安全超文本傳輸協(xié)議SOAPSimple Object Acs Protocol簡單對象協(xié)議WSDLWeb Service Description LanguageWeb 服務(wù)描述語言XMLExtensible Ma

12、rkup Language可擴展標記語言VSServer服務(wù)器4. 文檔約束5. 語法標記6. 典型業(yè)務(wù)流程7. 接口序號接口名稱發(fā)起方接收方說明1.IF-10-01：欄目提交審核同步接口（Syn CommitNode）iEPGM下級 iEPGMSP 提交欄目審核數(shù)據(jù)同步2.IF-10-02：欄目審核同步接口（SynChec kNode）iEPGM下級 iEPGMSP 審核欄目數(shù)據(jù)同步3.IF-10-03：影片提交審核同步接口（Syn CommitMovie）iEPGM下級 iEPGM中心 iEPGM 向各地市 iEPGM 同步欄目與影片的對應(yīng)關(guān)系4.IF-10-04：影片審核同步接口（Syn

13、Chec kMovie）iEPGM下級 iEPGM中心 iEPGM 向各地市 iEPGM 同步欄目與影片的對應(yīng)關(guān)系5.IF-10-05：欄目影片排序點播次數(shù)同步接口iEPGM下級 iEPGM同步點播次數(shù)及影片排序6.IF-10-06：模板元數(shù)據(jù)同步接口iEPGM下級 iEPGM同步模板元數(shù)據(jù)7.IF-10-07：模板元數(shù)據(jù)狀態(tài)上報接口iEPGM下級 iEPGM同步模板狀態(tài)8.IF-10-08：模板元數(shù)據(jù)刪除接口iEPGM下級 iEPGM刪除模板信息SAITIONSAITION甩信8. 接口定義IF-10-01：欄目審核同步接口（IEPGMSyncColumn）簡介提交審核同步：SP提交欄目審核

14、，把欄目數(shù)據(jù)同步到下級地市。審核通過同步：SP驗證欄目數(shù)據(jù)正確，審核通過，把欄目數(shù)據(jù)同步到下級地市。2者均使用同一接口，“審核通過同步”同步時需要驗證欄目狀態(tài)是否已經(jīng)為狀態(tài)。8.1.2. 接口方向發(fā)起方：iEPGM接收方：下級 iEPGM通信協(xié)議HTTP/XML接口定義操作碼：消息請求：對象節(jié)點名mitNode，節(jié)點字段定義如下備注：上述 4 組列表中，至少有 1 組不為空。對象節(jié)點名 ColumnInfo 節(jié)點字段定義如下：參數(shù)名稱必選/可選參數(shù)類型最大長度參數(shù)說明約束參數(shù)名稱必選/可選參數(shù)類型最大長度參數(shù)說明約束AddColumnList可選ColumnInfo要新上線的欄目列表Updat

15、eColumnList可選ColumnInfo要修改的欄目列表OffLineColumnList可選ColumnInfo要下線的欄目列表DelColumnList可選ColumnInfo要刪除的欄目列表操作碼名稱操作碼說明IEPGM_SYNC_COLUMN欄目提交審核同步9.IF-10-09：欄目模板關(guān)聯(lián)關(guān)系同步接口iEPGM下級 iEPGM模板關(guān)聯(lián)關(guān)系同步ColumnID必選數(shù)字13欄目 IDDelN ist 中的 NodeInfo 其它項可選，此項必選，SiteID可選數(shù)字13站點 IDType必選數(shù)字1欄目類型：1、商品；2、導(dǎo)航GoodsType可選數(shù)字1商品欄目類型：1、一次性；2：

16、周期性；3：免費ParentID必選數(shù)字13父欄目 IDName必選字符200欄目名稱Alias必選字符200欄目別名Describe可選字符1000欄目描述Display可選數(shù)字1是否展示：0、不展示；1、展示Abspath可選字符4000欄目絕對路徑R可選數(shù)字13欄目順序Updater可選數(shù)字13修改人UpdateTime可選Date修改時間日期格 式： yyyy-MM-dd HH:mm:ssResourceType必選數(shù)字13關(guān)聯(lián)影片類型：-1、不區(qū)分；0、分集；3、整部；5、 拆條默認：-1Sus必選數(shù)字2欄目狀態(tài)；0、正在編輯狀態(tài)，10、待測試審核狀態(tài)，20、已上線狀態(tài)默認：0Att

17、ributionID必選數(shù)字3歸屬地枚舉值：0：省中心地市中心需根據(jù)具體情況確定GoodsCode可選字符20商品編碼對象節(jié)點名(terRelation)節(jié)點字段定義如下：消息響應(yīng)：參考： 默認響應(yīng)消息IF-10-02：影片審核同步接口（iEPGMSyncColumnResMap）簡介提交審核同步：iEPGM向下級iEPGM同步欄目與影片的對應(yīng)關(guān)系。審核通過同步：iEPGM驗證欄目與影片數(shù)據(jù)正確，審核通過，把欄目與影片的對應(yīng)關(guān)系同步到下級地市。2者均使用同一接口，“審核通過同步”同步時需要驗證影片狀態(tài)是否已經(jīng)為狀態(tài)。8.2.2. 接口方向發(fā)起方：iEPGM接收方：下級 iEPGM通信協(xié)議HTT

18、P/XML接口定義操作碼：操作碼名稱操作碼說明IEPGM_SYNC_COLUMN_RES_MAP同步影片對應(yīng)關(guān)系參數(shù)名稱必選/可選參數(shù)類型最 大長度參數(shù)說明約束terID必選數(shù)字10海報 IDtriority可選數(shù)字2海報優(yōu)先級ProviderCode必選字符20提供商編碼terList消息請求：對象節(jié)點名mitMovie，節(jié)點字段定義如下備注：上述 3 組列表中，至少有 1 組不為空。對象節(jié)點名 ColumnResMapInfo 節(jié)點字段定義如下：參數(shù)名稱必選/可選參數(shù)類型最大長度參數(shù)說明約束ColumMa必選數(shù)字13上架 IDColumnID必選數(shù)字13欄目 IDProductOfferi

19、ngI D必選數(shù)字13產(chǎn)品 IDGoodsID可選數(shù)字13商品 IDResourceID必選數(shù)字13資源 IDResourceR必選數(shù)字13資源在欄目中的OptTime可選Date操作時間OnlineType可選數(shù)字2上架類型:0 人工上架 1 系統(tǒng)任務(wù)上架MEND必選數(shù)字13是否:0 不推 薦 1 ResourceType可選數(shù)字13關(guān)聯(lián)影片類型：-1、不區(qū)分；0、分集；3、整部； 5、 拆條Sus必選數(shù)字2欄目狀態(tài)；0、正在編輯狀態(tài)，10、待測試審核狀 態(tài)，20、已上線狀態(tài)默認：0參數(shù)名稱必選/ 可選參數(shù)類型最大長度參數(shù)說明約束AddColumnResMapList可選ColumnResM

20、apInfo要新增的影片對應(yīng)關(guān)系欄目列表DelColumnResMapList可選ColumnResMapInfo要刪除的影片對應(yīng)關(guān)系列表消息響應(yīng)：參考： 默認響應(yīng)消息8.3. IF-10-03：影片（同步接口mend）8.3.1. 簡介省級iEPGM影片需要同步到地市級影片中。8.3.2. 接口方向發(fā)起方：iEPGM接收方：下級 iEPGM通信協(xié)議HTTP/XML接口定義操作碼：消息請求：對象節(jié)點mendMovieMessage，節(jié)點字段定義如下備注：上述 2 組列表中，至少有 1 組不為空。對象節(jié)點名mendMovie 節(jié)點字段定義如下：參數(shù)名稱必選 / 可選參數(shù)類型最大長度參數(shù)說明約束C

21、olumnID必選數(shù)字13欄目 ID取消必選mendID必選數(shù)字13ID參數(shù)名稱必選/可選參數(shù)類型最大長度參數(shù)說明約束mendMovieList可選mendMovie要的影片列表mendMovieList可選mendMovie要取消的影片列表操作碼名稱操作碼說明MEND影片同步接口消息請求格式：TranTimestionID13112180607062011-12-16 11:14:20MENDREQVer1.0mendMovieList12312311110ResourceID必選數(shù)字13資源 IDColumnMa必選數(shù)字13上架 ID取消必選ProductOfferingID必選數(shù)字13產(chǎn)

22、品 IDGoodsID必選數(shù)字13商品 IDResourceType必選數(shù)字13資源規(guī)格類別0：影片文件；3：資源包；5：拆條mendType必選數(shù)字2類型0：表示手工推薦；1：表示系統(tǒng)OrderNum必選數(shù)字13排序順序系統(tǒng) 上架的排序順序小于 0，手工上架的排序順序大于 0mendDate必選日期時間123mendDate2001-01-01 12:21:23 mendMovieListmendMovieListmendMoviemendDate12341234111101232001-01-01 12:21:23mendMovieListmendDate消息響應(yīng)：參考： 默認響應(yīng)消息IF

23、-10-04：影片關(guān)聯(lián)同步接口（IEPGMMovieRelative）簡介省級iEPGM關(guān)聯(lián)影片需要同步到地市級關(guān)聯(lián)影片中。8.4.2. 接口方向發(fā)起方：iEPGM接收方：下級 iEPGM8.4.3. 通信協(xié)議HTTP/XML8.4.4. 接口定義操作碼：消息請求：操作碼名稱操作碼說明IEPGM_MOVIE_RELATIVE影片關(guān)聯(lián)同步接口對象節(jié)點名 SynMovieRelativeMessage 節(jié)點字段定義如下備注：上述 2 組列表中，至少有 1 組不為空。對象節(jié)點名 SynMovieRelative 節(jié)點字段定義如下：消息請求格式：13112180607062011-12-16 11:1

24、4:20IEPGM_MOVIE_RELATIVEREQVer1.0ColumnMa1221ColumnMa4121參數(shù)名稱必選 / 可選參數(shù)類型最大長度參數(shù)說明約束RelationID必選數(shù)字13關(guān)聯(lián) IDColumnMa1必選數(shù)字13資源1 對應(yīng)的上架IDColumnMa2必選數(shù)字13資源2 對應(yīng)的上架IDOrderNum可選數(shù)字13關(guān)聯(lián)排序順序參數(shù)名稱必選 / 可選參數(shù)類型最 大 長度參數(shù)說明約束AddRelativeMovieList可選RelativeMovie關(guān)聯(lián)的影片列表CancelRelativeMovieList可選RelativeMovie取消關(guān)聯(lián)的影片列表消息響應(yīng)：參考：

25、默認響應(yīng)消息8.5. IF-10-05：欄目影片排序點播次數(shù)同步接口（IEPGMR8.5.1. 簡介Mod）省級iEPGM需要將影片排序值和虛擬點播次數(shù)同步到地市級影片中。8.5.2. 接口方向發(fā)起方：iEPGM接收方：下級 iEPGM通信協(xié)議HTTP/XML接口定義操作碼：消息請求：對象節(jié)點名 RModbody 節(jié)點字段定義如下對象節(jié)點名 RModMsg 節(jié)點字段定義如下：參數(shù)名稱必 選 / 可選參數(shù)類型最 大 長度參數(shù)說明約束RModList可選RMod排序點播次數(shù)列表List 值不超過 200；需遵循先 進先出 原則。操作碼名稱操作碼說明IEPGM_SYNC_R_MOD影片排序點播次數(shù)同

26、步接口消息請求格式：Tran13112180607062011-12-16 11:14:20 IEPGM_SYNC_RREQ_MODVer1.012342234221參數(shù)名稱必選 / 可選參數(shù)類型最大長度參數(shù)說明約束ColumnMa必選數(shù)字13上架 IDColumnID可選數(shù)字13欄目 IDoperateType=0或 2 必選ResourceID可選數(shù)字13資源 IDOperateType=3必選OperateValue可選字符32操作值OperateType可選數(shù)字2操作類型枚舉值：0：1：影片上下移2：欄目上下移3：虛擬點播次數(shù)消息響應(yīng)：參考： 默認響應(yīng)消息IF-10-06：模板元數(shù)據(jù)同

27、步接口（SyncTemplate）簡介中心模板元數(shù)據(jù)同步到分中心模板元數(shù)據(jù)。8.6.2. 接口方向發(fā)起方：iEPGM接收方：下級 iEPGM8.6.3. 通信協(xié)議HTTP/XML8.6.4. 接口定義操作碼：消息請求：對象節(jié)點名 TemplateBody 節(jié)點字段定義如下參數(shù)名稱必選 / 可選參數(shù)類型最大長度參數(shù)說明約束TemplateCode必選字符300模板 Code對應(yīng)數(shù)據(jù)庫 nameTemplateName可選字符300模板名稱對應(yīng)數(shù)據(jù)庫 aliasTemplateType必選數(shù)字2模板類型IsDefault必選數(shù)字13是否為默認模板枚舉值：否是，默認為0；Remark可選字符2000

28、描述Type可選數(shù)字2高標清標志FilePath必選字符2000模板文件路徑FTP 格式,包含操作碼名稱操作碼說明IEPGM_SYNC_TEMPLATE模板元數(shù)據(jù)同步接口消息請求格式：Tran13112180607062011-12-16 11:14:20 IEPGM_SYNC_TEMPLATEREQVer1.0123422342211ftp:/消息響應(yīng)：參考： 默認響應(yīng)消息8.7. IF-10-07：模板元數(shù)據(jù)狀態(tài)上報接口（SyncTemplateS8.7.1. 簡介us）中心模板元數(shù)據(jù)同步到分中心模板元數(shù)據(jù)。8.7.2. 接口方向發(fā)起方：iEPGM接收方：下級 iEPGM8.7.3. 通信

29、協(xié)議HTTP/XML用戶名、8.7.4. 接口定義操作碼：消息請求：對象節(jié)點名 TemplateSusBody 節(jié)點字段定義如下消息請求格式：Tran13112180607062011-12-16 11:14:20 IEPGM_SYNC_TEMPLATE_SREQUS1.0/Ver123421ftp:/參數(shù)名稱必選 / 可選參數(shù)類型最大長度參數(shù)說明約束TemplateCode必選字符300模板 Code對應(yīng)數(shù)據(jù)庫 nameTemplateName可選字符300模板名稱對應(yīng)數(shù)據(jù)庫 aliasTemplateSus必選數(shù)字2模板文件獲取狀態(tài)枚舉：不可用；可用；注入中；已刪除FilePath必選字符2000模板文件路徑FTP 格式,包含用戶名、操作碼名稱操作碼說明IEPGM_SYNC_TEMPLATE_SUS模板元數(shù)據(jù)狀態(tài)上報接口消息響應(yīng)：參考：