智慧城市公共信息平臺 附件七：接口與服務要求

1、CJ/T XXXXXXX附件七智慧城市公共信息平臺平臺接口與服務要求（試 行）中華人民共和國住房和城鄉(xiāng)建設部建筑節(jié)能與科技司二一三年三月3目 次1 范圍12 規(guī)范性引用文件23 術語與定義34 接口服務概述54.1 接口服務組成54.2 接口技術要求65 總體要求75.1 消息結構75.1.1 請求報文范例75.1.2 響應報文范例75.2 接口方式75.3 接口地址85.4 使用說明86 業(yè)務接口要求106.1 基礎接口要求106.1.1 目錄服務初始化106.1.2 目錄服務終止116.1.3 認證授權126.2 發(fā)現(xiàn)接口要求136.2.1 資源目錄檢索136.2.2 資源目錄檢索結果提取

2、156.3 資源服務接口要求176.3.1 資源內容檢索176.3.2 資源內容檢索結果提取186.4 管理接口要求206.4.1 目錄資源元數(shù)據(jù)管理20附錄A 要求所涉及的結構表23表A.1 databaseList組成23表A.2 服務功能列表23表A.3 elementSetName結果集屬性24表A.4 opResult屬性表24表A.5 singleRecord參數(shù)表24表A.6 元數(shù)據(jù)管理類型定義24表A.7 核心元數(shù)據(jù)屬性集25表A.8 關系運算符屬性集27表A.9 位置運算符屬性集27表A.10 資源自描述Result屬性集27附錄B QUERY-RES-DATA說明30B.1

3、 dataQuery資源檢索申請結構31B.1.1 結構化資源檢索申請結構31B.1.2 非結構化資源申請結構32B.2 資源檢索結果提取結構33B.2.1 結構化資源singleRecord范例33B.2.1 非結構化資源singleRecord范例34附錄C 平臺接口要求SCHEMA36附錄D QUERY-RPN范例65D.1 示例一65D.2 示例二65附錄E 資源目錄范例68E.1 資源目錄要求SCHEMA68E.2 結構化資源目錄模板89E.3 非結構化資源目錄模板98智慧城市公共信息平臺-平臺接口與服務要求1 范圍l 本要求是智慧城市公共信息平臺建設指南建設要求系列之接口與服務要求

4、。l 本部分要求分兩大部分描述平臺接口要求，第一部分：總體要求，總體要求描述消息的總體結構、接口訪問方、接口地址、使用說明。第二部分：業(yè)務接口要求，具體描述每個業(yè)務應用服務接口的要求。也就是每一個業(yè)務接口要求套在總體要求內。只有使用業(yè)務接口要求+總體要求才能正常使用信息平臺的應用服務來發(fā)現(xiàn)，查詢，管理資源。l 本部分適用于參與公共信息平臺設計和研發(fā)人員，系統(tǒng)維護人員及要求接入公共信息平臺的外部應用的開發(fā)人員。2 規(guī)范性引用文件下列文件中的條款通過本部分的引用而成為本部分的條款。凡是注日期的引用文件，其隨后所有的修改單（不包括勘誤的內容）或修訂版均不適用于本部分，鼓勵根據(jù)本部分達成協(xié)議的各方研究

5、是否可使用這些文件的最新版本。凡是不注日期的引用文件，其最新版本適用于本部分。GB/T 21063.1-2007 政務信息資源目錄體系 第1部分：總體框架；GB/T 21063.2-2007 政務信息資源目錄體系 第2部分：技術要求；GB/T 21063.3-2007 政務信息資源目錄體系 第3部分：核心元數(shù)據(jù)；GB/T 21063.4-2007 政務信息資源目錄體系 第4部分： 政務信息資源分類；GB/T 21063.5-2007 政務信息資源目錄體系 第5部分：政務信息資源標識符編碼方案；Ø 本文<業(yè)務接口要求> 引用GB/T 21063.2-2007中的附錄A 目錄

6、服務接口；Ø 本文<附錄A 要求所涉及的結構表>引用GB/T 21063.2-2007中的附錄A 目錄服務接口，及引用GB/T 21063.2-2007中的附錄C 政務信息資源目錄服務屬性集Ø 本文<附錄D QUERY-RPN范例>引用 GB/T 21063.2-2007中的附錄F 檢索串示例9.3 術語與定義GB/T 19710-2005中規(guī)定的與以下術語和定義適用于本部分。l 目錄針對擁有共性的數(shù)據(jù)資源/文件資源進行分類，并且為該分類賦予唯一的資源標識符，該部分分類及分類描述的集合統(tǒng)稱為資源目錄，簡稱目錄。l 結構化資源公共信息平臺共享的二維庫表

