智慧城市公共信息平臺(tái) 附件七:接口及服務(wù)要求_第1頁(yè)
智慧城市公共信息平臺(tái) 附件七:接口及服務(wù)要求_第2頁(yè)
智慧城市公共信息平臺(tái) 附件七:接口及服務(wù)要求_第3頁(yè)
智慧城市公共信息平臺(tái) 附件七:接口及服務(wù)要求_第4頁(yè)
智慧城市公共信息平臺(tái) 附件七:接口及服務(wù)要求_第5頁(yè)
已閱讀5頁(yè),還剩102頁(yè)未讀, 繼續(xù)免費(fèi)閱讀

下載本文檔

版權(quán)說(shuō)明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請(qǐng)進(jìn)行舉報(bào)或認(rèn)領(lǐng)

文檔簡(jiǎn)介

1、CJ/T XXXXXXX附件七智慧城市公共信息平臺(tái)平臺(tái)接口與服務(wù)要求(試 行)中華人民共和國(guó)住房和城鄉(xiāng)建設(shè)部建筑節(jié)能與科技司二一三年三月3目 次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 使用說(shuō)明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 資源目錄檢索結(jié)果提取

2、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.3 elementSetName結(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屬性集27附錄B QUERY-RES-DATA說(shuō)明30B.1

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

4、。l 本部分要求分兩大部分描述平臺(tái)接口要求,第一部分:總體要求,總體要求描述消息的總體結(jié)構(gòu)、接口訪問方、接口地址、使用說(shuō)明。第二部分:業(yè)務(wù)接口要求,具體描述每個(gè)業(yè)務(wù)應(yīng)用服務(wù)接口的要求。也就是每一個(gè)業(yè)務(wù)接口要求套在總體要求內(nèi)。只有使用業(yè)務(wù)接口要求+總體要求才能正常使用信息平臺(tái)的應(yīng)用服務(wù)來(lái)發(fā)現(xiàn),查詢,管理資源。l 本部分適用于參與公共信息平臺(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ù)要求;GB/T 21063.3-2007 政務(wù)信息資源目錄體系 第3部分:核心元數(shù)據(jù);GB/T 21063.4-2007 政務(wù)信息資源目錄體系 第4部分: 政務(wù)信息資源分類;GB/T 21063.5-2007 政務(wù)信息資源目錄體系 第5部分:政務(wù)信息資源標(biāo)識(shí)符編碼方案; 本文 引用GB/T 21063.2-2007中的附錄A 目錄服務(wù)接口; 本文引用GB/T 21063

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

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

8、隔輪詢應(yīng)用單位換入表,拆解XML報(bào)文,根據(jù)目標(biāo)庫(kù)自動(dòng)分揀; 非結(jié)構(gòu)化數(shù)據(jù)文件直接通過文件服務(wù)傳輸至交換中心文件服務(wù)器,并有中心分發(fā)非結(jié)構(gòu)化數(shù)據(jù)文件。l 數(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ù)文件。l 交換管理程序完成數(shù)據(jù)交換審批流程、交換監(jiān)控、交換調(diào)度、系統(tǒng)管理等功能一套程序,部署于中心。l Web服務(wù)基于webservice技術(shù)開放的服務(wù)接口,采用約定的XML作為交易數(shù)據(jù)接口,提供給客戶端調(diào)用。l WSDLWeb服務(wù)描

9、述文件,一個(gè)用來(lái)描述Web服務(wù)和說(shuō)明如何與Web服務(wù)通信的XML語(yǔ)言。為用戶提供詳細(xì)的接口說(shuō)明。l 訪問認(rèn)證公共信息平臺(tái)提供用戶認(rèn)證服務(wù),由托管應(yīng)用系統(tǒng)的客戶端調(diào)用,用于驗(yàn)證用戶是否合法;l 應(yīng)用單位接入公共信息平臺(tái)的機(jī)構(gòu)單位。l 主管單位公共信息平臺(tái)的管理單位。l 數(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è)公共接口。這3類接口實(shí)現(xiàn)了信息資源的發(fā)現(xiàn)功能

10、、檢索功能和管理功能?;A(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. 城市公共信息平臺(tái)接口服務(wù)組成圖4.2 接口技術(shù)要求a) 提供基于

11、SOAP協(xié)議的web服務(wù)接口b) 支持跨語(yǔ)言、跨操作系統(tǒng)調(diào)用5 總體要求5.1 消息結(jié)構(gòu)每個(gè)交易消息(包括請(qǐng)求和應(yīng)答)有一個(gè)是名字(Message Name),交易消息以XML格式表達(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)文范例5.1.2 響應(yīng)報(bào)文范例5.2 接口方式接口采用WebService方式,接口協(xié)議使用SOAP協(xié)議,提供標(biāo)準(zhǔn)的WSDL文件。5.3 接口地址公共信息

