DB11 T 553.5-2008 政务信息资源共享交换平台技术规范 第5部分：接口规范.pdf

《DB11 T 553.5-2008 政务信息资源共享交换平台技术规范 第5部分：接口规范.pdf》由会员分享，可在线阅读，更多相关《DB11 T 553.5-2008 政务信息资源共享交换平台技术规范 第5部分：接口规范.pdf（28页珍藏版）》请在麦多课文档分享上搜索。

1、 政务信息资源共享交换平台技术规范 第5部分：接口规范 Technical specification for government information resource sharing and interchange platform Part 5: Interface specification 北京市地方标准 ICS 01.040.35 L 72 备案号 xx-xxxx 2008-05-28发布 2008-07-01实施 北京市质量技术监督局 发布 DBDB11/T 553.52008 DB11/T 553.52008 I 目 次 前言.II 1 范围.1 2 规范性引用文件.错误！

2、未定义书签。 3 概述.1 4 政务信息资源目录服务接口.1 5政务信息资源交换服务接口.5 6认证授权服务接口.10 附录A（规范性附录）政务信息资源目录服务接口XML Schema描述.11 附录B（规范性附录）政务信息资源交换服务接口XML Schema描述.18 DB11/T 553.52008 II 前 言 DB11/T 553政务信息资源共享交换平台技术规范，分为5个部分： 第1部分：总体框架； 第2部分：政务信息资源目录管理； 第3部分：政务信息资源交换管理； 第4部分：认证授权； 第5部分：接口规范。 本部分为DB11/T 553的第5部分。 本标准的附录A、附录B为规范性附录

3、。 本部分由北京市信息化工作办公室提出并归口。 本部分的起草单位：北京市信息资源管理中心、中科软科技股份有限公司、北京数贝软件科技有限公司。 本部分主要起草人：黄晓斌、林绍福、冯启民、程军、郭家义、崔建新、赵琰昉、李海蛟、李清、徐伟、李中、韩霖。 DB11/T 553.52008 1 政务信息资源共享交换平台技术规范 第5部分：接口规范 1 范围 本部分规定了政务信息资源共享交换平台的接口规范，包括政务信息资源目录服务接口、政务信息资源交换服务接口和认证授权服务接口。 本部分适用于政务信息资源共享交换平台建设的规划、设计和实施。 2 概述 2.1 接口组成 政务信息资源共享交换平台提供政务信息

4、资源目录服务接口、政务信息资源交换服务接口和认证授权服务接口等三类接口。政务信息资源共享交换平台接口组成见图1。 图1 政务信息资源共享交换平台接口组成 2.2 接口技术要求 a） 应至少提供JMS和Web服务接口； b） 应支持跨语言、跨操作系统调用。 3 政务信息资源目录服务接口 3.1 目录检索接口 3.1.1 用户目录检索接口 根据指定的检索条件和用户访问权限对政务信息资源目录数据进行查询，并返回结果。用户目录检索接口参数说明见表 1。 表 1 用户目录检索接口参数表 参数名称 参数类型 可选/必选 参数含义 Query 政务信息资源目录查询对象MetaQuery数组 必选 用于存放查

5、询条件的值对象。说明：MetaQuery查询条件为非空字符串，MetaQuery 内部的参数为“与”的关系，MetaQuery之间为“或”的关系 usercode String 必选 用户 ID，政务信息资源目录管理系统根据用户访问权限对DB11/T 553.52008 2 查询结果进行过滤 a） 返回值：政务信息资源目录数据对象MetaData数组； b） 政务信息资源目录数据对象MetaData的XML Schema定义见附录A.1； c） 政务信息资源目录数据对象MetaData的组成结构见图2； d） 政务信息资源目录查询对象MetaQuery的XML Schema定义见附录A.2；

6、e） 政务信息资源目录查询对象MetaQuery的组成结构见图3。 DB11/T 553.52008 3 图2 政务信息资源目录数据对象MetaData的组成结构图 DB11/T 553.52008 4 图3 政务信息资源目录查询对象MetaQuery的组成结构图 DB11/T 553.52008 5 3.1.2 角色目录检索接口 根据检索条件和角色访问权限对政务信息资源目录数据进行查询，并返回结果。角色目录检索接口参数说明见表 2。 表 2 角色目录检索接口参数表 参数名称 参数类型 可选/必选 参数含义 Query 政务信息资源目录查询对象MetaQuery数组 必选 用于存放查询条件的值

7、对象。说明：MetaQuery查询条件为非空字符串，MetaQuery内部的参数为“与”的关系，MetaQuery之间为“或”的关系 Rolecode string 必选 用户角色ID，政务信息资源目录管理系统根据角色访问权限对查询结果进行过滤 a） 返回值：政务信息资源目录数据对象MetaData数组； b） 政务信息资源目录数据对象MetaData的XML Schema定义见附录A.1； c） 政务信息资源目录数据对象MetaData的组成结构见图2； d） 政务信息资源目录查询对象MetaQuery的XML Schema定义见附录A.2； e） 政务信息资源目录查询对象MetaQuery