7、結構數(shù)據(jù)，統(tǒng)稱為結構化資源。l 非結構化資源公共信息平臺共享的非二維庫表結構數(shù)據(jù)，例如：文本文件、視頻、網(wǎng)絡訪問資源等統(tǒng)稱為非結構化資源。l 數(shù)據(jù)交換管理者管理信息資源結點的機構。l 交換內容提供者提供信息資源交換內容的機構。l 交換內容使用者使用信息資源交換內容的機構。l 前置環(huán)境應用單位接入端系統(tǒng)軟硬件及相關網(wǎng)絡環(huán)境組成的應用單位前置系統(tǒng)的單元環(huán)境。l 目錄交換按訂閱模式進行目錄資源數(shù)據(jù)的交換；l 橋接系統(tǒng)業(yè)務數(shù)據(jù)庫與共享數(shù)據(jù)庫的橋接器，保持交換數(shù)據(jù)庫與共享數(shù)據(jù)庫的同步；l 變更捕捉捕捉數(shù)據(jù)資源變更情況。l 數(shù)據(jù)轉入以固定間隔時間輪詢變更登記表，讀取其中的記錄，并將這些記錄以約定的格式組成

8、XML報文，存儲到共享庫的換出表中；非結構化數(shù)據(jù)文件直接通過文件服務傳輸至交換中心文件服務器，并有中心分發(fā)非結構化數(shù)據(jù)文件。l 數(shù)據(jù)交換路由以固定時間間隔輪詢應用單位換入表，拆解XML報文，根據(jù)目標庫自動分揀； 非結構化數(shù)據(jù)文件直接通過文件服務傳輸至交換中心文件服務器，并有中心分發(fā)非結構化數(shù)據(jù)文件。l 數(shù)據(jù)轉出獨立運行的進程，以固定間隔時間輪詢交換庫中的換入表，讀取其中的XML報文，并將數(shù)據(jù)按定制的格式同步到共享庫中。非結構化數(shù)據(jù)文件描述信息存儲在信息隊列中，由各服務器根據(jù)隊列信息分別從中心文件服務器獲取所需數(shù)據(jù)文件。l 交換管理程序完成數(shù)據(jù)交換審批流程、交換監(jiān)控、交換調度、系統(tǒng)管理等功能一套

9、程序，部署于中心。l Web服務基于webservice技術開放的服務接口，采用約定的XML作為交易數(shù)據(jù)接口，提供給客戶端調用。l WSDLWeb服務描述文件，一個用來描述Web服務和說明如何與Web服務通信的XML語言。為用戶提供詳細的接口說明。l 訪問認證公共信息平臺提供用戶認證服務，由托管應用系統(tǒng)的客戶端調用，用于驗證用戶是否合法；l 應用單位接入公共信息平臺的機構單位。l 主管單位公共信息平臺的管理單位。l 數(shù)據(jù)中心公共信息平臺的組成部分，是公共信息平臺數(shù)據(jù)及應用系統(tǒng)數(shù)據(jù)存儲的地方。4 接口服務概述4.1 接口服務組成信息資源目錄服務包含三種接口，即信息資源基礎服務接口、資源服務接口(

10、發(fā)現(xiàn)接口、資源接口)、信息資源管理服務接口。其中，基礎接口是將資源服務接口和管理接口中基礎性的操作定義成一個公共接口。這3類接口實現(xiàn)了信息資源的發(fā)現(xiàn)功能、檢索功能和管理功能?；A接口：提供會話管理功能和服務自描述功能，包含有目錄服務初始化接口、目錄服務終止接口和服務自描述接口。發(fā)現(xiàn)接口：提供信息資源元數(shù)據(jù)檢索功能和信息資源元數(shù)據(jù)檢索結果提取功能，包含有目錄檢索接口以及目錄檢索結果提取接口。這些接口本身并不提供資源，而是提供資源基本信息和如何去獲得這些資源的元數(shù)據(jù)。資源接口：根據(jù)發(fā)現(xiàn)接口獲得信息資源元數(shù)據(jù)，定位、查找資源具體內容的接口，包含資源內容檢索接口及資源內容結果提取接口。管理接口：提供元