12、目錄服務(wù)(以下簡(jiǎn)稱目錄服務(wù))主要有三個(gè)wsdl地址,不同的wsdl下有不同的方法,下文有說(shuō)明。這是根據(jù)webservice的soap協(xié)議開放出來(lái)的wsdl地址,第三方應(yīng)用可以根據(jù)實(shí)際的部署的服務(wù)器地址來(lái)使用它。1) 基礎(chǔ)接口WSDL文件地址:http:/:/es/catalogbase?wsdll 目錄服務(wù)初始化 initCatalogServicel 目錄服務(wù)終止 stopCatalogService2) 發(fā)現(xiàn)接口WSDL文件地址:http:/:/es/digcatalog?wsdll 目錄檢索 queryCatalogListl 目錄檢索結(jié)果提取 queryCatalogResult3)

13、資源服務(wù)接口:http:/:/es/digresource?wsdll 資源檢索 getResourceResultsetl 資源檢索結(jié)果提取 getResourceResultDetail4) 發(fā)現(xiàn)接口WSDL文件地址:http:/:/es/digcatalog?wsdll 資源元數(shù)據(jù)管理 metadataManage5.4 使用說(shuō)明完成資源的檢索與發(fā)現(xiàn)需要根據(jù)以下步驟來(lái)操作完成:1) 第一步:初始化操作。調(diào)用基礎(chǔ)接口的“目錄服務(wù)初始化”獲得一個(gè)會(huì) 話標(biāo)識(shí)符以后每次調(diào)用接口都需要次標(biāo)識(shí)符。2) 第二步:查詢公共信息目錄操作。調(diào)用發(fā)現(xiàn)接口的“目錄檢索”組織好查詢參數(shù),發(fā)起交易,獲得查詢結(jié)果。注

14、:這里的查詢結(jié)果只有返回命中的查詢記錄數(shù)。比如:返回值是100,那么表示有100條記錄符合查詢條件,這個(gè)時(shí)候需要發(fā)起“公共信息目錄檢索結(jié)果提取”交易才能提取查詢的結(jié)果。如果發(fā)回值是0,表示沒有符合查詢條件的記錄。3) 第三步:查詢公共信息目錄對(duì)應(yīng)的資源。這里的操作也是和上面一樣,調(diào)用“資源檢索”先要查詢下是否有符合查詢條件的資源。有資源記錄的話,然后在調(diào)用“資源檢索結(jié)果提取”提取符合條件的資源信息。4) 第四步:假如調(diào)用接口結(jié)束后,可調(diào)用基礎(chǔ)接口里的“目錄服務(wù)終止”來(lái)釋放會(huì)話標(biāo)識(shí)符資源信息。6 業(yè)務(wù)接口要求6.1 基礎(chǔ)接口要求6.1.1 目錄服務(wù)初始化公共信息目錄服務(wù)初始化用于建立客戶端與服務(wù)

15、端的會(huì)話,所有其他服務(wù)都必須依賴會(huì)話。會(huì)話的持續(xù)時(shí)間為30分鐘,若會(huì)話持續(xù)30分鐘沒有活動(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)度描述取值說(shuō)明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可選

16、String200應(yīng)用名稱在公共信息平臺(tái)用戶管系統(tǒng)中注冊(cè)的第三方應(yīng)用名稱5.otherInfo可選element其他信息備用2. 請(qǐng)求報(bào)文體模板V1.0testApp/124561測(cè)試應(yīng)用3. 響應(yīng)報(bào)文體序號(hào)元素名稱約束類型長(zhǎng)度描述取值說(shuō)明1.referenceId必選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.pubK

