智慧城市公共信息平臺(tái)-附件七：接口與服務(wù)要求

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

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

3、7附錄 B QUERYRESDATA說明 308.1 dataQuery 資源檢索申請(qǐng)結(jié)構(gòu) 318.1.1 結(jié)構(gòu)化資源檢索申請(qǐng)結(jié)構(gòu) 318.1.2 非結(jié)構(gòu)化資源申請(qǐng)結(jié)構(gòu) 328.2 資源檢索結(jié)果提取結(jié)構(gòu) 338.2.1 結(jié)構(gòu)化資源singleRecord 范例 338.2.2 非結(jié)構(gòu)化資源singleRecord 范例 34附錄 C 平臺(tái)接口要求SCHEMA 36附錄D QUERYRPN范例 65D.1 示例一 65D.2 示例二 65附錄 E 資源目錄范例 68E.1 資源目錄要求SCHEMA 68E.2 結(jié)構(gòu)化資源目錄模板 89E.3 非結(jié)構(gòu)化資源目錄模板 981 范圍本要求是智慧城市公共

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

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

6、A 目錄服務(wù)接口；? 本文附錄A 要求所涉及的結(jié)構(gòu)表引用GB/T 21063.2-2007 中的附錄 A 目錄服務(wù)接口，及引用GB/T21063.2-2007 中的附錄C 政務(wù)信息資源目錄服務(wù)屬性集本文 附錄D QUERY-RPN例弓|用 GB/T 21063.2-2007中的附錄F檢索串示例9.3 術(shù)語(yǔ)與定義GB/T 19710-2005 中規(guī)定的與以下術(shù)語(yǔ)和定義適用于本部分。目錄針對(duì)擁有共性的數(shù)據(jù)資源/ 文件資源進(jìn)行分類，并且為該分類賦予唯一的資源標(biāo)識(shí)符，該部分分類及分類描述的集合統(tǒng)稱為資源目錄，簡(jiǎn)稱目錄。結(jié)構(gòu)化資源公共信息平臺(tái)共享的二維庫(kù)表結(jié)構(gòu)數(shù)據(jù)，統(tǒng)稱為結(jié)構(gòu)化資源。非結(jié)構(gòu)化資源公共信息

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

8、件服務(wù)器，并有中心 分發(fā)非結(jié)構(gòu)化數(shù)據(jù)文件。數(shù)據(jù)交換路由以固定時(shí)間問隔輪詢應(yīng)用單位換入表，拆解XML艮文，根據(jù)目標(biāo)庫(kù)自動(dòng)分揀；非結(jié)構(gòu)化數(shù)據(jù)文件直接通過文件服務(wù)傳輸至交換中心文件服務(wù)器，并有中心分發(fā)非結(jié)構(gòu)化數(shù)據(jù)文件。數(shù)據(jù)轉(zhuǎn)出獨(dú)立運(yùn)行的進(jìn)程，以固定間隔時(shí)間輪詢交換庫(kù)中的換入表，讀取其中的XML報(bào)文，并將數(shù)據(jù)按定制的格式同步到共享庫(kù)中。非結(jié)構(gòu)化數(shù)據(jù)文件描述信息存儲(chǔ)在信息隊(duì)列中，由各服務(wù)器根據(jù)隊(duì)列信息分別從中心文件服務(wù)器獲取所需數(shù)據(jù)文件。交換管理程序完成數(shù)據(jù)交換審批流程、交換監(jiān)控、交換調(diào)度、系統(tǒng)管理等功能一套程序，部署于中心。WebK 務(wù)基于webservice技術(shù)開放的服務(wù)接口，采用約定的XML乍為交

9、易數(shù)據(jù)接口，提供給客戶端調(diào)用。WSDLWeb!務(wù)描述文件，一個(gè)用來描述 Web!務(wù)和說明如何與 Web!務(wù)通信的XML 語(yǔ)言。為用戶提供詳細(xì)的接口說明。訪問認(rèn)證公共信息平臺(tái)提供用戶認(rèn)證服務(wù)，由托管應(yīng)用系統(tǒng)的客戶端調(diào)用，用于驗(yàn)證用戶是否合法；應(yīng)用單位接入公共信息平臺(tái)的機(jī)構(gòu)單位。主管單位公共信息平臺(tái)的管理單位。數(shù)據(jù)中心公共信息平臺(tái)的組成部分，是公共信息平臺(tái)數(shù)據(jù)及應(yīng)用系統(tǒng)數(shù)據(jù)存儲(chǔ)的地方。4接口服務(wù)概述4.1 接口服務(wù)組成信息資源目錄服務(wù)包含三種接口，即信息資源基礎(chǔ)服務(wù)接口、資源服務(wù)接口 （發(fā)現(xiàn)接口、資源接口）、信息資源管理服務(wù)接口。其中，基礎(chǔ)接口是將資源服務(wù) 接口和管理接口中基礎(chǔ)性的操作定義成一個(gè)公