11、數(shù)據(jù)管理的功能，包含信息資源元數(shù)據(jù)管理接口。城市公共信息平臺接口服務組成見圖1.圖1. 城市公共信息平臺接口服務組成圖4.2 接口技術要求a) 提供基于SOAP協(xié)議的web服務接口b) 支持跨語言、跨操作系統(tǒng)調用5 總體要求5.1 消息結構每個交易消息(包括請求和應答)有一個是名字（Message Name），交易消息以XML格式表達的，根據(jù)XML的定義，每個XML文件需要有特定的Root Tag（根標記），在本要求中，用交易名稱+請求類別作為根節(jié)點，如初始化接口的請求包根節(jié)點為initRequest，而響應包的根節(jié)點為initResponse。根節(jié)點下之間放業(yè)務接口數(shù)據(jù)。5.1.1 請求報文

12、范例<initRequest><protocolVersion/><idAuthentication/><implementationId/><implementationName/><otherInfo/></initRequest>5.1.2 響應報文范例<initResponse><referenceId></referenceId><protocolVersion></protocolVersion><pubKey></pub

13、Key><result></result><otherInfo></otherInfo></initResponse>5.2 接口方式接口采用WebService方式，接口協(xié)議使用SOAP協(xié)議，提供標準的WSDL文件。5.3 接口地址公共信息目錄服務（以下簡稱目錄服務）主要有三個wsdl地址，不同的wsdl下有不同的方法，下文有說明。這是根據(jù)webservice的soap協(xié)議開放出來的wsdl地址，第三方應用可以根據(jù)實際的部署的服務器地址來使用它。1) 基礎接口WSDL文件地址：http:/<ip地址>:<端口

14、>/es/catalogbase?wsdll 目錄服務初始化 initCatalogServicel 目錄服務終止 stopCatalogService2) 發(fā)現(xiàn)接口WSDL文件地址：http:/<ip地址>:<端口>/es/digcatalog?wsdll 目錄檢索 queryCatalogListl 目錄檢索結果提取 queryCatalogResult3) 資源服務接口：http:/<ip地址>:<端口>/es/digresource?wsdll 資源檢索 getResourceResultsetl 資源檢索結果提取 getResou

15、rceResultDetail4) 發(fā)現(xiàn)接口WSDL文件地址：http:/<ip地址>:<端口>/es/digcatalog?wsdll 資源元數(shù)據(jù)管理 metadataManage5.4 使用說明完成資源的檢索與發(fā)現(xiàn)需要根據(jù)以下步驟來操作完成：1) 第一步：初始化操作。調用基礎接口的“目錄服務初始化”獲得一個會 話標識符以后每次調用接口都需要次標識符。2) 第二步：查詢公共信息目錄操作。調用發(fā)現(xiàn)接口的“目錄檢索”組織好查詢參數(shù)，發(fā)起交易，獲得查詢結果。注：這里的查詢結果只有返回命中的查詢記錄數(shù)。比如：返回值是100，那么表示有100條記錄符合查詢條件，這個時候需要發(fā)起

16、“公共信息目錄檢索結果提取”交易才能提取查詢的結果。如果發(fā)回值是0，表示沒有符合查詢條件的記錄。3) 第三步：查詢公共信息目錄對應的資源。這里的操作也是和上面一樣，調用“資源檢索”先要查詢下是否有符合查詢條件的資源。有資源記錄的話，然后在調用“資源檢索結果提取”提取符合條件的資源信息。4) 第四步：假如調用接口結束后，可調用基礎接口里的“目錄服務終止”來釋放會話標識符資源信息。6 業(yè)務接口要求6.1 基礎接口要求6.1.1 目錄服務初始化公共信息目錄服務初始化用于建立客戶端與服務端的會話，所有其他服務都必須依賴會話。會話的持續(xù)時間為30分鐘，若會話持續(xù)30分鐘沒有活動，則會話自動終止。本次初始

17、化作用是客戶端認證同時獲取會話標識符，后續(xù)發(fā)起交易時需要傳遞該會話標識符。1. 請求報文體序號元素名稱約束類型長度描述取值說明1.protocolVersion可選String50客戶端協(xié)議版本號客戶端協(xié)議實現(xiàn)的版本號2.idAuthentication必選String50用戶名/密碼認證信息。包含用戶身份標識及其密碼。格式“<用戶名>/<密碼>”3.implementationId可選String50應用標識在公共信息平臺用戶體系中注冊的第三方應用編號4.implementationName可選String200應用名稱在公共信息平臺用戶管系統(tǒng)中注冊的第三方應用名稱5