17、ey必選String64加解密公鑰5.otherInfo可選element其他信息備用4. 響應(yīng)報(bào)文體模板cde2db52-8cee-45f4-9cec-f8a68ebbad5cV1.0catalogtrue初始化服務(wù)成功6.1.2 目錄服務(wù)終止公共信息目錄服務(wù)終止將結(jié)束服務(wù)端與客戶端的會(huì)話,與會(huì)話相關(guān)的資源將被釋放。1. 請(qǐng)求報(bào)文體序號(hào)元素名稱約束類型長(zhǎng)度描述取值說(shuō)明1.referenceId必選String50會(huì)話標(biāo)識(shí)要終止的會(huì)話編號(hào)2.closeReason可選String50終止原因3.otherInfo可選element其他信息備用2. 求報(bào)文體模板cde2db52-8cee-45f

18、4-9cec-f8a68ebbad5c終止使用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)度描述取值說(shuō)明1.otherInfo可選element其他信息備用2. 請(qǐng)求報(bào)文體模板3. 響應(yīng)報(bào)文體序號(hào)元素名稱約束類型長(zhǎng)度描述取值說(shuō)明1.pubKey必選String8公鑰用于加解密密碼的密鑰2.opR

19、esult必選element操作結(jié)果參見表A.6 opResult屬性表之說(shuō)明3.otherInfo可選element其他信息備用4. 響應(yīng)報(bào)文體模板catalogtruecodemessage6.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)度描述取值說(shuō)明1.referenceId必選String50會(huì)話標(biāo)識(shí)2.replaceIndicator必選Boo

20、lean結(jié)果集覆蓋標(biāo)志true表示覆蓋原來(lái)的查詢結(jié)果,false表示保留原來(lái)的查詢結(jié)果3.resultSetID必選String200指定的查詢結(jié)果集名稱若存在同名的結(jié)果集,需要根據(jù)replaceIndicator判斷是否需要覆蓋結(jié)果集。4.databaseNames必選Element要查詢的元數(shù)據(jù)庫(kù)名稱列表客戶端指定的要查詢的元數(shù)據(jù)庫(kù)名稱列表5.query必選Element客戶端定制的檢索語(yǔ)句檢索語(yǔ)句必須符合Type-1型,使用逆波蘭表達(dá)式(RPN)作為檢索語(yǔ)法,參見附錄E QUERY-RPN范例6.preferredRecordSyntax可選String10檢索結(jié)果的編碼方式固定取值:”

21、XML”7.otherInfo可選Element其他信息備用2. 請(qǐng)求報(bào)文體模板f4973365-a9be-4f80-b5d8-a8b9c7949185truehighResultBMDBXML根據(jù)國(guó)標(biāo)的逆波蘭表達(dá)式(RPN)組合的查詢條件具體規(guī)則參考附錄E QUERY-RPN范例3. 響應(yīng)報(bào)文體序號(hào)元素名稱約束類型長(zhǎng)度描述取值說(shuō)明1.referenceId必選String50會(huì)話標(biāo)識(shí)2.resultCount必選NumberString20符合條件的記錄數(shù)服務(wù)器端執(zhí)行檢索操作得到的命中記錄數(shù),檢索失敗設(shè)置為03.searchStatus必選String7執(zhí)行檢索的執(zhí)行結(jié)果返回的檢索狀態(tài)信息,

22、success表示檢索成功,failture表示檢索失敗4.otherInfo可選element其他信息備用4. 響應(yīng)報(bào)文體模板3720b175-7db7-408d-90cd-108e1f2ec8879success6.2.2 資源目錄檢索結(jié)果提取目錄檢索結(jié)果由服務(wù)器端從結(jié)果集中提取并返回若干數(shù)據(jù)記錄給客戶端。1. 請(qǐng)求報(bào)文體序號(hào)元素名稱約束類型長(zhǎng)度描述取值說(shuō)明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.r

23、esultSetStartPoint必選NumberString20開始抽取的位置客戶端指定的從第幾條記錄開始抽取,序號(hào)從1開始4.numberOfRecordsResquested必選NumberString20記錄數(shù)客戶端指定的要抽取的記錄數(shù)5.elementSetName必選element結(jié)果集屬性參見表表 A.3elementSetName結(jié)果集屬性6.preferredRecordSyntax可選String10提取結(jié)果的編碼方式固定取值:”XML”7.otherInfo可選element其他信息備用2. 請(qǐng)求報(bào)文體模板f4973365-a9be-4f80-b5d8-a8b9c794