8、的组成结构见图3。 3.2 目录注册更新接口 根据权限实现符合规范的政务信息资源目录数据的注册、更新，并返回注册或更新成功的政务信息资源目录数据的元数据标识符。目录注册更新接口参数说明见表3。 表 3 目录注册更新接口参数表 参数名称 参数类型 可选/必选 参数含义 RegisterData 政务信息资源目录数据对象MetaData数组 必选 请求目录注册、目录更新的政务信息资源目录数据对象 Usercode string 必选 用户 ID，用于检验用户是否有权限进行目录注册或目录更新操作 isRegister Boolean 必选 TRUE表示目录注册，FALSE表示目录更新 a） 返回值：

9、如果注册或更新成功，返回注册或更新成功的政务信息资源目录数据的元数据标识符；如果失败，返回-1； b） 政务信息资源目录数据对象MetaData的XML Schema定义见附录A.1； c） 政务信息资源目录数据对象MetaData的组成结构见图2。 4 政务信息资源交换服务接口 4.1 数据库交换接口 4.1.1 数据库交换请求接口 将数据库交换请求信息发送到交换中心，并在发送数据的交换节点与接收数据的交换节点之间建立会话。数据库交换请求接口参数说明见表4。 表 4 数据库交换请求接口参数表 参数名称 参数类型 可选/必选 参数含义 Message 数据库交换请求对象DBExRequest

10、必选 数据库交换请求信息 DB11/T 553.52008 6 参数名称 参数类型 可选/必选 参数含义 deliveryMode int 可选 采用的传送模式，支持的传送模式至少应包括持续传送模式 PERSISTENT 和一次性传送模式NON_PERSISTENT Priority int 可选 请求的优先级，共有10个优先级。0是最低优先级，9是最高优先级。默认的优先级是4 timeToLive int 可选 请求的存在时间，单位为毫秒，由发送方指定，0为无限制 a） 返回值：TRUE表示发送成功，FALSE表示发送失败； b） 数据库交换请求对象DBExRequest的XML Schem

11、a定义见附录B.1； c） 数据库交换请求对象DBExRequest的组成结构见图4。 图4 数据库交换请求对象DBExRequest的组成结构图 4.1.2 数据库数据发送接口 将需交换的数据库数据发送给接收数据的交换节点。数据库数据发送接口参数说明见表5。 表 5 数据库数据发送接口参数表 参数名称 参数类型 可选/必选 参数含义 dbData 数据库交换数据对象DBExData 必选 需要通过数据库数据发送接口发送的数据集 a） 返回值：无； b） 数据库交换数据对象DBExData的XML Schema定义见附录B.2； c） 数据库交换数据对象DBExData的组成结构见图5。 DB

12、11/T 553.52008 7 图5 数据库交换数据对象DBExData的组成结构图 4.1.3 数据库数据接收接口 接收从提供数据的交换节点发送的数据库数据。数据库数据接收接口参数说明见表6。 表 6 数据库数据接收接口参数表 参数名称 参数类型 可选/必选 参数含义 dbData 数据库交换数据对象DBExData 必选 需要通过数据库数据接收接口接收的数据集 a） 返回值：无； b） 数据库交换数据对象DBExData的组成结构见图5； c） 数据库交换数据对象DBExData的XML Schema定义见附录B.2。 4.2 文件交换接口 4.2.1 文件交换请求接口 将文件交换请求信

13、息发送到交换中心，并在发送数据的交换节点与接收数据的交换节点之间建立会话。文件交换请求接口参数说明见表7。 表 7 文件交换请求接口参数表 参数名称 参数类型 可选/必选 参数含义 Message 文件交换请求对象FileExRequest 必选 文件交换请求信息 DB11/T 553.52008 8 参数名称 参数类型 可选/必选 参数含义 deliveryMode Int 可选 采用的传送模式，支持的传送模式至少应包括持续传送模式 PERSISTENT 和一次性传送模式NON_PERSISTENT Priority Int 可选 请求的优先级，共有10个优先级。0是最低优先级，9是最高优先

14、级。默认的优先级是4 timeToLive Int 可选 请求的存在时间，单位为毫秒，由发送方指定，0为无限制 a） 返回值：TRUE表示发送成功，FALSE表示发送失败； b） 文件交换请求对象FileExRequest的XML Schema定义见附录B.3； c） 文件交换请求对象FileExRequest的组成结构见图6。 图6 文件交换请求对象FileExRequest的组成结构图 4.2.2 文件数据发送接口 将需交换的文件数据发送给接收数据的交换节点。文件数据发送接口参数说明见表8。 表 8 文件数据发送接口参数表 参数名称 参数类型 可选/必选 参数含义 fData 文件交换数据