10、共接口。這3類接口實(shí)現(xiàn)了信息資源的發(fā)現(xiàn)功能、檢索功能和管理功能。基礎(chǔ)接口 ：提供會(huì)話管理功能和服務(wù)自描述功能， 包含有目錄服務(wù)初始化接 口、目錄服務(wù)終止接口和服務(wù)自描述接口。發(fā)現(xiàn)接口 ：提供信息資源元數(shù)據(jù)檢索功能和信息資源元數(shù)據(jù)檢索結(jié)果提取功能，包含有目錄檢索接口以及目錄檢索結(jié)果提取接口。這些接口本身并不提供資源，而是提供資源基本信息和如何去獲得這些資源的元數(shù)據(jù)。資源接口：根據(jù)發(fā)現(xiàn)接口獲得信息資源元數(shù)據(jù)， 定位、查找資源具體內(nèi)容的 接口，包含資源內(nèi)容檢索接口及資源內(nèi)容結(jié)果提取接口。管理接口：提供元數(shù)據(jù)管理的功能，包含信息資源元數(shù)據(jù)管理接口。城市公共信息平臺(tái)接口服務(wù)組成見圖1.圖1.城市公共信息

11、平臺(tái)接口服務(wù)組成圖4.2 接口技術(shù)要求a)提供基于SOAFW議的web服務(wù)接口b) 支持跨語(yǔ)言、跨操作系統(tǒng)調(diào)用5總體要求5.1 消息結(jié)構(gòu)每個(gè)交易消息（包括請(qǐng)求和應(yīng)答）有一個(gè)是名字（Message Name,交易消息 以XMLB式表達(dá)的，根據(jù)XML勺定義，每個(gè)XML±件需要有特定的Root Tag （根 標(biāo)記），在本要求中，用交易名稱+請(qǐng)求類別作為根節(jié)點(diǎn)，如初始化接口的請(qǐng)求包 根節(jié)點(diǎn)為initRequest ,而響應(yīng)包的根節(jié)點(diǎn)為initResponse 。根節(jié)點(diǎn)下之間放業(yè) 務(wù)接口數(shù)據(jù)。5.1.1 請(qǐng)求報(bào)文范例<initRequest><protocolVersion/

12、><idAuthentication /><implementationId /><implementationName/><otherInfo/></initRequest>5.1.2 響應(yīng)報(bào)文范例<initResponse><referenceId></referenceId><protocolVersion></protocolVersion><pubKey></pubKey><result></result><

13、;otherInfo ></otherInfo ></initResponse>5.2 接口方式接口采用WebService方式，接口協(xié)議使用 SOAFW議，提供標(biāo)準(zhǔn)的 WSDLC 件。5.3 接口地址公共信息目錄服務(wù)(以下簡(jiǎn)稱目錄服務(wù))主要有三個(gè)wsdl 地址， 不同的 wsdl下有不同的方法，下文有說明。這是根據(jù)webservice 的 soap 協(xié)議開放出來的wsdl 地址，第三方應(yīng)用可以根據(jù)實(shí)際的部署的服務(wù)器地址來使用它。1) 基 礎(chǔ) 接 口 WSDL 文 件 地 址 ： http:/<ip 地 址 >:< 端口 >/es/cata

14、logbase?wsdl目錄服務(wù)初始化 -initCatalogService目錄服務(wù)終止 -stopCatalogService2) 發(fā) 現(xiàn) 接 口 WSDL 文 件 地 址 ： http:/<ip 地 址 >:< 端 口 >/es/digcatalog?wsdl目錄檢索-queryCatalogList目錄檢索結(jié)果提取-queryCatalogResult3) 資源服務(wù)接口：http:/<ip 地址 >:< 端口 >/es/digresource?wsdl資源檢索-getResourceResultset 資源檢索結(jié)果提取-getResour

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

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

