智慧城市公共信息平台平台接口与服务要求_第1页
智慧城市公共信息平台平台接口与服务要求_第2页
智慧城市公共信息平台平台接口与服务要求_第3页
智慧城市公共信息平台平台接口与服务要求_第4页
智慧城市公共信息平台平台接口与服务要求_第5页
已阅读5页,还剩60页未读 继续免费阅读

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

智慧城市公共信息平台平台接口与效劳要求1范围本要求是《智慧城市公共信息平台建设指南》建设要求系列之接口与服接口与服接口与效劳要求。本局部要求分两大部描述平台接口分两大部描述平台接口分两大部描述平台接口分两大部描述平台接口分两大部描述平台接口要求,第一局部:总体,第一局部:总体,第一局部:总体,第一局部:总体要求,总体要求描述消息的总体结构、接口访问方地址使用说明。第二局部:业务描述消息的总体结构、接口访问方地址使用说明。第二局部:业务描述消息的总体结构、接口访问方地址使用说明。第二局部:业务描述消息的总体结构、接口访问方地址使用说明。第二局部:业务描述消息的总体结构、接口访问方地址使用说明。第二局部:业务描述消息的总体结构、接口访问方地址使用说明。第二局部:业务接口要求,具体描述每个业务应用服接口的,具体描述每个业务应用服接口的要求。也就是每一个业务接口。也就是每一个业务接口要求套在总体要求内。只有使用业务接口内。只有使用业务接口内。只有使用业务接口内。只有使用业务接口要求+总体要求才能正常使用信息平台的应才能正常使用信息平台的应才能正常使用信息平台的应才能正常使用信息平台的应用效劳来发现,查询管理资源。本局部适用于参与公共信息平台设计和研发人员,系统维护及要求本局部适用于参与公共信息平台设计和研发人员,系统维护及要求本局部适用于参与公共信息平台设计和研发人员,系统维护及要求本局部适用于参与公共信息平台设计和研发人员,系统维护及要求本局部适用于参与公共信息平台设计和研发人员,系统维护及要求本局部适用于参与公共信息平台设计和研发人员,系统维护及要求本局部适用于参与公共信息平台设计和研发人员,系统维护及要求本局部适用于参与公共信息平台设计和研发人员,系统维护及要求本局部适用于参与公共信息平台设计和研发人员,系统维护及要求本局部适用于参与公共信息平台设计和研发人员,系统维护及要求本局部适用于参与公共信息平台设计和研发人员,系统维护及要求本局部适用于参与公共信息平台设计和研发人员,系统维护及要求本局部适用于参与公共信息平台设计和研发人员,系统维护及要求接入公共信息平台的外部应用开发人员。智慧城市公共信息平台-平台接口与效劳要求22标准性引用文件以下文件中的条款通过本局部引用而成为。但凡注日期以下文件中的条款通过本局部引用而成为。但凡注日期用文件,其随后用文件,其随后所有的修改单〔不包括勘误内容〕或订版均适用于本局部,所有的修改单〔不包括勘误内容〕或订版均适用于本局部,所有的修改单〔不包括勘误内容〕或订版均适用于本局部,鼓励根据本局部达成协议的各方研究是否可使用这些文件最新版。凡不注鼓励根据本局部达成协议的各方研究是否可使用这些文件最新版。凡不注日期的引用文件,其最新版本适于局部。GB/T21063.1-2007政务信息资源目录体系第1局部:总体框架;GB/T21063.2-2007政务信息资源目录体系第2局部:技术要求;GB/T21063.3-2007政务信息资源目录体系第3局部:核心元数据;GB/T21063.4GB/T21063.4-2007政务信息资源目录体系第4局部:政务信息资源分类;GB/T21063.5-2007政务信息资源目录体系第5局部:政务信息资源标识局部:政务信息资源标识符编码方案;本文<业务接口要求>引用《GB/T21063.2GB/T21063.2-2007》中的附录A目录效劳接口;本文<附录A要求所涉及的结构表所涉及的结构表所涉及的结构表所涉及的结构表>引用《引用《GB/T21063.2GB/T21063.2-2007》中的附》中的附》中的附录A目录效劳接口,及引用《目录效劳接口,及引用《目录效劳接口,及引用《GB/T21063.2GB/T21063.2-2007》中的附录》中的附录C政务信息资源目录效劳属性集本文<附录DQUERYDQUERY-RPN范例>引用《GB/T21063.2GB/T21063.2-2007》中的附录》中的附录F检索串例如9.智慧城市公共信息平台-平台接口与效劳要求33术语与定义GB/T19710-2005中规定的与以下术语和义适用于本局部。目录针对拥有共性的数据资源针对拥有共性的数据资源针对拥有共性的数据资源针对拥有共性的数据资源/文件资源进行分类,并且为该赋予唯一的文件资源进行分类,并且为该赋予唯一的文件资源进行分类,并且为该赋予唯一的文件资源进行分类,并且为该赋予唯一的文件资源进行分类,并且为该赋予唯一的文件资源进行分类,并且为该赋予唯一的文件资源进行分类,并且为该赋予唯一的源标识符,该局部类及描述的集合统称为资目录简。结构化资源公共信息平台享的二维库表结构数据,统称为化资源。非结构化资源公共信息平台享的非二维库表结构数据,例如:文本件、视频网络访公共信息平台享的非二维库表结构数据,例如:文本件、视频网络访公共信息平台享的非二维库表结构数据,例如:文本件、视频网络访公共信息平台享的非二维库表结构数据,例如:文本件、视频网络访公共信息平台享的非二维库表结构数据,例如:文本件、视频网络访问资源等统称为非结构化。数据交换管理者管理信息资源结点的机构。交换内容提供者提供信息资源交换内容的机构。交换内容使用者使用信息资源交换内容的机构。前置环境应用单位接入端系统软硬件及相关网络环境组成的前置元环境。目录交换按订阅模式进行目录资源数据的交换;桥接系统业务数据库与共享的桥接器,保持交换数据库与共享的同步数据库与共享的同步数据库与共享的同步数据库与共享的同步数据库与共享的同步数据库与共享的同步数据库与共享的同步数据库与共享的同步数据库与共享的同步数据库与共享的同步;变更捕捉捕捉数据资源变更情况。数据转入以固定间隔时轮询变更登记表,读取其中的录并将这些约以固定间隔时轮询变更登记表,读取其中的录并将这些约以固定间隔时轮询变更登记表,读取其中的录并将这些约格式组成XML报文,存储到共享库的换出表中;非结构化数据文件直接通过效劳传输至交换中心器,并有非结构化数据文件直接通过效劳传输至交换中心器,并有智慧城市公共信息平台-平台接口与效劳要求4分发非结构化数据文件。数据交换路由以固定时间隔轮询应用单位换入表,拆解以固定时间隔轮询应用单位换入表,拆解XML报文,根据目标库自动分拣报文,根据目标库自动分拣;非结构化数据文件直接通过效劳传输至交换中心器,并有非结构化数据文件直接通过效劳传输至交换中心器,并有分发非结构化数据文件。数据转出独立运行的进程,以固定间隔时轮询交换库中的入表,读取其以固定间隔时轮询交换库中的入表,读取其XML报文,并将数据按定制的格式同步到共享库中。非结构化数据文件描述信息存储在队列中,由各效劳器根分非结构化数据文件描述信息存储在队列中,由各效劳器根分别从中心文件效劳器获取所需数据。交换管理程序完成数据交换审批流程、监控调度系统管理数据交换审批流程、监控调度系统管理数据交换审批流程、监控调度系统管理数据交换审批流程、监控调度系统管理数据交换审批流程、监控调度系统管理数据交换审批流程、监控调度系统管理数据交换审批流程、监控调度系统管理数据交换审批流程、监控调度系统管理等功能一套等功能一套程序,部署于中心。Web效劳基于webservice技术开放的效劳接口,采用约定的效劳接口,采用约定的XML作为交易数据接口,提供给客户端调用。WSDLWeb效劳描述文件,一个用来描述一个用来描述Web效劳和说明如何与效劳和说明如何与Web效劳通信的效劳通信的XML语言。为用户提供详细的接口说明。访问认证公共信息平台提供用户认证效劳,由托管应系统的客端调于验公共信息平台提供用户认证效劳,由托管应系统的客端调于验公共信息平台提供用户认证效劳,由托管应系统的客端调于验用户是否合法;应用单位接入公共信息平台的机构单位。主管单位公共信息平台的管理单位。数据中心公共信息平台的组成局部,是公共信息平台数据及应用系统存储的地方。智慧城市公共信息平台-平台接口与效劳要求54接口效劳概述4.1接口效劳组成信息资源目录效劳包含三种接口,即信息资源根底效劳接口、资源效劳接口(发现接口、资源接口)、信息资源管理效劳接口。其中,根底接口是将资源效劳接口和管理接口中根底性的操作定义成一个公共接口。这3类接口实现了信息资源的发现功能、检索功能和管理功能。根底接口:提供会话管理功能和效劳自描述功能,包含有目录效劳初始化接口、目录效劳终止接口和效劳自描述接口。发现接口:提供信息资源元数据检索功能和信息资源元数据检索结果提取功能,包含有目录检索接口以及目录检索结果提取接口。这些接口本身并不提供资源,而是提供资源根本信息和如何去获得这些资源的元数据。资源接口:根据发现接口获得信息资源元数据,定位、查找资源具体内容的接口,包含资源内容检索接口及资源内容结果提取接口。管理接口:提供元数据管理的功能,包含信息资源元数据管理接口。城市公共信息平台接口效劳组成见图1.智慧城市公共信息平台根底接口效劳资源接口效劳管理接口效劳效劳初始化认证授权效劳终止发现效劳资源效劳资源元数据新增效劳资源元数据更新效劳资源元数据删除效劳资源目录检索资源目录结果提取资源内容检索资源内容结果提取图1.城市公共信息平台接口效劳组成图智慧城市公共信息平台-平台接口与效劳要求64.24.2接口技术要求接口技术要求接口技术要求接口技术要求接口技术要求a)提供基于SOAP协议的web效劳接口b)支持跨语言、操作系统调用智慧城市公共信息平台-平台接口与效劳要求75总体要求5.1消息结构每个交易消息每个交易消息(包括请求和应答包括请求和应答包括请求和应答包括请求和应答)有一个是名字〔有一个是名字〔有一个是名字〔有一个是名字〔MessageNameMessageName〕,交易消息〕,交易消息〕,交易消息以XML格式表达的,根据格式表达的,根据XML的定义,每个的定义,每个XML文件需要有特定的RootTagRootTag〔根标记〕,在本标记〕,在本标记〕,在本要求中,用交易名称中,用交易名称+请求类别作为根节点,如初始化接口的包请求类别作为根节点,如初始化接口的包根节点为initRequest,而响应包的根节点为,而响应包的根节点为initResponse。根节点下之间放业。根节点下之间放业务接口数据。5.1.1请求报文范例<initRequest><protocolVersion/><idAuthentication/><implementationId/><implementationName/><otherInfo/></initRequest>5.1.2响应报文范例<initResponse><referenceId></referenceId><protocolVersion></protocolVersion><pubKey></pubKey><result></result><otherInfo></otherInfo></initResponse>5.25.2接口方式接口采用WebService方式,接口协议使用SOAP协议,提供标准的WSDL文件。智慧城市公共信息平台-平台接口与效劳要求85.35.3接口地址公共信息目录效劳〔以下简称〕主要有三个公共信息目录效劳〔以下简称〕主要有三个公共信息目录效劳〔以下简称〕主要有三个wsdl地址,不同的地址,不同的wsdl下有不同的方法,文说明。这是根据webservice的soap协议开放出来的协议开放出来的wsdl地址,第三方应用可以根据实际的部署效劳器来使它。1)根底接口WSDL文件地址:://<ip地址>:<端口>/es/catalogbase?wsdl目录效劳初始化–initCatalogService目录效劳终止–stopCatalogService2)发现接口WSDL文件地址:://<ip地址>:<端口>/es/digcatalog?wsdl目录检索–queryCatalogList目录检索结果提取–queryCatalogResult3)资源效劳接口:://<ip地址>:<端口>/es/digresource?wsdl资源检索–getResourceResultset资源检索结果提取–getResourceResultDetail4)发现接口WSDL文件地址:://<ip地址>:<端口>/es/digcatalog?wsdl资源元数据管理–metadataManage5.45.4使用说明完成资源的检索与发现需要根据以下步骤来操作:1)第一步:初始化操作。调用根底接口的“目录效劳初始化”获得一个会话标识符以后每次调用接口都需要次标识符。2)第二步:查询公共信息目录操作。调用发现接口的“目录检索”组织好查询参数,发起交易,获得查询结果。注:这里的查询结果只有返回命中的查询记录数。比方:返回值是100,那么表示有100条记录符合查询条件,这个时候需要发起“公共信息目录检索结果提取”交易才能提取智慧城市公共信息平台-平台接口与效劳要求9查询的结果。如果发回值是0,表示没有符合查询条件的记录。3)第三步:查询公共信息目录对应的资源。这里的操作也是和上面一样,调用“资源检索”先要查询下是否有符合查询条件的资源。有资源记录的话,然后在调用“资源检索结果提取”提取符合条件的资源信息。4)第四步:假设调用接口结束后,可调用根底接口里的“目录效劳终止”来释放会话标识符资源信息。智慧城市公共信息平台-平台接口与效劳要求106业务接口要求6.16.1根底接口要求6.1.1目录效劳初始化公共信息目录效劳初始化用于建立客户端与效劳端的会话,所有其他效劳都必须依赖会话。会话的持续时间为30分钟,假设会话持续30分钟没有活动,那么会话自动终止。本次初始化作用是客户端认证同时获取会话标识符,后续发起交易时需要传递该会话标识符。1.请求报文体序号元素名称元素名称约束类型长度描述取值说明取值说明1.protocolVersionprotocolVersionprotocolVersionprotocolVersionprotocolVersionprotocolVersionprotocolVersionprotocolVersionprotocolVersionprotocolVersionprotocolVersionprotocolVersion可选StringStringStringStringString50客户端协议版本号客户端协议实现的客户端协议实现的客户端协议实现的客户端协议实现的客户端协议实现的客户端协议实现的客户端协议实现的客户端协议实现的版本号2.idAuthenticationidAuthenticationidAuthenticationidAuthenticationidAuthenticationidAuthenticationidAuthenticationidAuthenticationidAuthentication必选StringStringStringStringString50用户名用户名用户名/密码认证信息。包含用户认证信息。包含用户认证信息。包含用户认证信息。包含用户认证信息。包含用户认证信息。包含用户身份标识及其密码。身份标识及其密码。身份标识及其密码。身份标识及其密码。身份标识及其密码。格式“格式“<用户名用户名>/<密码>”3.implementationIdimplementationIdimplementationIdimplementationIdimplementationIdimplementationIdimplementationIdimplementationIdimplementationId可选StringStringStringStringString50应用标识应用标识在公共信息平台用在公共信息平台用在公共信息平台用在公共信息平台用在公共信息平台用在公共信息平台用在公共信息平台用在公共信息平台用户体系中注册的第户体系中注册的第户体系中注册的第户体系中注册的第户体系中注册的第户体系中注册的第户体系中注册的第户体系中注册的第三方应用编号三方应用编号三方应用编号4.implementationNameimplementationNameimplementationNameimplementationNameimplementationNameimplementationNameimplementationNameimplementationNameimplementationName可选StringStringStringStringString200200200应用名称应用名称在公共信息平台用在公共信息平台用在公共信息平台用在公共信息平台用在公共信息平台用在公共信息平台用在公共信息平台用在公共信息平台用户管系统中注册的户管系统中注册的户管系统中注册的户管系统中注册的户管系统中注册的户管系统中注册的户管系统中注册的户管系统中注册的第三方应用名称第三方应用名称第三方应用名称5.otherInfootherInfootherInfootherInfootherInfootherInfo可选elementelement其他信息其他信息备用2.请求报文体模板<initRequest><protocolVersion>V1.0</protocolVersion><idAuthentication>testApp/12456</idAuthentication><implementationId>1</implementationId><implementationName>测试应用</implementationName><otherInfo/></initRequest>3.响应报文体智慧城市公共信息平台-平台接口与效劳要求11序号元素名称元素名称约束类型长度描述取值说明取值说明1.referenceIdreferenceIdreferenceIdreferenceIdreferenceId必选StringStringStringStringString50会话标识会话标识当验证成功时返回,否当验证成功时返回,否当验证成功时返回,否当验证成功时返回,否当验证成功时返回,否那么设置为空那么设置为空2.protocolVersionprotocolVersionprotocolVersionprotocolVersionprotocolVersionprotocolVersionprotocolVersionprotocolVersionprotocolVersionprotocolVersionprotocolVersionprotocolVersion必选StringStringStringStringString50效劳端协议版本号效劳端协议实现的版本效劳端协议实现的版本效劳端协议实现的版本效劳端协议实现的版本效劳端协议实现的版本效劳端协议实现的版本效劳端协议实现的版本效劳端协议实现的版本效劳端协议实现的版本效劳端协议实现的版本号3.resultresultresult必选BooleanBoolean处理结果处理结果效劳器端用该参数说明效劳器端用该参数说明效劳器端用该参数说明效劳器端用该参数说明效劳器端用该参数说明效劳器端用该参数说明效劳器端用该参数说明效劳器端用该参数说明效劳器端用该参数说明效劳器端用该参数说明是否接受建立会话的请是否接受建立会话的请是否接受建立会话的请是否接受建立会话的请是否接受建立会话的请是否接受建立会话的请是否接受建立会话的请是否接受建立会话的请是否接受建立会话的请是否接受建立会话的请求。truetruetrue表示建立会话成功,falsefalsefalsefalse表示建立会表示建立会话失败,此时话失败,此时话失败,此时话失败,此时referenceIdreferenceIdreferenceIdreferenceIdreferenceIdreferenceId为空。4.pubKeypubKeypubKeypubKey必选StringStringStringStringString64加解密公钥加解密公钥5.otherInfootherInfootherInfootherInfootherInfootherInfo可选elementelement其他信息其他信息备用4.响应报文体模板<initResponse><referenceId>cde2db52-8cee-45f4-9cec-f8a68ebbad5c</referenceId><protocolVersion>V1.0</protocolVersion><pubKey>catalog</pubKey><result>true</result><otherInfo>初始化效劳成功</otherInfo></initResponse>6.1.2目录效劳终止公共信息目录效劳终止将结束效劳端与客户端的会话,与会话相关的资源将被释放。1.请求报文体序号元素名称元素名称约束类型长度描述取值说明取值说明1.referenceIdreferenceIdreferenceIdreferenceIdreferenceId必选StringStringStringStringString50会话标识会话标识要终止的会话编号要终止的会话编号要终止的会话编号要终止的会话编号2.closeReasoncloseReasoncloseReasoncloseReasoncloseReasoncloseReasoncloseReason可选StringStringStringStringString50终止原因终止原因3.otherInfootherInfootherInfootherInfootherInfootherInfo可选elementelement其他信息其他信息备用2.求报文体模板<initRequest><referenceId>cde2db52-8cee-45f4-9cec-f8a68ebbad5c</referenceId>智慧城市公共信息平台-平台接口与效劳要求12<closeReason>终止使用</closeReason><otherInfo/></initRequest>6.1.3认证授权认证授权主要是公钥获取接口效劳,用于根据客户端应用的请求,取出最新的加解密公钥并返回给客户端的过程。公钥获取与其他接口不同,不需要用户验证,不需要会话标识。调用客户端只有获取公钥后对用户认证信息进行加密才能完成其效劳调用。整个密码加解密的处理过程如以下图所示:图2..密码加解密的处理过程图1.请求报文体序号元素名称元素名称约束类型长度描述取值说明取值说明1.otherInfootherInfootherInfootherInfootherInfootherInfo可选elementelement其他信息备用2.请求报文体模板智慧城市公共信息平台-平台接口与效劳要求13<pubKeyRequest><otherInfo></otherInfo></pubKeyRequest>3.响应报文体序号元素名称元素名称约束类型长度描述取值说明取值说明1.pubKeypubKeypubKeypubKey必选StringStringStringStringString8公钥用于加解密码的密钥2.opResultopResultopResultopResult必选elementelement操作结果参见《表参见《表参见《表参见《表A.6A.6A.6opResultopResultopResultopResult属性表》之属性表》之属性表》之说明3.otherInfootherInfootherInfootherInfootherInfootherInfo可选elementelement其他信息备用4.响应报文体模板<pubKeyResponse><pubkey>catalog</pubkey><opResult><opStatus>true</opStatus><opRetCode>code</opRetCode><opRetMsg>message</opRetMsg></opResult><otherInfo></otherInfo></pubKeyResponse>6.26.2发现接口要求6.2.1资源目录检索公共信息目录检索是效劳端根据客户端指定的检索条件,在效劳器端从元数据库中检索并标识出匹配的元数据记录,并将元数据记录保存在结果集中的过程。结果集的保存时间与会话标识一致,当会话结束后,响应的结果集将被同步删除。智慧城市公共信息平台-平台接口与效劳要求141.请求报文体序号元素名称元素名称约束类型长度描述取值说明取值说明1.referenceIdreferenceIdreferenceIdreferenceIdreferenceId必选StringStringStringStringString50会话标识会话标识2.replaceIndicatoreplaceIndicatoreplaceIndicatoreplaceIndicatoreplaceIndicatoreplaceIndicatoreplaceIndicatoreplaceIndicator必选BooleanBoolean结果集覆盖结果集覆盖结果集覆盖结果集覆盖结果集覆盖标志truetruetrue表示覆盖原来的查表示覆盖原来的查表示覆盖原来的查表示覆盖原来的查表示覆盖原来的查表示覆盖原来的查表示覆盖原来的查表示覆盖原来的查询结果,询结果,falsefalsefalsefalse表示保存表示保存原来的查询结果原来的查询结果原来的查询结果3.resultSetIDresultSetIDresultSetIDresultSetIDresultSetIDresultSetID必选StringStringStringStringString200200200指定的查询指定的查询指定的查询指定的查询指定的查询结果集名称结果集名称假设存在同名的结果集,假设存在同名的结果集,假设存在同名的结果集,假设存在同名的结果集,假设存在同名的结果集,需要根据需要根据replaceIndicatorreplaceIndicatorreplaceIndicatorreplaceIndicatorreplaceIndicatorreplaceIndicatorreplaceIndicatorreplaceIndicatorreplaceIndicator判断是判断是否需要覆盖结果集。否需要覆盖结果集。否需要覆盖结果集。否需要覆盖结果集。4.databaseNamedatabaseNamedatabaseNamedatabaseNamedatabaseNamedatabaseNamedatabaseNames必选ElementElementElement要查询的元要查询的元要查询的元要查询的元要查询的元数据库名称数据库名称数据库名称数据库名称数据库名称列表客户端指定的要查询元数据库名称列表元数据库名称列表元数据库名称列表元数据库名称列表5.queryqueryquery必选ElementElementElement客户端定制客户端定制客户端定制客户端定制客户端定制的检索语句的检索语句检索语句必须符合检索语句必须符合检索语句必须符合检索语句必须符合TypeType-1型,使用逆波兰型,使用逆波兰型,使用逆波兰型,使用逆波兰表达式(RPN)(RPN)(RPN)作为检索语作为检索语作为检索语法,参见《附录法,参见《附录法,参见《附录法,参见《附录EQUERYQUERYQUERY-RPNRPN范例》范例》6.preferredRecorpreferredRecorpreferredRecorpreferredRecorpreferredRecorpreferredRecorpreferredRecorpreferredRecorpreferredRecordSyntaxdSyntaxdSyntaxdSyntaxdSyntax可选StringStringStringStringString10检索结果的检索结果的检索结果的检索结果的检索结果的编码方式编码方式固定取值固定取值:”XML”:”XML”:”XML”:”XML”:”XML”7.otherInfootherInfootherInfootherInfootherInfootherInfo可选ElementElementElement其他信息其他信息备用2.请求报文体模板<searchRequest><referenceId>f4973365-a9be-4f80-b5d8-a8b9c7949185</referenceId><replaceIndicator>true</replaceIndicator><resultSetID>highResult</resultSetID><databaseNames>BMDB</databaseNames><preferredRecordSyntax>XML</preferredRecordSyntax><query>根据国标的逆波兰表达式(RPN)组合的查询条件…具体规那么参考《附录EQUERYEQUERYEQUERYEQUERY-RPNRPN范例》范例》</query></searchRequest>3.响应报文体序号元素名称元素名称约束类型长度描述取值说明取值说明1.referenceIdreferenceIdreferenceIdreferenceIdreferenceId必选StringStringStringStringString50会话标识会话标识智慧城市公共信息平台-平台接口与效劳要求152.resultCountresultCountresultCountresultCountresultCountresultCount必选NumberStringNumberStringNumberStringNumberStringNumberStringNumberStringNumberStringNumberString20符合条件符合条件符合条件符合条件的记录数的记录数效劳器端执行检索操作得效劳器端执行检索操作得效劳器端执行检索操作得效劳器端执行检索操作得效劳器端执行检索操作得到的命中记录数,检索失败到的命中记录数,检索失败到的命中记录数,检索失败到的命中记录数,检索失败到的命中记录数,检索失败到的命中记录数,检索失败到的命中记录数,检索失败设置为设置为03.searchStatussearchStatussearchStatussearchStatussearchStatussearchStatussearchStatussearchStatus必选StringStringStringStringString7执行检索执行检索执行检索执行检索的执行结的执行结的执行结的执行结果返回的检索状态信息,返回的检索状态信息,返回的检索状态信息,返回的检索状态信息,返回的检索状态信息,successsuccesssuccesssuccess表示检索成功,表示检索成功,表示检索成功,failturefailturefailturefailturefailture表示检索失败表示检索失败表示检索失败表示检索失败4.otherInfootherInfootherInfootherInfootherInfootherInfo可选elementelement其他信息其他信息备用4.响应报文体模板<searchResponse><referenceId>3720b175-7db7-408d-90cd-108e1f2ec887</referenceId><resultCount>9</resultCount><searchStatus>success</searchStatus><otherInfo></otherInfo></searchResponse>6.2.2资源目录检索结果提取目录检索结果由效劳器端从结果集中提取并返回假设干数据记录给客户端。1.请求报文体序号元素名称元素名称约束类型长度描述取值说明取值说明1.referenceIdreferenceIdreferenceIdreferenceIdreferenceId必选StringStringStringStringString50会话标识会话标识2.resultSetIDresultSetIDresultSetIDresultSetIDresultSetIDresultSetID必选StringStringStringStringString要抽取的要抽取的要抽取的要抽取的结果集的结果集的结果集的结果集的标识因为系统允许在抽取数据因为系统允许在抽取数据因为系统允许在抽取数据因为系统允许在抽取数据因为系统允许在抽取数据因为系统允许在抽取数据因为系统允许在抽取数据前进行屡次检索,每前进行屡次检索,每前进行屡次检索,每前进行屡次检索,每前进行屡次检索,每前进行屡次检索,每前进行屡次检索,每索都可以指定不同的结果索都可以指定不同的结果索都可以指定不同的结果索都可以指定不同的结果索都可以指定不同的结果索都可以指定不同的结果索都可以指定不同的结果集名称,所以客户端必须集名称,所以客户端必须集名称,所以客户端必须集名称,所以客户端必须集名称,所以客户端必须集名称,所以客户端必须集名称,所以客户端必须指定要抽取的数据结果集指定要抽取的数据结果集指定要抽取的数据结果集指定要抽取的数据结果集指定要抽取的数据结果集指定要抽取的数据结果集指定要抽取的数据结果集标识3.resultSetStartPresultSetStartPresultSetStartPresultSetStartPresultSetStartPresultSetStartPresultSetStartPresultSetStartPresultSetStartPointointoint必选NumberStringNumberStringNumberStringNumberStringNumberStringNumberStringNumberStringNumberString20开始抽取开始抽取开始抽取开始抽取的位置客户端指定的从第几条记客户端指定的从第几条记客户端指定的从第几条记客户端指定的从第几条记客户端指定的从第几条记客户端指定的从第几条记客户端指定的从第几条记录开始抽取,序号从录开始抽取,序号从录开始抽取,序号从录开始抽取,序号从1开始4.numberOfReconumberOfReconumberOfReconumberOfReconumberOfReconumberOfReconumberOfRecordsResquestedrdsResquestedrdsResquestedrdsResquestedrdsResquestedrdsResquestedrdsResquested必选NumberStringNumberStringNumberStringNumberStringNumberStringNumberStringNumberStringNumberString20记录数客户端指定的要抽取记客户端指定的要抽取记客户端指定的要抽取记客户端指定的要抽取记客户端指定的要抽取记客户端指定的要抽取记客户端指定的要抽取记录数5.elementSetNaelementSetNaelementSetNaelementSetNaelementSetName必选elementelement结果集属结果集属结果集属结果集属性参见表《参见表《A.3A.3elementSetNameelementSetNameelementSetNameelementSetNameelementSetNameelementSetNameelementSetName结果集属性》集属性》智慧城市公共信息平台-平台接口与效劳要求166.preferredRecorpreferredRecorpreferredRecorpreferredRecorpreferredRecorpreferredRecorpreferredRecorpreferredRecorpreferredRecordSyntaxdSyntaxdSyntaxdSyntaxdSyntax可选StringStringStringStringString10提取结果提取结果提取结果提取结果的编码方的编码方的编码方的编码方式固定取值固定取值:”XML”:”XML”:”XML”:”XML”:”XML”7.otherInfootherInfootherInfootherInfootherInfootherInfo可选elementelement其他信息其他信息备用2.请求报文体模板<presentRequest><referenceId>f4973365-a9be-4f80-b5d8-a8b9c7949185</referenceId><resultSetID>highResult</resultSetID><resultSetStartPoint>0</resultSetStartPoint><numberOfRecordsResquested>30</numberOfRecordsResquested><elementSetName><genericElementSetName>brief</genericElementSetName></elementSetName><preferredRecordSyntax>XML</preferredRecordSyntax></presentRequest>3.响应报文体序号元素名称元素名称约束类型长度描述取值说明取值说明1.referenceIdreferenceIdreferenceIdreferenceIdreferenceId必选StringStringStringStringString50会话标识会话标识2.numberOfRecordnumberOfRecordnumberOfRecordnumberOfRecordnumberOfRecordnumberOfRecordnumberOfRecordnumberOfRecordnumberOfRecordsReturnedsReturnedsReturnedsReturned必选NumberStringNumberStringNumberStringNumberStringNumberStringNumberStringNumberStringNumberString20元数据元数据元数据元数据目效劳器端返回的元数效劳器端返回的元数效劳器端返回的元数效劳器端返回的元数据数目3.presentStatuspresentStatuspresentStatuspresentStatuspresentStatuspresentStatuspresentStatuspresentStatus必选StringStringStringStringString7提取状态提取状态效劳器端返回的提取效劳器端返回的提取效劳器端返回的提取效劳器端返回的提取状态。successsuccesssuccesssuccess表示提表示提取成功,取成功,failturefailturefailturefailturefailture表示提表示提取失败4.recordsrecordsrecordsrecordsrecords必选elementelement结果集效劳器返回的结果集效劳器返回的结果集效劳器返回的结果集效劳器返回的结果集,包含一个或多包含一个或多包含一个或多singleRecordsingleRecordsingleRecordsingleRecordsingleRecordsingleRecordsingleRecordsingleRecord,详细描述,详细描述,详细描述,详细描述参见《表参见《表A.5singleRecordsingleRecordsingleRecordsingleRecordsingleRecordsingleRecordsingleRecordsingleRecord参数表》参数表》参数表》5.otherInfootherInfootherInfootherInfootherInfootherInfo可选elementelement其他信息其他信息备用4.响应报文体模板<presentResponse><referenceId>f4973365-a9be-4f80-b5d8-a8b9c7949185</referenceId><numberOfRecordsReturned>9</numberOfRecordsReturned><presentStatus>success</presentStatus><records>结构化资源目录结构化资源目录结构化资源目录结构化资源目录/非结构化资源目录非结构化资源目录非结构化资源目录非结构化资源目录</records><otherInfo></otherInfo>智慧城市公共信息平台-平台接口与效劳要求17</presentResponse>6.36.3资源效劳接口资源效劳接口资源效劳接口资源效劳接口资源效劳接口要求6.3.1资源内容检索资源检索是公共信息平台效劳端根据客户端发送的请求信息,从共享数据库中读取符合条件的记录,并将查询结果集相关返回的过程。注意,资源检索功能并不返回具体的结果集,结果集返回功能将由”资源检索结果提取”效劳提供。结果集的保存时间与会话标识一致,当会话结束后,响应的结果集将被同步删除。1.请求报文体序号元素名称元素名称约束类型长度描述取值说明取值说明1.referenceIdreferenceIdreferenceIdreferenceIdreferenceId必选StringStringStringStringString50会话标识会话标识2.resIdresIdresId必选StringStringStringStringString50资源标识符资源标识符6位字母位字母/数字加数字加”/”加1到23位数字位数字3.replaceIndicatorreplaceIndicatorreplaceIndicatorreplaceIndicatorreplaceIndicatorreplaceIndicatorreplaceIndicatorreplaceIndicatorreplaceIndicator必选BooleanBoolean结果集覆盖结果集覆盖结果集覆盖结果集覆盖标志truetruetrue表示覆盖原来的查询表示覆盖原来的查询表示覆盖原来的查询表示覆盖原来的查询表示覆盖原来的查询结果,falsefalsefalsefalse表示保存原来表示保存原来表示保存原来表示保存原来的查询结果的查询结果4.resultSetIDresultSetIDresultSetIDresultSetIDresultSetIDresultSetID必选StringStringStringStringString200200200指定的查询指定的查询指定的查询指定的查询结果集名称结果集名称假设存在同名的结果集,需假设存在同名的结果集,需假设存在同名的结果集,需假设存在同名的结果集,需假设存在同名的结果集,需假设存在同名的结果集,需假设存在同名的结果集,需要根据要根据replaceIndicatorreplaceIndicatorreplaceIndicatorreplaceIndicatorreplaceIndicatorreplaceIndicatorreplaceIndicatorreplaceIndicatorreplaceIndicator判断是否需要覆盖结果集。断是否需要覆盖结果集。断是否需要覆盖结果集。断是否需要覆盖结果集。断是否需要覆盖结果集。5.dataQuerydataQuerydataQuerydataQuerydataQuery必选elementelement客户端定制客户端定制客户端定制客户端定制的检索条件的检索条件参见《附录参见《附录参见《附录CQUERYQUERYQUERY-RESRES-DATADATADATADATA说明》说明》–dataQuerydataQuerydataQuerydataQuerydataQuery属性说明属性说明属性说明6.preferredRecordpreferredRecordpreferredRecordpreferredRecordpreferredRecordpreferredRecordpreferredRecordpreferredRecordpreferredRecordpreferredRecordSyntaxSyntaxSyntaxSyntaxSyntax可选StringStringStringStringString10检索结果的检索结果的检索结果的检索结果的编码方式编码方式固定取值固定取值:”XML”:”XML”:”XML”:”XML”:”XML”7.otherInfootherInfootherInfootherInfootherInfootherInfo可选elementelement其他信息其他信息备用2.请求报文体模板<dataSearchRequest><referenceId>d8137d81-ef76-4dc5-80c7-01dc493f9d3f</referenceId><resId>GXWgxwAA000</resId><resultSetID>GXWgxwAA000</resultSetID><replaceIndicator>true</replaceIndicator>智慧城市公共信息平台-平台接口与效劳要求18<preferredRecordSyntax>XML</preferredRecordSyntax><dataQuery>取值参考dataQuery属性说明</dataQuery></dataSearchRequest>3.响应报文体序号元素名称元素名称约束类型长度描述取值说明取值说明1.referenceIdreferenceIdreferenceIdreferenceIdreferenceId必选StringStringStringStringString50会话标会话标会话标识2.resultCountresultCountresultCountresultCountresultCountresultCount必选NumberStringNumberStringNumberStringNumberStringNumberStringNumberStringNumberStringNumberString20符合条符合条符合条件的记件的记件的记录数效劳器端执行检索操效劳器端执行检索操效劳器端执行检索操效劳器端执行检索操作得到的命中记录作得到的命中记录作得到的命中记录作得到的命中记录数,检索失败设置为数,检索失败设置为数,检索失败设置为数,检索失败设置为03.searchStatussearchStatussearchStatussearchStatussearchStatussearchStatussearchStatussearchStatus必选StringStringStringStringString7执行检执行检执行检索的执索的执索的执行结果返回的检索状态信返回的检索状态信返回的检索状态信返回的检索状态信息,successsuccesssuccesssuccess表示检索表示检索成功,failturefailturefailturefailturefailture表示检表示检索失败4.opResultopResultopResultopResult可选elementelement操作信操作信操作信息详情参见附录详情参见附录详情参见附录详情参见附录详情参见附录详情参见附录表A.4-opResultopResultopResultopResult属性表属性表5.otherInfootherInfootherInfootherInfootherInfootherInfo可选elementelement其他信其他信其他信息备用4.响应报文体模板<dataSearchResponse><referenceId>d8137d81-ef76-4dc5-80c7-01dc493f9d3f</referenceId><resultCount>0</resultCount><searchStatus>failure</searchStatus><opResult><opStatus>failure</opStatus><opRetCode>错误代码</opRetCode><opRetMsg>错误信息</opRetMsg></opResult><otherInfo></otherInfo></dataSearchResponse>6.3.2资源内容检索结果提取资源检索结果提取用于从<资源检索>所得的结果集中提取指定的结果。1.请求报文体智慧城市公共信息平台-平台接口与效劳要求19序号元素名称元素名称约束类型长度描述取值说明取值说明1.referenceIdreferenceIdreferenceIdreferenceIdreferenceId必选StringStringStringStringString50会话标识会话标识2.resultSetIDresultSetIDresultSetIDresultSetIDresultSetIDresultSetID必选StringStringStringStringString要抽取的要抽取的要抽取的要抽取的结果集的结果集的结果集的结果集的标识因为系统允许在抽因为系统允许在抽因为系统允许在抽因为系统允许在抽因为系统允许在抽因为系统允许在抽因为系统允许在抽因为系统允许在抽取数据前进行屡次取数据前进行屡次取数据前进行屡次取数据前进行屡次取数据前进行屡次取数据前进行屡次取数据前进行屡次取数据前进行屡次检索,每次都检索,每次都检索,每次都检索,每次都检索,每次都检索,每次都检索,每次都检索,每次都可以指定不同的结可以指定不同的结可以指定不同的结可以指定不同的结可以指定不同的结可以指定不同的结可以指定不同的结可以指定不同的结果集名称,所以客果集名称,所以客果集名称,所以客果集名称,所以客果集名称,所以客果集名称,所以客果集名称,所以客果集名称,所以客户端必须指定要抽户端必须指定要抽户端必须指定要抽户端必须指定要抽户端必须指定要抽户端必须指定要抽户端必须指定要抽户端必须指定要抽取的数据结果集标取的数据结果集标取的数据结果集标取的数据结果集标取的数据结果集标取的数据结果集标取的数据结果集标取的数据结果集标识3.resultSetStartPointresultSetStartPointresultSetStartPointresultSetStartPointresultSetStartPointresultSetStartPointresultSetStartPointresultSetStartPointresultSetStartPointresultSetStartPointresultSetStartPointresultSetStartPoint必选NumberStringNumberStringNumberStringNumberStringNumberStringNumberStringNumberStringNumberString20开始抽取开始抽取开始抽取开始抽取的位置客户端指定的从第客户端指定的从第客户端指定的从第客户端指定的从第客户端指定的从第客户端指定的从第客户端指定的从第客户端指定的从第几条记录开始抽几条记录开始抽几条记录开始抽几条记录开始抽几条记录开始抽几条记录开始抽几条记录开始抽取,序号从取,序号从取,序号从1开始4.numberOfRecordsRenumberOfRecordsRenumberOfRecordsRenumberOfRecordsRenumberOfRecordsRenumberOfRecordsRenumberOfRecordsRenumberOfRecordsRenumberOfRecordsRenumberOfRecordsRenumberOfRecordsResquestedsquestedsquestedsquestedsquested必选NumberStringNumberStringNumberStringNumberStringNumberStringNumberStringNumberStringNumberString20记录数客户端指定的要抽客户端指定的要抽客户端指定的要抽客户端指定的要抽客户端指定的要抽客户端指定的要抽客户端指定的要抽客户端指定的要抽取的记录数取的记录数5.numberOfRecordsTonumberOfRecordsTonumberOfRecordsTonumberOfRecordsTonumberOfRecordsTonumberOfRecordsTonumberOfRecordsTonumberOfRecordsTonumberOfRecordsTonumberOfRecordsTonumberOfRecordsTotaltal必选NumberStringNumberStringNumberStringNumberStringNumberStringNumberStringNumberStringNumberString20符合条件符合条件符合条件符合条件的总共命的总共命的总共命的总共命中记录数中记录数资源检索接口查询资源检索接口查询资源检索接口查询资源检索接口查询资源检索接口查询资源检索接口查询资源检索接口查询资源检索接口查询得到的总共命中记得到的总共命中记得到的总共命中记得到的总共命中记得到的总共命中记得到的总共命中记得到的总共命中记得到的总共命中记录数。6.preferredRecordSyntpreferredRecordSyntpreferredRecordSyntpreferredRecordSyntpreferredRecordSyntpreferredRecordSyntpreferredRecordSyntpreferredRecordSyntpreferredRecordSyntpreferredRecordSyntpreferredRecordSyntpreferredRecordSyntax可选StringStringStringStringString10提取结果提取结果提取结果提取结果的编码方的编码方的编码方的编码方式固定取值固定取值:”XML”:”XML”:”XML”:”XML”:”XML”7.otherInfootherInfootherInfootherInfootherInfootherInfo可选elementelement其他信息其他信息备用2.请求报文体模板<dataPresentRequest><referenceId>2190bf83-a934-4f4d-995c-f688dc4808ae</referenceId><resultSetID>JTJQD/JTJ00000</resultSetID><resultSetStartPoint>1</resultSetStartPoint><numberOfRecordsResquested>30</numberOfRecordsResquested><numberOfRecordsTotal>3</numberOfRecordsTotal><preferredRecordSyntax>XML</preferredRecordSyntax></dataPresentRequest>3.响应报文体序号元素名称元素名称约束类型长度描述取值说明取值说明1.referenceIdreferenceIdreferenceIdreferenceIdreferenceId必选StringStringStringStringString50会话标识会话标识2.numberOfReconumberOfReconumberOfReconumberOfReconumberOfReconumberOfReconumberOfRecordsReturnedrdsReturnedrdsReturnedrdsReturnedrdsReturnedrdsReturnedrdsReturned必选NumberStringNumberStringNumberStringNumberStringNumberStringNumberStringNumberStringNumberString20元数据元数据元数据元数据目效劳器端返回的元数据效劳器端返回的元数据效劳器端返回的元数据效劳器端返回的元数据效劳器端返回的元数据目智慧城市公共信息平台-平台接口与效劳要求203.presentStatuspresentStatuspresentStatuspresentStatuspresentStatuspresentStatuspresentStatuspresentStatus必选StringStringStringStringString7提取状态提取状态效劳器端返回的提取状效劳器端返回的提取状效劳器端返回的提取状效劳器端返回的提取状效劳器端返回的提取状态。successsuccesssuccesssuccess表示提取成表示提取成表示提取成功,failturefailturefailturefailturefailture表示提取失败表示提取失败表示提取失败表示提取失败4.resTyperesTyperesType必选StringStringStringStringString50资源种类资源种类结构化资源或非结构化资源或非结构化资源或非结构化资源或非结构化资源或非源,不同的资种类对应源,不同的资种类对应源,不同的资种类对应源,不同的资种类对应源,不同的资种类对应的singleRecordsingleRecordsingleRecordsingleRecordsingleRecordsingleRecordsingleRecordsingleRecord中ItemItem项不同5.recordsrecordsrecordsrecordsrecords必选elementelement结果集效劳器返回的结果集效劳器返回的结果集效劳器返回的结果集效劳器返回的结果集,包含一个或多含一个或多含一个或多singleRecordsingleRecordsingleRecordsingleRecordsingleRecordsingleRecordsingleRecordsingleRecord,详细描述参,详细描述参,详细描述参,详细描述参见《B.2B.2资源检索结果提取资源检索结果提取资源检索结果提取资源检索结果提取资源检索结果提取结构》6.otherInfootherInfootherInfootherInfootherInfootherInfo可选elementelement其他信息其他信息备用4.响应报文体模板<dataPresentResponse><referenceId>687d0aed-6e43-44eb-9d0e-e25eeca83470</referenceId><numberOfRecordsReturned>3</numberOfRecordsReturned><presentStatus>s</presentStatus><resType>结构化资源</resType><records><singleRecord>….</singleRecord>(具体结构参照)</records><otherInfo></otherInfo></dataPresentResponse>6.46.4管理接口要求6.4.1目录资源元数据管理目录资源元数据管理接口包含元数据的新增、删除和更新操作,根据不同的操作类型来完成相应的动作,且元数据管理接口一次只操作一种操作类型的一条元数据记录。当操作类型为更新时其操作对象为通过“目录检索结果提取”接口返回的元数据,元数据元素必须符合《核心元数据属性集》要求;当操作类型为删除时,其操作对象为通过“目录检索结果提取”接口返回的元数据中的特定一条记录;智慧城

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

最新文档

评论

0/150

提交评论