24、9185highResult030briefXML3. 響應(yīng)報(bào)文體序號(hào)元素名稱約束類型長(zhǎng)度描述取值說(shuō)明1.referenceId必選String50會(huì)話標(biāo)識(shí)2.numberOfRecordsReturned必選NumberString20元數(shù)據(jù)數(shù)目服務(wù)器端返回的元數(shù)據(jù)數(shù)目3.presentStatus必選String7提取狀態(tài)服務(wù)器端返回的提取狀態(tài)。success表示提取成功,failture表示提取失敗4.records必選element結(jié)果集服務(wù)器返回的結(jié)果集,包含一個(gè)或多個(gè)singleRecord,詳細(xì)描述參見表A.5 singleRecord參數(shù)表5.otherInfo可選elemen

25、t其他信息備用4. 響應(yīng)報(bào)文體模板f4973365-a9be-4f80-b5d8-a8b9c79491859success結(jié)構(gòu)化資源目錄/非結(jié)構(gòu)化資源目錄6.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)度描述取值說(shuō)明1.referenceId必選String50會(huì)話標(biāo)識(shí)2.resI

26、d必選String50資源標(biāo)識(shí)符6位字母/數(shù)字加”/”加1到23位數(shù)字3.replaceIndicator必選Boolean結(jié)果集覆蓋標(biāo)志true表示覆蓋原來(lái)的查詢結(jié)果,false表示保留原來(lái)的查詢結(jié)果4.resultSetID必選String200指定的查詢結(jié)果集名稱若存在同名的結(jié)果集,需要根據(jù)replaceIndicator判斷是否需要覆蓋結(jié)果集。5.dataQuery必選element客戶端定制的檢索條件參見附錄C QUERY-RES-DATA說(shuō)明 dataQuery屬性說(shuō)明6.preferredRecordSyntax可選String10檢索結(jié)果的編碼方式固定取值:”XML”7.oth

27、erInfo可選element其他信息備用2. 請(qǐng)求報(bào)文體模板d8137d81-ef76-4dc5-80c7-01dc493f9d3fGXWgxwAA000GXWgxwAA000trueXML取值參考dataQuery屬性說(shuō)明3. 響應(yīng)報(bào)文體序號(hào)元素名稱約束類型長(zhǎng)度描述取值說(shuō)明1.referenceId必選String50會(huì)話標(biāo)識(shí)2.resultCount必選NumberString20符合條件的記錄數(shù)服務(wù)器端執(zhí)行檢索操作得到的命中記錄數(shù),檢索失敗設(shè)置為03.searchStatus必選String7執(zhí)行檢索的執(zhí)行結(jié)果返回的檢索狀態(tài)信息,success表示檢索成功,failture表示檢索失敗

28、4.opResult可選element操作信息詳情參見附錄表A.4-opResult屬性表5.otherInfo可選element其他信息備用4. 響應(yīng)報(bào)文體模板d8137d81-ef76-4dc5-80c7-01dc493f9d3f0failurefailure錯(cuò)誤代碼錯(cuò)誤信息6.3.2 資源內(nèi)容檢索結(jié)果提取資源檢索結(jié)果提取用于從所得的結(jié)果集中提取指定的結(jié)果。1. 請(qǐng)求報(bào)文體序號(hào)元素名稱約束類型長(zhǎng)度描述取值說(shuō)明1.referenceId必選String50會(huì)話標(biāo)識(shí)2.resultSetID必選String要抽取的結(jié)果集的標(biāo)識(shí)因?yàn)橄到y(tǒng)允許在抽取數(shù)據(jù)前進(jìn)行多次檢索,每次檢索都可以指定不同的結(jié)果集

29、名稱,所以客戶端必須指定要抽取的數(shù)據(jù)結(jié)果集標(biāo)識(shí)3.resultSetStartPoint必選NumberString20開始抽取的位置客戶端指定的從第幾條記錄開始抽取,序號(hào)從1開始4.numberOfRecordsResquested必選NumberString20記錄數(shù)客戶端指定的要抽取的記錄數(shù)5.numberOfRecordsTotal必選NumberString20符合條件的總共命中記錄數(shù)資源檢索接口查詢得到的總共命中記錄數(shù)。6.preferredRecordSyntax可選String10提取結(jié)果的編碼方式固定取值:”XML”7.otherInfo可選element其他信息備用2. 請(qǐng)

