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实施 北京市质量技术监督局发布DB DB11/T 553.52008 DB11/T 553.5 2008 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.5 2008 II 前 言 DB11/T 553政务信息资源共享交换平台技术规范，分为 5个部分： 第 1部分：总体框架； 第 2部分：政务信息资源目录管理； 第 3部分：政务信息资源交换管理； 第 4部分：认证授权； 第 5部分：接口规范。 本部分为 DB11/T 553的第 5部分。 本

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

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

5、数表 参数 名称 参数 类型 可选/ 必选 参数 含义 Query 政务信息资源目录 查询 对象 MetaQuery数 组 必选 用于存放查询条 件的 值对象 。 说明 ： MetaQuery查询条 件为 非空字符串 ，MetaQuery 内 部的参数为 “与” 的 关 系， MetaQuery之间 为“或” 的关 系 usercode String 必选 用户 ID，政务信息资源目录管理 系统根据 用 户访问 权限 对DB11/T 553.5 2008 2 查询结果进行 过滤 a） 返回值：政务信息资源目录数 据对象 MetaData数组 ； b） 政务信息资源目录数 据对象 MetaDat

6、a的 XML Schema定义见附录 A.1； c） 政务信息资源目录数 据对象 MetaData的 组成结 构见图 2； d） 政务信息资源目录查询对象 MetaQuery的 XML Schema定义见附录 A.2； e） 政务信息资源目录查询对象 MetaQuery的组成结 构见图 3。 DB11/T 553.5 2008 3 图2 政务信息资源目录数据对象 MetaData的组成结构图 DB11/T 553.5 2008 4 图3 政务信息资源目录查询对象 MetaQuery的组成结构图 DB11/T 553.5 2008 5 3.1.2 角色目录检索接口 根据检索条 件和角色 访问权限

7、 对政务信息资源目录数 据进行查询 ，并 返回结果。 角色目录 检索接口 参 数 说明见表 2 。 表 2 角色目录检索接口参数表 参数 名称 参数 类型 可选/ 必选 参数 含义 Query 政务信息资源目录 查询对象 MetaQuery数 组 必选 用于存放查询条 件的 值对象 。说明 ： MetaQuery查询条 件 为 非空字符串 ，MetaQuery 内 部的 参数为 “与” 的关 系， MetaQuery之间 为“或” 的关 系 Rolecode string 必选 用户 角色 ID，政务信息资源目录管理 系统根据 角色 访问 权 限 对查询结果进行 过滤 a） 返回值：政务信息资

8、源目录数 据对象 MetaData数组 ； b） 政务信息资源目录数 据对象 MetaData的 XML Schema定义见附录 A.1； c） 政务信息资源目录数 据对象 MetaData的 组成结 构见图 2； d） 政务信息资源目录查询对象 MetaQuery的 XML Schema定义见附录 A.2； e） 政务信息资源目录查询对象 MetaQuery的组成结 构见图 3。 3.2 目录注册更新接口 根据权限实 现符合规范的政务信息资源目录数据 的注册 、 更 新，并 返回 注册或更 新成功的政务信息资 源目录数据 的元数据 标识符。目录注册更 新 接口 参数 说明见表3。 表 3 目

9、录注册更新接口参数表 参数 名称 参数 类型 可选/ 必选 参数 含义 RegisterData 政务信息资源目录数 据对 象 MetaData数 组 必选 请求 目录 注册、目录 更新 的政务信息资源目录数 据 对象 Usercode string 必选 用户 ID，用 于检 验用户 是否 有权限 进行 目录注册 或 目录 更新操 作 isRegister Boolean 必选 TRUE 表 示目录 注册 ， FALSE表示 目录 更新 a） 返回值 ： 如 果注册或更 新成功， 返回注册或更新成 功的政务信息资源目录数 据的元数 据标识符 ； 如果失败， 返回-1； b） 政务信息资源目录

10、数 据对象 MetaData的 XML Schema定义见附录 A.1； c） 政务信息资源目录数 据对象 MetaData的 组成结 构见图 2。 4 政务信息资源交换服务接口 4.1 数据库交换接口 4.1.1 数据库交换请求接口 将数据库交换 请求信息 发送到 交换中心，并 在发送数 据的交换节点与接收 数据的交换 节点之间 建 立会 话。数据库 交换请求 接口参数 说明见表 4。 表 4 数据库交换请求接口参数表 参数 名称 参数 类型 可选/ 必选 参数 含义 Message 数 据 库 交换 请求 对象 DBExRequest 必选 数据 库交换 请求 信息 DB11/T 553.

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

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

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