17、鐘沒有活動(dòng)，則會(huì) 話自動(dòng)終止。本次初始化作用是客戶端認(rèn)證同時(shí)獲取會(huì)話標(biāo)識(shí)符，后續(xù)發(fā)起交易時(shí)需要傳遞該會(huì)話標(biāo)識(shí)符。1 .請(qǐng)求報(bào)文體序號(hào)元素名稱約束長(zhǎng)度描述取值說明1.protocolVersion可選String50客戶端協(xié)議 版本號(hào)客戶端協(xié)議實(shí)現(xiàn)的 版本號(hào)2.idAuthentication必選String50用戶名/密 碼認(rèn)證信息。包含用戶 身份標(biāo)識(shí)及其密碼。格式“用戶名/密 碼”3.implementationId可選String50應(yīng)用標(biāo)識(shí)在公共信息平臺(tái)用 戶體系中注冊(cè)的第 三方應(yīng)用編號(hào)4.implementationName可選String200應(yīng)用名稱在公共信息平臺(tái)用 戶管系統(tǒng)中注冊(cè)

18、的 第二方應(yīng)用名稱5.otherInfo可選element其他信息備用2 .請(qǐng)求報(bào)文體模板<initRequest><protocolVersion>V1.0</protocolVersion><idAuthentication>testApp/12456</ idAuthentication><implementationId>1</ implementation ><implementationName>U試應(yīng)用 </implementationName><otherInfo/

19、></initRequest>3 .響應(yīng)報(bào)文體序號(hào)元素名稱約束長(zhǎng)度描述取值說明1.referenceld必選String50會(huì)話標(biāo)識(shí)當(dāng)驗(yàn)證成功時(shí)返回，否 則設(shè)置為空2.protocolversion必選String50服務(wù)端協(xié)議 版本號(hào)服務(wù)端協(xié)議實(shí)現(xiàn)的版本 號(hào)3.result必選Boolean處理結(jié)果服務(wù)器端用該參數(shù)表明 是否接受建立會(huì)話的請(qǐng) 求。true表小建立會(huì)話 成功，false表小建立會(huì) 話失敗，此時(shí)referenceId 為空。4.pubKey必選String64加解密公鑰5.otherInfo可選element其他信息備用4 .響應(yīng)報(bào)文體模板<initRes

20、ponse><referenceId>cde2db52-8cee-45f4-9cec-f8a68ebbad5</referenceId><protocolVersion>V1.0</protocolVersion><pubKey>catalog</pubKey><result>true </result><otherInfo>初始化服務(wù)成功 </otherInfo></initResponse>5 .1.2目錄服務(wù)終止公共信息目錄服務(wù)終止將結(jié)束服務(wù)端與客戶端

21、的會(huì)話，與會(huì)話相關(guān)的資源將被釋放。1 .請(qǐng)求報(bào)文體序號(hào)元素名稱約束長(zhǎng)度描述取值說明1.referenceId必選String50會(huì)話標(biāo)識(shí)要終止的會(huì)話編號(hào)2.closeReason可選String50終止原因3.otherInfo可選element其他信息備用2 .求報(bào)文體模板<initRequest><referenceId>cde2db52-8cee-45f4-9cec-f8a68ebbad5</referenceId>< closeReason 終止使用 </ closeReason > <otherInfo/></i

22、nitRequest>6.1.3認(rèn)證授權(quán)認(rèn)證授權(quán)主要是公鑰獲取接口服務(wù)，用于根據(jù)客戶端應(yīng)用的請(qǐng)求，取出最 新的加解密公鑰并返回給客戶端的過程。公鑰獲取與其他接口不同，不需要用戶驗(yàn)證，不需要會(huì)話標(biāo)識(shí)。調(diào)用客戶 端只有獲取公鑰后對(duì)用戶認(rèn)證信息進(jìn)行加密才能完成其服務(wù)調(diào)用。整個(gè)密碼加解密的處理過程如下圖所示：圖2.密碼加解密的處理過程圖1 .請(qǐng)求報(bào)文體序 號(hào)元素名稱約束長(zhǎng)度描述取值說明1.otherInfo可選element其他信 息備用2 .請(qǐng)求報(bào)文體模板<pubKeyRequest><otherInfo></otherInfo></ pubKeyRe

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

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