30、求報(bào)文體模板2190bf83-a934-4f4d-995c-f688dc4808aeJTJQD/JTJ000001303XML3. 響應(yīng)報(bào)文體序號(hào)元素名稱約束類型長(zhǎng)度描述取值說(shuō)明1.referenceId必選String50會(huì)話標(biāo)識(shí)2.numberOfRecordsReturned必選NumberString20元數(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

31、中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)文體模板687d0aed-6e43-44eb-9d0e-e25eeca834703s結(jié)構(gòu)化資源.(具體結(jié)構(gòu)參照)6.4 管理接口要求6.4.1 目錄資源元數(shù)據(jù)管理目錄資源元數(shù)據(jù)管理接口包含元數(shù)據(jù)的新增、刪除和更新操作,根據(jù)不同的操作類型來(lái)完成相應(yīng)的動(dòng)作,且元數(shù)據(jù)管理接口一次只操作一種操作類型的一條元數(shù)據(jù)記錄。當(dāng)操作類型為更新時(shí)其操作對(duì)象為通過“目錄檢索結(jié)果提取”接口返回的元數(shù)據(jù)

32、,元數(shù)據(jù)元素必須符合核心元數(shù)據(jù)屬性集要求;當(dāng)操作類型為刪除時(shí),其操作對(duì)象為通過“目錄檢索結(jié)果提取”接口返回的元數(shù)據(jù)中的特定一條記錄;當(dāng)操作類型為創(chuàng)建時(shí),請(qǐng)求方必須按附錄B約定的編目要求提供完整的元數(shù)據(jù)信息。1. 請(qǐng)求報(bào)文序號(hào)元素名稱約束類型長(zhǎng)度描述取值說(shuō)明1referenceId必選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ù)插入操

33、作,本參數(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ù)插入或更新操作,本參數(shù)為必選參數(shù);當(dāng)type為2時(shí),進(jìn)行元數(shù)據(jù)刪除操作,本參數(shù)不出現(xiàn)更新操作時(shí),Data格式定義為:,Records節(jié)點(diǎn)包含一組或多組元數(shù)據(jù)屬性參數(shù)itemName和元數(shù)據(jù)屬性值參數(shù)itemValue。itemName取值要求符合表 核心元數(shù)據(jù)屬性集之約定5otherInfo可選String其他信息備用2. 返回報(bào)文序號(hào)元素名稱約束類型長(zhǎng)度描述取值說(shuō)明1.referenceId必選String50會(huì)話標(biāo)識(shí)2.operat

34、ionState必選String7執(zhí)行結(jié)果Success表示執(zhí)行元數(shù)據(jù)管理操作成功;Failture表示執(zhí)行元數(shù)據(jù)管理操作失敗3.operationType可選Int操作類型用來(lái)表示服務(wù)器端執(zhí)行的元數(shù)據(jù)管理操作類型,必須符合表 元數(shù)據(jù)管理類型定義之約定4.otherInfo可選element其他信息當(dāng)執(zhí)行成功時(shí)本元素不出現(xiàn),當(dāng)執(zhí)行失敗時(shí),格式定為:,errcode表示錯(cuò)誤碼,errMsg表示錯(cuò)誤信息附錄A 要求所涉及的結(jié)構(gòu)表表A.1 databaseList組成參數(shù)名稱約束參數(shù)含義databaseId必選標(biāo)識(shí)一個(gè)元數(shù)據(jù)庫(kù),以公共信息平臺(tái)的應(yīng)用單位編號(hào)代替databaseName必選元數(shù)據(jù)庫(kù)名稱

35、databaseDescribe必選元數(shù)據(jù)庫(kù)的基本描述信息表A.2 服務(wù)功能列表功能標(biāo)識(shí)交易編碼(transid)國(guó)標(biāo)要求是否支持含義initinitRequest是是用于建立客戶端與服務(wù)端的會(huì)話closecloseRequest是是終止客戶端與服務(wù)端的會(huì)話capbilitiescatalogCapabilitiesRequest是是提供服務(wù)本身的各種描述信息searchsearchRequest是是檢索目錄信息并形成結(jié)果集presentpresentRequest是是目錄檢索結(jié)果提取,從結(jié)果集中提取結(jié)果metadataManager否否對(duì)公共信息平臺(tái)進(jìn)行遠(yuǎn)程管理resSelfDescresS