14、b） 数据库交换数 据对象 DBExData的组成结 构见图 5； c） 数据库交换数 据对象 DBExData的 XML Schema定义见 附录 B.2。 4.2 文件交换接口 4.2.1 文件交换请求接口 将 文件交换 请求 信息发送到交换中心，并 在发送 数据 的交换 节点与 接收数 据的交换 节点之间 建 立会 话。文件交换 请求接口 参 数 说明见表 7。 表 7 文件交换请求接口参数表 参数 名称 参数 类型 可选/ 必选 参数 含义 Message 文件交换请求对象 FileExRequest 必选 文件交换 请求 信息 DB11/T 553.5 2008 8 参数 名称 参数

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

16、ma定义见附录 B.3； c） 文件交换请求 对象 FileExRequest的组成结构见图 6。 图 6 文件交换请求对象 FileExRequest的组成结构图 4.2.2 文件数据发送接口 将需交换的文件数据 发送给接 收数据的交换节点 。文件数据发送 接口参数 说明见表 8。 表 8 文件数据发送接口参数表 参数 名称 参数 类型 可选/ 必选 参数 含义 fData 文件交换数 据对象 FileExData 必选 需要 通过 文件数 据发送 接口 发送 的数 据集 DB11/T 553.5 2008 9 a） 返回值：无 ； b） 文件交换数 据对象 FileExData的 XML

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

18、件交换数 据对象 FileExData的组成结 构见图 7。 DB11/T 553.5 2008 10 5 认证授权服务接口 认证授权服务接口另 作专门规 定。 DB11/T 553.5 2008 11 附 录 A （规范性附录） 政务信息资源目录服务接口 XML Schema描述 A.1 政务信息资源目录数据对象 XML Schema描述 DB11/T 553.5 2008 12 DB11/T 553.5 2008 13 政务信息资源目录数 据对象参 数说明见表 A.1： 表 A.1 政务信息资源目录数据对象参数表 参数 名称 参数 类型 参数 说明 resTitle String 资源 名

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

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

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

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

23、CategoryType）参数表 参数 名称 参数 类型 参数 说明 cateCode String 类目 编码 cateName String 类目 名称 cateStd String 分类 标准 A.2 政务信息资源目录查询对象 XML Schema描述 DB11/T 553.5 2008 16 DB11/T 553.5 2008 17 政务信息资源目录查询对象参 数说明见表 A.8。 表 A.8 政务信息资源目录查询对象参数表 参数 名称 参数 类型 参数 说明 metaID String 元数 据标 识符 metaCreateDate String 元数 据创 建日期 metaLang

24、 String 元数 据语 种 metaRpAddress String 元数 据联 系方地址 metaRpEMail String 元数 据联 系方 电子 邮件 地址 metaRpOrgName String 元数 据联 系单位 metaSecurityLevel String 元数 据安全 限制 分级 resAbstract String 资源 摘要 resBeginDate String 起始时间 resEndDate String 结束时间 resCategoryCode String 类目 编码 resCategoryName String 类目 名称 resCategoryStan

25、dard String 分类 标准 resCharSet String 资源 字符 集 resDataExplain String 数据 志说明 resFormatName String 资源 格式 名称 resFormatVersion String 资源 格式版 本 resID String 资源标 识符 resKeyword String 关键 字 resKeywordDictionay String 辞典 名称 resLang String 资源 语种 resName String 资源 名称 resOnLineSrc String 在线 资源 链接 地址 resPubDate Str

26、ing 资源出 版日期 resRpAddress String 资源 负责方地址 resRpEMail String 资源 负责方 电子 邮件 地址 resRpOrgName String 资源 负责 单位 resRqAddress String 资源 需求方地址 resRqAppName String 业务 应用 名称 resRqEmail String 资源 需求方 电子 邮件 地址 resRqOrgName String 资源 需求 单位 resSecurityLevel String 资源 安全 限制 分级 resSpace String 空间 范围 resType String 资源