18、.otherInfo可選element其他信息備用2. 請求報文體模板<initRequest><protocolVersion>V1.0</protocolVersion><idAuthentication>testApp/12456</ idAuthentication><implementationId>1</ implementationId ><implementationName>測試應用</implementationName><otherInfo/></

19、initRequest>3. 響應報文體序號元素名稱約束類型長度描述取值說明1.referenceId必選String50會話標識當驗證成功時返回，否則設置為空2.protocolVersion必選String50服務端協(xié)議版本號服務端協(xié)議實現(xiàn)的版本號3.result必選Boolean處理結果服務器端用該參數(shù)表明是否接受建立會話的請求。true表示建立會話成功，false表示建立會話失敗，此時referenceId為空。4.pubKey必選String64加解密公鑰5.otherInfo可選element其他信息備用4. 響應報文體模板<initResponse><re

20、ferenceId>cde2db52-8cee-45f4-9cec-f8a68ebbad5c</referenceId><protocolVersion>V1.0</protocolVersion><pubKey>catalog</pubKey><result>true</result><otherInfo>初始化服務成功</otherInfo></initResponse>6.1.2 目錄服務終止公共信息目錄服務終止將結束服務端與客戶端的會話，與會話相關的資源將被釋放

21、。1. 請求報文體序號元素名稱約束類型長度描述取值說明1.referenceId必選String50會話標識要終止的會話編號2.closeReason可選String50終止原因3.otherInfo可選element其他信息備用2. 求報文體模板<initRequest><referenceId>cde2db52-8cee-45f4-9cec-f8a68ebbad5c</referenceId>< closeReason >終止使用</ closeReason ><otherInfo/></initRequest&

22、gt;6.1.3 認證授權認證授權主要是公鑰獲取接口服務，用于根據(jù)客戶端應用的請求，取出最新的加解密公鑰并返回給客戶端的過程。公鑰獲取與其他接口不同，不需要用戶驗證，不需要會話標識。調用客戶端只有獲取公鑰后對用戶認證信息進行加密才能完成其服務調用。整個密碼加解密的處理過程如下圖所示：圖2. .密碼加解密的處理過程圖1. 請求報文體序號元素名稱約束類型長度描述取值說明1.otherInfo可選element其他信息備用2. 請求報文體模板<pubKeyRequest><otherInfo></otherInfo></ pubKeyRequest >

23、3. 響應報文體序號元素名稱約束類型長度描述取值說明1.pubKey必選String8公鑰用于加解密密碼的密鑰2.opResult必選element操作結果參見表A.6 opResult屬性表之說明3.otherInfo可選element其他信息備用4. 響應報文體模板<pubKeyResponse>< pubkey>catalog</ pubkey><opResult>< opStatus>true</ opStatus >< opRetCode >code</ opRetCode >< o

24、pRetMsg >message</ opRetMsg ></ opResult><otherInfo></otherInfo></ pubKeyResponse >6.2 發(fā)現(xiàn)接口要求6.2.1 資源目錄檢索公共信息目錄檢索是服務端根據(jù)客戶端指定的檢索條件，在服務器端從元數(shù)據(jù)庫中檢索并標識出匹配的元數(shù)據(jù)記錄，并將元數(shù)據(jù)記錄保存在結果集中的過程。結果集的保存時間與會話標識一致，當會話結束后，響應的結果集將被同步刪除。1. 請求報文體序號元素名稱約束類型長度描述取值說明1.referenceId必選String50會話標識2.re

25、placeIndicator必選Boolean結果集覆蓋標志true表示覆蓋原來的查詢結果，false表示保留原來的查詢結果3.resultSetID必選String200指定的查詢結果集名稱若存在同名的結果集，需要根據(jù)replaceIndicator判斷是否需要覆蓋結果集。4.databaseNames必選Element要查詢的元數(shù)據(jù)庫名稱列表客戶端指定的要查詢的元數(shù)據(jù)庫名稱列表5.query必選Element客戶端定制的檢索語句檢索語句必須符合Type-1型，使用逆波蘭表達式(RPN)作為檢索語法，參見附錄E QUERY-RPN范例6.preferredRecordSyntax可選Stri