36、elfDescRequest否是資源自描述dataSearchdataSearchRequest否是檢索資源dataPresentdataPresentRequest否是從檢索出的資源結(jié)果集中抽取數(shù)據(jù)pubKeypubKeyRequest否是用于從服務(wù)端獲取公鑰表A.3 elementSetName結(jié)果集屬性參數(shù)名稱參數(shù)類型取值參數(shù)含義genericElement-SetNameStringBrief提取信息資源核心元數(shù)據(jù)genericElement-SetNameStringFull或空提取全部的信息資源元數(shù)據(jù)elementSetList元數(shù)據(jù)屬性字段標(biāo)識(shí)符列表必須符合表 核心元數(shù)據(jù)屬性集的

37、編碼要求表A.4 opResult屬性表屬性名類型長(zhǎng)度約束參數(shù)含義opStatusString8必選執(zhí)行結(jié)果,”success”表示成功,”failture”表示失敗opRetCodeString8可選執(zhí)行結(jié)果,”00000000”表示成功,其他表示錯(cuò)誤代碼opRetMsgString200可選錯(cuò)誤的說(shuō)明表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ù)屬性集database

38、IdString可選提取全部的信息資源元數(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.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)行編碼。例

39、如,“資源名稱”的編碼為“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í)體的編碼;第三層代碼采用兩位阿拉伯?dāng)?shù)字,利用遞增順序碼的方法進(jìn)行編碼。例如,“資源負(fù)責(zé)單位”的編碼為“1.004.01”。如圖A.1所示:圖A.1 核心元數(shù)據(jù)屬性集的編碼規(guī)則示意圖下面是相應(yīng)的核心元數(shù)據(jù)屬性集:編碼中文名稱短名1.000資源核心元數(shù)據(jù)全文resMetadata1.001資源名稱resTitle

40、1.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資源格式版本fmVer1.006關(guān)鍵字說(shuō)明DescKeys1.006.01關(guān)鍵字keyword1.006.02詞典名稱thesaName1.007空間范圍spatCom1.008時(shí)間范圍TimePeriod1.008.01起始時(shí)間begCate1.008.02結(jié)束時(shí)間

41、endCate1.009資源安全限制分級(jí)class1.010資源語(yǔ)種language1.011資源字符集dataChar1.012資源分類TpCat1.012.01類目名稱cateName1.012.02類目編碼cateCode1.012.03分類標(biāo)準(zhǔn)cateStd1.013數(shù)據(jù)志說(shuō)明statement1.014在線資源鏈接地址onLineSrc1.015資源標(biāo)識(shí)符resID1.016服務(wù)信息ServInfo1. 016.01服務(wù)地址servURL1. 016.02服務(wù)類型servType1.017元數(shù)據(jù)標(biāo)識(shí)符mdId1.018元數(shù)據(jù)語(yǔ)種mdLang1.019元數(shù)據(jù)聯(lián)系方MdContact1.019.01元數(shù)據(jù)聯(lián)系單位rpOrgName1.019.02元數(shù)據(jù)聯(lián)系方地址cntAdd1.019.03元數(shù)據(jù)聯(lián)系方電子郵件地址eMailAdd1.020元數(shù)據(jù)創(chuàng)建日期mdCateSt表A.8 關(guān)系運(yùn)算符屬性集編碼名稱符號(hào)1小于less than2小于等于less tha

溫馨提示

  • 1. 本站所有資源如無(wú)特殊說(shuō)明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請(qǐng)下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請(qǐng)聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁(yè)內(nèi)容里面會(huì)有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫(kù)網(wǎng)僅提供信息存儲(chǔ)空間,僅對(duì)用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對(duì)用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對(duì)任何下載內(nèi)容負(fù)責(zé)。
  • 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請(qǐng)與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時(shí)也不承擔(dān)用戶因使用這些下載資源對(duì)自己和他人造成任何形式的傷害或損失。

評(píng)論

0/150

提交評(píng)論