25、0會(huì)話標(biāo)識(shí)2.replaceIndicato r必選Boolean結(jié)果集覆蓋 標(biāo)志true表不覆蓋原來的查 詢結(jié)果，false表小保留 原來的查詢結(jié)果3.resultSetID必選String200指定的查詢 結(jié)果集名稱若存在同名的結(jié)果集，需要根據(jù)replaceIndicator 判斷是否需要覆蓋結(jié)果集。4.databaseName s必選Element要查詢的元 數(shù)據(jù)庫(kù)名稱 列表客戶端指定的要查詢的 元數(shù)據(jù)庫(kù)名稱列表5.query必選Element客戶端定制 的檢索語(yǔ)句檢索語(yǔ)句必須符合Type-1型，使用逆波蘭 表達(dá)式（RPN）乍為檢索語(yǔ) 法，參見附錄E QUERYRPN范例6.prefer

26、redRecor dSyntax可選String10檢索結(jié)果的 編碼方式固定取值：" XML7.otherInfo可選Element其他信息備用2 .請(qǐng)求報(bào)文體模板<searchRequest><referenceId>f4973365-a9be-4f80-b5d8-a8b9c794918區(qū)/referenceId><replaceIndicator>true</replaceIndicator><resultSetID>highResult</resultSetID><databaseNames：B

27、MDB</databaseNames><preferredRecordSyntax>XML</preferredRecordSyntax><query>10§國(guó)標(biāo)的逆波蘭表達(dá)式（RPN）&合的查詢條件具體規(guī)則參考附錄 E QUERYRPNOh </query></searchRequest>3 .響應(yīng)報(bào)文體序號(hào)元素名稱約束長(zhǎng)度描述取值說明1.referenceId必選String50會(huì)話標(biāo)識(shí)2.resultCount必選NumberString20符合條件 的記錄數(shù)服務(wù)器端執(zhí)行檢索操作得 到的命中記錄數(shù)，

28、檢索失敗 設(shè)置為03.searchStatus必選String7執(zhí)行檢索 的執(zhí)行結(jié) 果返回的檢索狀態(tài)信息， success表小檢索成功， failture表小檢索失敗4.otherInfo可選element其他信息備用4 .響應(yīng)報(bào)文體模板<searchResponse><referenceId>3720b175-7db7-408d-90cd-108e1f2ec88N/referenceId><resultCount>9</resultCount><searchStatus：succes</searchStatus><

29、otherInfo></otherInfo></searchResponse>5 .2.2資源目錄檢索結(jié)果提取目錄檢索結(jié)果由服務(wù)器端從結(jié)果集中提取并返回若干數(shù)據(jù)記錄給客戶端1 .請(qǐng)求報(bào)文體序號(hào)元素名稱約束長(zhǎng)度描述取值說明1.referenceId必選String50會(huì)話標(biāo)識(shí)2.resultSetID必選String要抽取的 結(jié)果集的 標(biāo)識(shí)因?yàn)橄到y(tǒng)允許在抽取數(shù)據(jù) 前進(jìn)行多次檢索，每次檢 索都可以指定/、同的結(jié)果 集名稱，所以客戶端必須 指定要抽取的數(shù)據(jù)結(jié)果集 標(biāo)識(shí)3.resultSetStartP oint必選NumberString20開始抽取 的位置客戶端指定的

30、從第幾條記錄開始抽取，序號(hào)從 1開始4.numberOfReco rdsResquested必選NumberString20記錄數(shù)客戶端指定的要抽取的記 錄數(shù)5.elementSetNa me必選element結(jié)果集屬 性參見表表A.3elementSetName 結(jié)果 集屬性6.preferredRecor dSyntax可選String10提取結(jié)果 的編碼方 式固定取值：" XML7.otherInfo可選element其他信息備用2 .請(qǐng)求報(bào)文體模板<presentRequest><referenceId>f4973365-a9be-4f80-b5d8-

31、a8b9c794918區(qū)/referenceId><resultSetID+ighResult</resultSetID><resultSetStartPoint»</resultSetStartPoint><numberOfRecordsResquested30</numberOfRecordsResquested><elementSetName><genericElementSetName：brief</genericElementSetName></elementSetName>