15、对象FileExData 必选 需要通过文件数据发送接口发送的数据集 DB11/T 553.52008 9 a） 返回值：无； b） 文件交换数据对象FileExData的XML Schema定义见附录B.4； c） 文件交换数据对象FileExData的组成结构见图7。 图7 文件交换数据对象FileExData的组成结构图 4.2.3 文件数据接收接口 接收从提供数据的交换节点发送的文件数据。文件数据接收接口参数说明见表9。 表 9 文件数据接收接口参数表 参数名称 参数类型 可选/必选 参数含义 fData 文件交换数据对象FileExData 必选 需要通过文件数据接收接口接收的数据集

16、 a） 返回值：无； b） 文件交换数据对象FileExData的XML Schema定义见附录B.4； c） 文件交换数据对象FileExData的组成结构见图7。 DB11/T 553.52008 10 5 认证授权服务接口 认证授权服务接口另作专门规定。 DB11/T 553.52008 11 附 录 A （规范性附录） 政务信息资源目录服务接口XML Schema描述 A.1 政务信息资源目录数据对象XML Schema描述 DB11/T 553.52008 12 DB11/T 553.52008 13 政务信息资源目录数据对象参数说明见表A.1： 表 A.1 政务信息资源目录数据对象

17、参数表 参数名称 参数类型 参数说明 resTitle String 资源名称 Abstract String 资源摘要 Class String 资源安全限制分级 dataChar String 资源字符集 DB11/T 553.52008 14 参数名称 参数类型 参数说明 dataLang String 资源语种 descKeys ResKeysType 关键字说明 fmInfo ResFormatType 资源格式信息 idPoC ResSupplyType 资源负责方 idPoC1 ResConsumptionType 资源需求方 mdContact ResSupplyType 元数

18、据联系方 mdDateSt String 元数据创建日期 mdLang String 元数据语种 mdID String 元数据标识符 mdClass String 元数据安全限制分级 onLineSrc String 在线资源链接地址 Period ResPeriodType 时间范围 pubDate String 资源出版日期 resID String 资源标识符 resCat ResCategoryType 资源分类 spatDom String 空间范围 Statement String 数据志说明 resType String 资源类型 useConsts String 资源使用限制

19、 表 A.2 关键字说明（ResKeysType）参数表 参数名称 参数类型 参数说明 Keyword String 关键字 thesaName String 词典名称 表 A.3 资源格式信息（ResFormatType）参数表 参数名称 参数类型 参数说明 formatName String 资源格式名称 formatVer String 资源格式版本 表 A.4 资源负责方/元数据联系方（ResSupplyType）参数表 参数名称 参数类型 参数说明 eMailAdd String 单位邮箱 cntAddress String 单位地址 rpOrgName String 单位名称 表

20、A.5 资源需求方（ResConsumptionType）参数表 参数名称 参数类型 参数说明 eMailAdd String 单位邮箱 cntAddress String 单位地址 rpOrgName String 单位名称 applicationName String 应用名称 表 A.6 时间范围（ResPeriodType）参数表 DB11/T 553.52008 15 参数名称 参数类型 参数说明 begDate String 起始时间 endDate String 结束时间 表 A.7 资源分类（ResCategoryType）参数表 参数名称 参数类型 参数说明 cateCode

21、 String 类目编码 cateName String 类目名称 cateStd String 分类标准 A.2 政务信息资源目录查询对象XML Schema描述 DB11/T 553.52008 16 DB11/T 553.52008 17 政务信息资源目录查询对象参数说明见表A.8。 表 A.8 政务信息资源目录查询对象参数表 参数名称 参数类型 参数说明 metaID String 元数据标识符 metaCreateDate String 元数据创建日期 metaLang String 元数据语种 metaRpAddress String 元数据联系方地址 metaRpEMail St

22、ring 元数据联系方电子邮件地址 metaRpOrgName String 元数据联系单位 metaSecurityLevel String 元数据安全限制分级 resAbstract String 资源摘要 resBeginDate String 起始时间 resEndDate String 结束时间 resCategoryCode String 类目编码 resCategoryName String 类目名称 resCategoryStandard String 分类标准 resCharSet String 资源字符集 resDataExplain String 数据志说明 resFor

23、matName String 资源格式名称 resFormatVersion String 资源格式版本 resID String 资源标识符 resKeyword String 关键字 resKeywordDictionay String 辞典名称 resLang String 资源语种 resName String 资源名称 resOnLineSrc String 在线资源链接地址 resPubDate String 资源出版日期 resRpAddress String 资源负责方地址 resRpEMail String 资源负责方电子邮件地址 resRpOrgName String 资源