26、ng10檢索結果的編碼方式固定取值:”XML”7.otherInfo可選Element其他信息備用2. 請求報文體模板<searchRequest><referenceId>f4973365-a9be-4f80-b5d8-a8b9c7949185</referenceId><replaceIndicator>true</replaceIndicator><resultSetID>highResult</resultSetID><databaseNames>BMDB</databaseNames

27、><preferredRecordSyntax>XML</preferredRecordSyntax><query>根據(jù)國標的逆波蘭表達式(RPN)組合的查詢條件具體規(guī)則參考附錄E QUERY-RPN范例</query></searchRequest>3. 響應報文體序號元素名稱約束類型長度描述取值說明1.referenceId必選String50會話標識2.resultCount必選NumberString20符合條件的記錄數(shù)服務器端執(zhí)行檢索操作得到的命中記錄數(shù)，檢索失敗設置為03.searchStatus必選String7執(zhí)

28、行檢索的執(zhí)行結果返回的檢索狀態(tài)信息，success表示檢索成功，failture表示檢索失敗4.otherInfo可選element其他信息備用4. 響應報文體模板<searchResponse><referenceId>3720b175-7db7-408d-90cd-108e1f2ec887</referenceId><resultCount>9</resultCount><searchStatus>success</searchStatus><otherInfo></otherInfo&g

29、t;</searchResponse>6.2.2 資源目錄檢索結果提取目錄檢索結果由服務器端從結果集中提取并返回若干數(shù)據(jù)記錄給客戶端。1. 請求報文體序號元素名稱約束類型長度描述取值說明1.referenceId必選String50會話標識2.resultSetID必選String要抽取的結果集的標識因為系統(tǒng)允許在抽取數(shù)據(jù)前進行多次檢索，每次檢索都可以指定不同的結果集名稱，所以客戶端必須指定要抽取的數(shù)據(jù)結果集標識3.resultSetStartPoint必選NumberString20開始抽取的位置客戶端指定的從第幾條記錄開始抽取，序號從1開始4.numberOfRecordsRe

30、squested必選NumberString20記錄數(shù)客戶端指定的要抽取的記錄數(shù)5.elementSetName必選element結果集屬性參見表表 A.3elementSetName結果集屬性6.preferredRecordSyntax可選String10提取結果的編碼方式固定取值:”XML”7.otherInfo可選element其他信息備用2. 請求報文體模板<presentRequest><referenceId>f4973365-a9be-4f80-b5d8-a8b9c7949185</referenceId><resultSetID>

31、;highResult</resultSetID><resultSetStartPoint>0</resultSetStartPoint><numberOfRecordsResquested>30</numberOfRecordsResquested><elementSetName><genericElementSetName>brief</genericElementSetName></elementSetName><preferredRecordSyntax>XML<

32、;/preferredRecordSyntax></presentRequest>3. 響應報文體序號元素名稱約束類型長度描述取值說明1.referenceId必選String50會話標識2.numberOfRecordsReturned必選NumberString20元數(shù)據(jù)數(shù)目服務器端返回的元數(shù)據(jù)數(shù)目3.presentStatus必選String7提取狀態(tài)服務器端返回的提取狀態(tài)。success表示提取成功，failture表示提取失敗4.records必選element結果集服務器返回的結果集,包含一個或多個singleRecord，詳細描述參見表A.5 singleRec

33、ord參數(shù)表5.otherInfo可選element其他信息備用4. 響應報文體模板<presentResponse><referenceId>f4973365-a9be-4f80-b5d8-a8b9c7949185</referenceId><numberOfRecordsReturned>9</numberOfRecordsReturned><presentStatus>success</presentStatus><records>結構化資源目錄/非結構化資源目錄</records>

34、;<otherInfo></otherInfo></presentResponse>6.3 資源服務接口要求6.3.1 資源內容檢索 資源檢索是公共信息平臺服務端根據(jù)客戶端發(fā)送的請求信息，從共享數(shù)據(jù)庫中讀取符合條件的記錄，并將查詢結果集相關返回的過程。注意，資源檢索功能并不返回具體的結果集，結果集返回功能將由”資源檢索結果提取”服務提供。結果集的保存時間與會話標識一致，當會話結束后，響應的結果集將被同步刪除。1. 請求報文體序號元素名稱約束類型長度描述取值說明1.referenceId必選String50會話標識2.resId必選String50資源標識符6