32、;<preferredRecordSyntaxXML</preferredRecordSyntax></presentRequest>3 .響應(yīng)報(bào)文體序號(hào)元素名稱約束長(zhǎng)度描述取值說明1.referenceId必選String50會(huì)話標(biāo)識(shí)2.numberOfRecord sReturned必選NumberString20元數(shù)據(jù)數(shù) 目服務(wù)器端返回的元數(shù) 據(jù)數(shù)目3.presentStatus必選String7提取狀態(tài)服務(wù)器端返回的提取 狀態(tài)。success表小提 取成功，failture表小提 取失敗4.records必選element結(jié)果集服務(wù)器返回的結(jié)果集， 包含一

33、個(gè)或多個(gè)singleRecord,詳細(xì)描述參見表A.5singleRecord參數(shù)表5.otherInfo可選element其他信息備用4 .響應(yīng)報(bào)文體模板<presentResponse><referenceId>f4973365-a9be-4f80-b5d8-a8b9c794918區(qū)/referenceId><numberOfRecordsReturned»</numberOfRecordsReturned><presentStatus>success：/presentStatus><records>構(gòu)

34、化資源目錄/非結(jié)構(gòu)化資源目錄</records><otherInfo></otherInfo></presentResponse>5 .3資源服務(wù)接口要求6.3.1資源內(nèi)容檢索資源檢索是公共信息平臺(tái)服務(wù)端根據(jù)客戶端發(fā)送的請(qǐng)求信息，從共享數(shù)據(jù) 庫(kù)中讀取符合條件的記錄，并將查詢結(jié)果集相關(guān)返回的過程。 注意，資源檢索功 能并不返回具體的結(jié)果集，結(jié)果集返回功能將由“資源檢索結(jié)果提取”服務(wù)提供。結(jié)果集的保存時(shí)間與會(huì)話標(biāo)識(shí)一致，當(dāng)會(huì)話結(jié)束后，響應(yīng)的結(jié)果集將被同步刪除。1 .請(qǐng)求報(bào)文體序號(hào)元素名稱約束長(zhǎng)度描述取值說明1.referenceld必選String5

35、0會(huì)話標(biāo)識(shí)2.resid必選String50資源標(biāo)識(shí)符6位字母/數(shù)字加”加1到23位數(shù)字3.replaceIndicator必選Boolean結(jié)果集覆蓋 標(biāo)志true表不覆蓋原來的查詢 結(jié)果，false表小保留原來 的查詢結(jié)果4.resultSetID必選String200指定的查詢 結(jié)果集名稱若存在同名的結(jié)果集，需要根據(jù) replaceindicator 判 斷是否需要覆蓋結(jié)果集。5.dataQuery必選element客戶端定制 的檢索條件參見附錄CQUERYRESDATA 說明- dataQuery屬，件t兌明6.preferredRecordSyntax可選String10檢索結(jié)果的

36、編碼方式固定取值：" XML7.otherinfo可選element其他信息備用2 .請(qǐng)求報(bào)文體模板<dataSearchRequest><referenceId>d8137d81-ef76-4dc5-80c7-01dc493f9d3</referenceId><resId>GXWgxwAA00®/resId><resultSetID>GXWgxwAA00住/resultSetID><replaceIndicator>true</replaceIndicator><pref

37、erredRecordSyntaxXML</preferredRecordSyntax><dataQuery加值參考 dataQuery屬性說明 </dataQuery></dataSearchRequest>3 .響應(yīng)報(bào)文體序 號(hào)元素名稱約束長(zhǎng)度描述取值說明1.referenceId必選String50會(huì)話標(biāo) 識(shí)2.resultCount必選NumberString20符合條 件的記 錄數(shù)服務(wù)器端執(zhí)行檢索操 作得到的命中記錄 數(shù)，檢索失敗設(shè)置為03.searchStatus必選String7執(zhí)行檢 索的執(zhí) 行結(jié)果返回的檢索狀態(tài)信息，success表小

38、檢索 成功，failture表小檢 索失敗4.opResult可選element操作信 息詳情參見附錄表A.4-opResult 屬性表5.otherInfo可選element其他信 息備用4 .響應(yīng)報(bào)文體模板<dataSearchResponse><referenceId>d8137d81-ef76-4dc5-80c7-01dc493f9d3</referenceId><resultCount>0</resultCount><searchStatus>ailure</searchStatus><opRe