24、负责单位 resRqAddress String 资源需求方地址 resRqAppName String 业务应用名称 resRqEmail String 资源需求方电子邮件地址 resRqOrgName String 资源需求单位 resSecurityLevel String 资源安全限制分级 resSpace String 空间范围 resType String 资源类型 resUseLimit String 资源使用限制 DB11/T 553.52008 18 附 录 B （规范性附录） 政务信息资源交换服务接口XML Schema描述 B.1 数据库交换请求对象XML Schema描

25、述 DB11/T 553.52008 19 数据库交换请求对象参数说明见表B.1。 表 B.1 数据库交换请求对象参数表 参数名称 参数类型 参数说明 Version String 服务版本号 senderCode String 发送方机构编码 senderAppCode String 发送方应用系统编码 resourceID String 资源标识符 resourceName String 资源名称 userID String 用户标识符 userName String 用户名称 timeStamp String 时间戳 messageID String 消息标识符 receiver Rec

26、eiverType 接收方 表 B.2 接收方(ReceiverType)参数表 参数名称 参数类型 参数说明 receiverCode String 接收方机构编码 receiverAppCode String 接收方应用系统编码 B.2 数据库交换数据对象XML Schema描述 DB11/T 553.52008 20 数据库交换数据对象参数说明见表B.3。 表 B.3 数据库交换数据对象参数表 DB11/T 553.52008 21 参数名称 参数类型 参数说明 senderAppCode String 发送方应用系统编码 senderCode String 发送方机构编码 sender

27、PeerName String 发送方节点名称 receiverAppCode String 接收方应用系统编码 receiverCode String 接收方机构编码 receiverPeerName String 接收方节点名称 sendTime String 发送时间 resourceID String 资源标识符 resourceType String 资源类型 userID String 用户标识符 userName String 用户名 processName String 交换流程名称 dataSet DataSetType 交换的数据集 表 B.4 数据集（DataSetTyp

28、e）参数表 参数名称 参数类型 参数说明 operationType String 操作码，I增加 U修改 D删除 recordData RecordDataType 组成数据集的基本单位，表示一条记录。 表 B.5 记录（RecordDataType）参数表 参数名称 参数类型 参数说明 unitData UnitDataType 数据项，组成数据记录的基本单位，表示关系数据库表中的某个字段 表 B.6 数据项（UnitDataType）参数表 参数名称 参数类型 参数说明 unitIDName String 数据项的标识符 unitDisplayName String 数据项的名称 uni

29、tValue String 数据项的值 B.3 文件交换请求对象XML Schema描述 DB11/T 553.52008 22 文件交换请求对象参数说明见表B.7。 表 B.7 文件交换请求对象参数表 参数名称 参数类型 参数说明 version String 服务版本号 senderCode String 发送方机构编码 DB11/T 553.52008 23 senderAppCode String 发送方应用系统编码 resourceID String 资源标识符 resourceName String 资源名称 userID String 用户标识符 userName String

30、用户名称 timeStamp String 时间戳 messageID String 消息标识符 sourceFile SourceFileType 交换的文件数据 receiver ReceiverType 接收方 表 B.8 源文件（SourceFileType）参数表 参数名称 参数类型 参数说明 sourceFileName String 文件名 sourceFilePath String 文件路径 表 B.9 接收方（ReceiverType）参数表 参数名称 参数类型 参数说明 receiverCode String 接收方机构编码 receiverAppCode String 接

31、收方应用系统编码 B.4 文件交换数据对象XML Schema描述 DB11/T 553.52008 24 文件交换数据对象参数说明见表B.10。 表 B.10 文件交换数据对象参数表 参数名称 参数类型 参数说明 senderAppCode String 发送方应用系统编码 DB11/T 553.52008 25 参数名称 参数类型 参数说明 senderCode String 发送方机构编码 senderPeerName String 发送方节点名称 receiverAppCode String 接收方应用系统编码 receiverCode String 接收方机构编码 receiverP

32、eerName String 接收方节点名称 sendTime String 发送时间 resourceID String 资源标识符 resourceType String 资源类型 userName String 用户名称 userID String 用户标识符 processName String 流程名称 dataSet DataSetType 交换的文件数据集 表 B.11 数据集（DataSetType）参数表 参数名称 参数类型 参数说明 recordData RecordDataType 组成数据集的基本单位，表示一个文件。 表 B.12 记录（RecordDataType）参数表 参数名称 参数类型 参数说明 fileName String 文件名称 fileType String 文件类型（doc、xls等） isBinary Boolean 是否为二进制文件，TRUE二进制，FALSE文本格式 fileSize String 文件大小 unitData String 经过base64 编码后的文件内容