27、 类型 resUseLimit String 资源 使用限 制 DB11/T 553.5 2008 18 附 录 B （规范性附录） 政务信息资源交换服务接口 XML Schema描述 B.1 数据库交换请求对象XML Schema 描述 DB11/T 553.5 2008 19 数据库交换 请求对象参 数 说明见表B.1 。 表 B.1 数据库交换请求对象参数表 参数 名称 参数 类型 参数 说明 Version String 服务 版本 号 senderCode String 发送方 机构编码 senderAppCode String 发送方 应用 系统 编码 resourceID Str

28、ing 资源标 识符 resourceName String 资源 名称 userID String 用户 标识 符 userName String 用户名称 timeStamp String 时间 戳 messageID String 消息标 识符 receiver ReceiverType 接收方 表 B.2 接收方(ReceiverType) 参数表 参数 名称 参数 类型 参数 说明 receiverCode String 接收方 机构编码 receiverAppCode String 接收方 应用 系统 编码 B.2 数据库交换数据对象XML Schema 描述 DB11/T 553

29、.5 2008 20 数据库交换数 据对象参 数 说明见表 B.3。 表 B.3 数据库交换数据对象参数表 DB11/T 553.5 2008 21 参数 名称 参数 类型 参数 说明 senderAppCode String 发送方 应用 系统 编码 senderCode String 发送方 机构编码 senderPeerName String 发送方节点 名称 receiverAppCode String 接收方 应用 系统 编码 receiverCode String 接收方 机构编码 receiverPeerName String 接收方节点 名称 sendTime String 发

30、送时间 resourceID String 资源标 识符 resourceType String 资源 类型 userID String 用户 标识 符 userName String 用户名 processName String 交换 流程名称 dataSet DataSetType 交换的数 据集 表 B.4 数据集（DataSetType ）参数表 参数 名称 参数 类型 参数 说明 operationType String 操作 码，I 增加 U修改 D删除 recordData RecordDataType 组成 数据 集的 基本单位， 表示一 条记 录。 表 B.5 记 录（Rec

31、ordDataType ）参数表 参数 名称 参数 类型 参数 说明 unitData UnitDataType 数据 项， 组成 数据 记录的 基本单位， 表示关 系数 据库 表中的 某 个字 段 表 B.6 数据项（UnitDataType ）参数表 参数 名称 参数 类型 参数 说明 unitIDName String 数据 项的标 识符 unitDisplayName String 数据 项的 名称 unitValue String 数据 项的 值 B.3 文件交换请求对象 XML Schema描述 DB11/T 553.5 2008 22 文件交换请求 对象参 数说明见表 B.7。

32、表 B.7 文件交换请求对象参数表 参数 名称 参数 类型 参数 说明 version String 服务 版本 号 senderCode String 发送方 机构编码 DB11/T 553.5 2008 23 senderAppCode String 发送方 应用 系统 编码 resourceID String 资源标 识符 resourceName String 资源 名称 userID String 用户 标识 符 userName String 用户名称 timeStamp String 时间 戳 messageID String 消息标 识符 sourceFile SourceFi

33、leType 交换的文件数 据 receiver ReceiverType 接收方 表 B.8 源文件（SourceFileType ）参数表 参数 名称 参数 类型 参数 说明 sourceFileName String 文件 名 sourceFilePath String 文件 路径 表 B.9 接收方（ReceiverType ）参数表 参数 名称 参数 类型 参数 说明 receiverCode String 接收方 机构编码 receiverAppCode String 接收方 应用 系统 编码 B.4 文件交换数据对象 XML Schema描述 DB11/T 553.5 2008

34、24 文件交换数 据对象参 数说明见表 B.10。 表 B.10 文件交换数据对象参数表 参数 名称 参数 类型 参数 说明 senderAppCode String 发送方 应用 系统 编码 DB11/T 553.5 2008 25 参数 名称 参数 类型 参数 说明 senderCode String 发送方 机构编码 senderPeerName String 发送方节点 名称 receiverAppCode String 接收方 应用 系统 编码 receiverCode String 接收方 机构编码 receiverPeerName String 接收方节点 名称 sendTime

35、 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 编码 后的文件 内容