39、sult><opStatus>ailure </opStatus><opRetCode>|誤彳t碼 </opRetCode><opRetMsg>ihyi信息 </opRetMsg></opResult><otherInfo></otherInfo></dataSearchResponse>5 .3.2資源內(nèi)容檢索結(jié)果提取資源檢索結(jié)果提取用于從崔源才索 所得的結(jié)果集中提取指定的結(jié)果。序號(hào)元素名稱約束長(zhǎng)度描述取值說明1.referenceId必選String50會(huì)話標(biāo)識(shí)2.

40、resultSetID必選String要抽取的 結(jié)果集的 標(biāo)識(shí)因?yàn)橄到y(tǒng)允許在抽 取數(shù)據(jù)前進(jìn)行多次 檢索，每次檢索都 可以指定/、同的結(jié) 果集名稱，所以客 戶端必須指7E要抽 取的數(shù)據(jù)結(jié)果集標(biāo) 識(shí)3.resultSetStartPoint必選NumberString20開始抽取 的位置客戶端指定的從第 幾條記錄開始抽 取，序號(hào)從1開始4.numberOfRecordsRe squested必選NumberString20記錄數(shù)客戶端指定的要抽 取的記錄數(shù)5.numberOfRecordsTo tal必選NumberString20符合條件 的總共命 中記錄數(shù)資源檢索接口查詢 得到的總共命中記 錄

41、數(shù)。6.preferredRecordSynt ax可選String10提取結(jié)果 的編碼方 式固定取值：" XML7.otherInfo可選element其他信息備用2 .請(qǐng)求報(bào)文體模板<dataPresentRequest><referenceId>2190bf83-a934-4f4d-995c-f688dc4808a&/referenceId><resultSetID>JTJQD/JTJ000«/resultSetID><resultSetStartPoint>1</resultSetStartP

42、oint><numberOfRecordsResquested30</numberOfRecordsResquested><numberOfRecordsTotal>3</numberOfRecordsTotal><preferredRecordSyntax>XML</preferredRecordSyntax></dataPresentRequest>3 .響應(yīng)報(bào)文體序號(hào)元素名稱約束長(zhǎng)度描述取值說明1.referenceId必選String50會(huì)話標(biāo)識(shí)2.numberOfRecordsReturned必選Nu

43、mberString20元數(shù)據(jù)數(shù) 目服務(wù)器端返回的元數(shù)據(jù)數(shù) 目3.presentstatus必選String7提取狀態(tài)服務(wù)器端返回的提取狀態(tài)。success表小提取成 功，failture表小提取失敗4.resType必選String50資源種類結(jié)構(gòu)化資源或非結(jié)構(gòu)化資 源，/、同的資源種類對(duì)應(yīng) 的 singleRecord 中 Item 項(xiàng) /、同5.records必選element結(jié)果集服務(wù)器返回的結(jié)果集，包 含一個(gè)或多個(gè)singleRecord,詳細(xì)描述參 見B.2資源檢索結(jié)果提取 結(jié)構(gòu)6.otherInfo可選element其他信息備用4 .響應(yīng)報(bào)文體模板<dataPresentR

44、esponse><referenceId>687d0aed-6e43-44eb-9d0e-e25eeca8347</referenceId><numberOfRecordsReturned：3</numberOfRecordsReturned><presentStatus>s</presentStatus><resType紹構(gòu)化資源 </resType><records><singleRecord> .</singleReco婚（結(jié)構(gòu)參照）</records>&l

45、t;otherInfo></otherInfo></dataPresentResponse>6.4管理接口要求6.4.1目錄資源元數(shù)據(jù)管理目錄資源元數(shù)據(jù)管理接口包含元數(shù)據(jù)的新增、刪除和更新操作，根據(jù)不同 的操作類型來完成相應(yīng)的動(dòng)作，且元數(shù)據(jù)管理接口 一次只操作一種操作類型的一 條元數(shù)據(jù)記錄。當(dāng)操作類型為更新時(shí)其操作對(duì)象為通過“目錄檢索結(jié)果提取”接口返回的 元數(shù)據(jù)，元數(shù)據(jù)元素必須符合核心元數(shù)據(jù)屬性集要求；當(dāng)操作類型為刪除時(shí)，其操作對(duì)象為通過“目錄檢索結(jié)果提取”接口返回 的元數(shù)據(jù)中的特定一條記錄;當(dāng)操作類型為創(chuàng)建時(shí)，請(qǐng)求方必須按附錄B勺定的編目要求提供完整的元數(shù) 據(jù)信