35、位字母/數(shù)字加”/”加1到23位數(shù)字3.replaceIndicator必選Boolean結果集覆蓋標志true表示覆蓋原來的查詢結果，false表示保留原來的查詢結果4.resultSetID必選String200指定的查詢結果集名稱若存在同名的結果集，需要根據(jù)replaceIndicator判斷是否需要覆蓋結果集。5.dataQuery必選element客戶端定制的檢索條件參見附錄C QUERY-RES-DATA說明 dataQuery屬性說明6.preferredRecordSyntax可選String10檢索結果的編碼方式固定取值:”XML”7.otherInfo可選element其他

36、信息備用2. 請求報文體模板<dataSearchRequest><referenceId>d8137d81-ef76-4dc5-80c7-01dc493f9d3f</referenceId><resId>GXWgxwAA000</resId><resultSetID>GXWgxwAA000</resultSetID><replaceIndicator>true</replaceIndicator><preferredRecordSyntax>XML</preferre

37、dRecordSyntax><dataQuery>取值參考dataQuery屬性說明</dataQuery></dataSearchRequest>3. 響應報文體序號元素名稱約束類型長度描述取值說明1.referenceId必選String50會話標識2.resultCount必選NumberString20符合條件的記錄數(shù)服務器端執(zhí)行檢索操作得到的命中記錄數(shù)，檢索失敗設置為03.searchStatus必選String7執(zhí)行檢索的執(zhí)行結果返回的檢索狀態(tài)信息，success表示檢索成功，failture表示檢索失敗4.opResult可選elemen

38、t操作信息詳情參見附錄表A.4-opResult屬性表5.otherInfo可選element其他信息備用4. 響應報文體模板<dataSearchResponse><referenceId>d8137d81-ef76-4dc5-80c7-01dc493f9d3f</referenceId><resultCount>0</resultCount><searchStatus>failure</searchStatus><opResult><opStatus>failure</opSt

39、atus><opRetCode>錯誤代碼</opRetCode><opRetMsg>錯誤信息</opRetMsg></opResult><otherInfo></otherInfo></dataSearchResponse>6.3.2 資源內容檢索結果提取資源檢索結果提取用于從<資源檢索>所得的結果集中提取指定的結果。1. 請求報文體序號元素名稱約束類型長度描述取值說明1.referenceId必選String50會話標識2.resultSetID必選String要抽取的結果集的標

40、識因為系統(tǒng)允許在抽取數(shù)據(jù)前進行多次檢索，每次檢索都可以指定不同的結果集名稱，所以客戶端必須指定要抽取的數(shù)據(jù)結果集標識3.resultSetStartPoint必選NumberString20開始抽取的位置客戶端指定的從第幾條記錄開始抽取，序號從1開始4.numberOfRecordsResquested必選NumberString20記錄數(shù)客戶端指定的要抽取的記錄數(shù)5.numberOfRecordsTotal必選NumberString20符合條件的總共命中記錄數(shù)資源檢索接口查詢得到的總共命中記錄數(shù)。6.preferredRecordSyntax可選String10提取結果的編碼方式固定取值:

41、”XML”7.otherInfo可選element其他信息備用2. 請求報文體模板<dataPresentRequest><referenceId>2190bf83-a934-4f4d-995c-f688dc4808ae</referenceId><resultSetID>JTJQD/JTJ00000</resultSetID><resultSetStartPoint>1</resultSetStartPoint><numberOfRecordsResquested>30</numberOfR

42、ecordsResquested><numberOfRecordsTotal>3</numberOfRecordsTotal><preferredRecordSyntax>XML</preferredRecordSyntax></dataPresentRequest>3. 響應報文體序號元素名稱約束類型長度描述取值說明1.referenceId必選String50會話標識2.numberOfRecordsReturned必選NumberString20元數(shù)據(jù)數(shù)目服務器端返回的元數(shù)據(jù)數(shù)目3.presentStatus必選Strin

43、g7提取狀態(tài)服務器端返回的提取狀態(tài)。success表示提取成功，failture表示提取失敗4.resType必選String50資源種類結構化資源或非結構化資源，不同的資源種類對應的singleRecord中Item項不同5.records必選element結果集服務器返回的結果集,包含一個或多個singleRecord，詳細描述參見B.2資源檢索結果提取結構6.otherInfo可選element其他信息備用4. 響應報文體模板<dataPresentResponse><referenceId>687d0aed-6e43-44eb-9d0e-e25eeca83470