46、息。1 .請(qǐng)求報(bào)文序號(hào)元素名稱約束長(zhǎng)度描述取值說明1referencel d必選String50會(huì)話標(biāo)識(shí)2type必選Int用于指定進(jìn)行元數(shù)據(jù) 的各種管理操作，詳細(xì) 內(nèi)容見表 A.6元數(shù) 據(jù)管理類型定義3recordId可選String待刪除或待更新的 元數(shù)據(jù)標(biāo)識(shí)符（即資 源標(biāo)識(shí)符）。該標(biāo)識(shí) 符附于在元數(shù)據(jù)庫(kù) 中指定唯一的元數(shù) 據(jù)?？梢酝ㄟ^目錄 檢索結(jié)果提取接口 族取其響應(yīng)消息。當(dāng)type為1時(shí)，進(jìn)行 元數(shù)據(jù)插入操作，本參 數(shù)不出現(xiàn)；當(dāng)type為 2或3時(shí)，進(jìn)行元數(shù)據(jù) 刪除或更新操作，本參 數(shù)為必選參數(shù)4Data可選XML待創(chuàng)建或更新的兀 數(shù)據(jù)內(nèi)容，當(dāng)type 為1或3時(shí)，進(jìn)行 兀數(shù)據(jù)插入或更

47、新 操作，本參數(shù)為必 選參數(shù)；當(dāng)type為 2時(shí)，進(jìn)行元數(shù)據(jù)刪 除操作，本參數(shù)不 出現(xiàn)更新操作時(shí)，Data格 式定義為：<records><item><itemName></itemNa me><itemValue></itemVal ue></item></records>,Records節(jié)點(diǎn)包含一組 或多組元數(shù)據(jù)屬性參 數(shù)itemName和元數(shù) 據(jù)屬性值參數(shù) itemValue。 itemName 取值要求符合表核 心元數(shù)據(jù)屬性集之約 定5otherInfo可選String其他信息備用2 .返回

48、報(bào)文序號(hào)元素名稱約束長(zhǎng)度描述取值說明1.referenceld必選String50會(huì)話標(biāo)識(shí)2.operationstate必選String7執(zhí)行結(jié)果Success表示執(zhí)行元數(shù)據(jù)管理操 作成功；Failture表示執(zhí)行元數(shù)據(jù)管理操 作失敗3.operationType可選Int操作類型用來表示服務(wù)器端執(zhí)行的元數(shù) 據(jù)管理操作類型，必須符合表 元數(shù)據(jù)管理類型定義之約定4.otherInfo可選element其他信息當(dāng)執(zhí)行成功時(shí)本元素不出現(xiàn),當(dāng)執(zhí)行失敗時(shí)，格式定為：<errCode></errCode><errMsg></errMsg> , errcod

49、e 表 不錯(cuò)誤碼，errMsg表小錯(cuò)誤信息附錄A要求所涉及的結(jié)構(gòu)表表 A.1 databaseList 組成參數(shù)名稱約束參數(shù)含義databaseld必選標(biāo)識(shí)一個(gè)元數(shù)據(jù)庫(kù)，以公共信息平臺(tái)的應(yīng)用單位 編號(hào)代替databaseName必選元數(shù)據(jù)庫(kù)名稱databaseDescribe必選元數(shù)據(jù)庫(kù)的基本描述信息表A.2服務(wù)功能列表功能標(biāo)識(shí)交易編碼(transid)國(guó)標(biāo)要求是否支持含義initinitRequest是是用于建立客戶端與服務(wù) 端的會(huì)話closecloseRequest是是終止客戶端與服務(wù)端的 會(huì)話capbilitiescatalogCapabilitiesReque st是是提供服務(wù)本身的各

50、種描 述信息searchsearchRequest是是檢索目錄信息并形成結(jié) 果集presentpresentRequest是是目錄檢索結(jié)果提取，從結(jié)果集中提取結(jié)果metadataManag er否否對(duì)公共信息平臺(tái)進(jìn)行遠(yuǎn) 程管理resSelfDescresSelfDescRequest否是資源自描述dataSearchdataSearchRequest否是檢索資源dataPresentdataPresentRequest否是從檢索出的資源結(jié)果集 中抽取數(shù)據(jù)pubKeypubKeyRequest否是用于從服務(wù)端獲取公鑰表A.3 elementSetName 結(jié)果集屬性參數(shù)名稱參數(shù)類型取值參數(shù)含義g

51、enericElement -SetNameStringBrief提取信息資源核心 元數(shù)據(jù)genericElement -SetNameStringFull或空提取全部的信息資 源元數(shù)據(jù)elementSetList<String>元數(shù)據(jù)屬性字段標(biāo) 識(shí)符列表必須符合表核心 元數(shù)據(jù)屬性集的 編他要求表A.4 opResult屬性表屬性名長(zhǎng)度約束參數(shù)含義opStatusString8必選執(zhí)行結(jié)果，"succes表示成功，"failture 表示失敗opRetCodeString8可選執(zhí)行結(jié)果，”表示成功，其他表示錯(cuò)誤代 碼opRetMsgString200可選錯(cuò)誤的說

52、明表 A.5 singleRecord 參數(shù)表參數(shù)名稱參數(shù)類型約束參數(shù)含義itemelement必選結(jié)果集中的元數(shù)據(jù)記錄，包含一組或多組元數(shù)據(jù)屬性參數(shù)itemName和元數(shù)據(jù)屬性值參數(shù) itemValue。提取的結(jié)果集是核心兀數(shù)據(jù)時(shí)，參數(shù)itemName取值要求符合表核心兀數(shù)據(jù)屬性集databaseIdString可選提取全部的信息資源元數(shù)據(jù)recordIdString可選必須符合表的編碼要求（即資源標(biāo)識(shí)符）表A.6元數(shù)據(jù)管理類型定義名稱取值含義創(chuàng)建元數(shù)據(jù)1用于表示該次請(qǐng)求是進(jìn)行創(chuàng)建元數(shù)據(jù)操作刪除元數(shù)據(jù)2用于表示該次請(qǐng)求是進(jìn)行刪除元數(shù)據(jù)操作更新兀數(shù)據(jù)3用于表示該次請(qǐng)求是進(jìn)行更新兀數(shù)據(jù)操作表A.

53、7核心元數(shù)據(jù)屬性集核心元數(shù)據(jù)屬性集的編碼規(guī)則如下：第一層代碼只有一位阿拉伯?dāng)?shù)字。其取值為“1”，表示核心元數(shù)據(jù)。第二層是核心元數(shù)據(jù)元素和元數(shù)據(jù)實(shí)體，采用三位阿拉伯?dāng)?shù)字。該編碼結(jié)構(gòu)分為二層：第一層采用一位阿拉伯?dāng)?shù)字，核心元數(shù)據(jù)取值為 1；第二層代碼采 用三位阿拉伯?dāng)?shù)字，利用遞增順序碼的方法進(jìn)行編碼。例如，“資源名稱”的編碼為“1.001”，“資源出版日期”的編碼為“ 1.002”。第三層是元數(shù)據(jù)實(shí)體所包含的元數(shù)據(jù)元素，采用五位阿拉伯?dāng)?shù)字。該編碼結(jié)構(gòu)分為三層：第一層采用一位阿拉伯?dāng)?shù)字，核心元數(shù)據(jù)取值為 1；第二層代碼 采用三位阿拉伯?dāng)?shù)字，利用遞增順序碼的方法進(jìn)行編碼，為該元數(shù)據(jù)元素所屬元 數(shù)據(jù)實(shí)體

54、的編碼；第三層代碼采用兩位阿拉伯?dāng)?shù)字，利用遞增順序碼的方法進(jìn)行 編碼。例如，”資源負(fù)責(zé)單位”的編碼為“1.004.01 "。如圖A.1所示：X . X X X e X X第三層代碼第二層代碼第一層代碼圖A.1核心元數(shù)據(jù)屬性集的編碼規(guī)則示意圖卜面是相應(yīng)的核心元數(shù)據(jù)屬性集:編碼中文名稱短名1.000資源核心元數(shù)據(jù)全文resMetadata1.001資源名稱resTitle1.002資源出版日期pubCate1.003資源摘要abstract1.004資源負(fù)責(zé)方IdPoC1.004.01資源負(fù)責(zé)單位rpOrgName1.004.02資源負(fù)責(zé)方地址cntAdd1.004.03資源負(fù)責(zé)方電子郵件地址eMailAdd1.005資源格式信息FmInfo1.005.01資源格式名稱fmName1.005.02資源格式版本