44、</referenceId><numberOfRecordsReturned>3</numberOfRecordsReturned><presentStatus>s</presentStatus><resType>結構化資源</resType><records><singleRecord>.</singleRecord>(具體結構參照)</records><otherInfo></otherInfo></dataPresentResp

45、onse>6.4 管理接口要求6.4.1 目錄資源元數(shù)據(jù)管理目錄資源元數(shù)據(jù)管理接口包含元數(shù)據(jù)的新增、刪除和更新操作，根據(jù)不同的操作類型來完成相應的動作，且元數(shù)據(jù)管理接口一次只操作一種操作類型的一條元數(shù)據(jù)記錄。當操作類型為更新時其操作對象為通過“目錄檢索結果提取”接口返回的元數(shù)據(jù)，元數(shù)據(jù)元素必須符合核心元數(shù)據(jù)屬性集要求；當操作類型為刪除時，其操作對象為通過“目錄檢索結果提取”接口返回的元數(shù)據(jù)中的特定一條記錄；當操作類型為創(chuàng)建時，請求方必須按附錄B約定的編目要求提供完整的元數(shù)據(jù)信息。1. 請求報文序號元素名稱約束類型長度描述取值說明1referenceId必選String50會話標識2typ

46、e必選Int用于指定進行元數(shù)據(jù)的各種管理操作，詳細內容見表A.6 元數(shù)據(jù)管理類型定義3recordId可選String待刪除或待更新的元數(shù)據(jù)標識符(即資源標識符)。該標識符用于在元數(shù)據(jù)庫中指定唯一的元數(shù)據(jù)?？梢酝ㄟ^目錄檢索結果提取接口獲取其響應消息。當type為1時，進行元數(shù)據(jù)插入操作，本參數(shù)不出現(xiàn)；當type為2或3時，進行元數(shù)據(jù)刪除或更新操作，本參數(shù)為必選參數(shù)4Data可選XML待創(chuàng)建或更新的元數(shù)據(jù)內容，當type為1或3時，進行元數(shù)據(jù)插入或更新操作，本參數(shù)為必選參數(shù)；當type為2時，進行元數(shù)據(jù)刪除操作，本參數(shù)不出現(xiàn)更新操作時，Data格式定義為:<records><i

47、tem><itemName></itemName><itemValue></itemValue></item></records>,Records節(jié)點包含一組或多組元數(shù)據(jù)屬性參數(shù)itemName和元數(shù)據(jù)屬性值參數(shù)itemValue。itemName取值要求符合表 核心元數(shù)據(jù)屬性集之約定5otherInfo可選String其他信息備用2. 返回報文序號元素名稱約束類型長度描述取值說明1.referenceId必選String50會話標識2.operationState必選String7執(zhí)行結果Success表示執(zhí)行元數(shù)

48、據(jù)管理操作成功；Failture表示執(zhí)行元數(shù)據(jù)管理操作失敗3.operationType可選Int操作類型用來表示服務器端執(zhí)行的元數(shù)據(jù)管理操作類型，必須符合表 元數(shù)據(jù)管理類型定義之約定4.otherInfo可選element其他信息當執(zhí)行成功時本元素不出現(xiàn)，當執(zhí)行失敗時，格式定為：<errCode></errCode><errMsg></errMsg>，errcode表示錯誤碼，errMsg表示錯誤信息附錄A 要求所涉及的結構表表A.1 databaseList組成參數(shù)名稱約束參數(shù)含義databaseId必選標識一個元數(shù)據(jù)庫，以公共信息平臺的應用

49、單位編號代替databaseName必選元數(shù)據(jù)庫名稱databaseDescribe必選元數(shù)據(jù)庫的基本描述信息表A.2 服務功能列表功能標識交易編碼(transid)國標要求是否支持含義initinitRequest是是用于建立客戶端與服務端的會話closecloseRequest是是終止客戶端與服務端的會話capbilitiescatalogCapabilitiesRequest是是提供服務本身的各種描述信息searchsearchRequest是是檢索目錄信息并形成結果集presentpresentRequest是是目錄檢索結果提取,從結果集中提取結果metadataManager否否對公

50、共信息平臺進行遠程管理resSelfDescresSelfDescRequest否是資源自描述dataSearchdataSearchRequest否是檢索資源dataPresentdataPresentRequest否是從檢索出的資源結果集中抽取數(shù)據(jù)pubKeypubKeyRequest否是用于從服務端獲取公鑰表A.3 elementSetName結果集屬性參數(shù)名稱參數(shù)類型取值參數(shù)含義genericElement-SetNameStringBrief提取信息資源核心元數(shù)據(jù)genericElement-SetNameStringFull或空提取全部的信息資源元數(shù)據(jù)elementSetList&

51、lt;String>元數(shù)據(jù)屬性字段標識符列表必須符合表 核心元數(shù)據(jù)屬性集的編碼要求表A.4 opResult屬性表屬性名類型長度約束參數(shù)含義opStatusString8必選執(zhí)行結果，”success”表示成功,”failture”表示失敗opRetCodeString8可選執(zhí)行結果，”00000000”表示成功,其他表示錯誤代碼opRetMsgString200可選錯誤的說明表A.5 singleRecord參數(shù)表參數(shù)名稱參數(shù)類型約束參數(shù)含義itemelement必選結果集中的元數(shù)據(jù)記錄，包含一組或多組元數(shù)據(jù)屬性參數(shù)itemName和元數(shù)據(jù)屬性值參數(shù)itemValue。提取的結果集是核

52、心元數(shù)據(jù)時，參數(shù)itemName取值要求符合表 核心元數(shù)據(jù)屬性集databaseIdString可選提取全部的信息資源元數(shù)據(jù)recordIdString可選必須符合表的編碼要求(即資源標識符)表A.6 元數(shù)據(jù)管理類型定義名稱取值含義創(chuàng)建元數(shù)據(jù)1用于表示該次請求是進行創(chuàng)建元數(shù)據(jù)操作刪除元數(shù)據(jù)2用于表示該次請求是進行刪除元數(shù)據(jù)操作更新元數(shù)據(jù)3用于表示該次請求是進行更新元數(shù)據(jù)操作表A.7 核心元數(shù)據(jù)屬性集核心元數(shù)據(jù)屬性集的編碼規(guī)則如下：第一層代碼只有一位阿拉伯數(shù)字。其取值為“1”，表示核心元數(shù)據(jù)。第二層是核心元數(shù)據(jù)元素和元數(shù)據(jù)實體，采用三位阿拉伯數(shù)字。該編碼結構分為二層：第一層采用一位阿拉伯數(shù)字，核

53、心元數(shù)據(jù)取值為1；第二層代碼采用三位阿拉伯數(shù)字，利用遞增順序碼的方法進行編碼。例如，“資源名稱”的編碼為“1.001”，“資源出版日期”的編碼為“1.002”。第三層是元數(shù)據(jù)實體所包含的元數(shù)據(jù)元素，采用五位阿拉伯數(shù)字。該編碼結構分為三層：第一層采用一位阿拉伯數(shù)字，核心元數(shù)據(jù)取值為1；第二層代碼采用三位阿拉伯數(shù)字，利用遞增順序碼的方法進行編碼，為該元數(shù)據(jù)元素所屬元數(shù)據(jù)實體的編碼；第三層代碼采用兩位阿拉伯數(shù)字，利用遞增順序碼的方法進行編碼。例如，“資源負責單位”的編碼為“1.004.01”。如圖A.1所示：圖A.1 核心元數(shù)據(jù)屬性集的編碼規(guī)則示意圖下面是相應的核心元數(shù)據(jù)屬性集：編碼中文名稱短名1.

54、000資源核心元數(shù)據(jù)全文resMetadata1.001資源名稱resTitle1.002資源出版日期pubCate1.003資源摘要abstract1.004資源負責方IdPoC1.004.01資源負責單位rpOrgName1.004.02資源負責方地址cntAdd1.004.03資源負責方電子郵件地址eMailAdd1.005資源格式信息FmInfo1.005.01資源格式名稱fmName1.005.02資源格式版本fmVer1.006關鍵字說明DescKeys1.006.01關鍵字keyword1.006.02詞典名稱thesaName1.007空間范圍spatCom1.008時間范圍TimePeriod1.008.01起始時間begCate1.008.02結束時間endCate1.009資源安全限制分級class1.010資源語種language1.011資源字符集dataChar1.012資源分類TpCat1.012.01類目名稱cateName1.012.02類目編碼cateCode1.012.03分類標準cateStd1.013數(shù)據(jù)志說明statement1.014在線資源鏈接地址onLineSrc1.015資源標識符resID1.016服務信息ServInfo1. 016.01服務地址servURL1. 016.02服務類型servTy