DB35 T 1884-2019 政务数据汇聚 核心接口描述.pdf

《DB35 T 1884-2019 政务数据汇聚 核心接口描述.pdf》由会员分享，可在线阅读，更多相关《DB35 T 1884-2019 政务数据汇聚 核心接口描述.pdf（16页珍藏版）》请在麦多课文档分享上搜索。

1、 ICS 01.040.35 L 72 DB35 福建省 地方标准 DB35/T 1884 2019 政务数据汇聚 核心接口描述 Governmental data ingestion Core interface description specification 2019 - 12 - 19 发布 2020 - 03 - 19 实施 福建省市场监督管理局 发布 DB35/T 1884 2019 I 目 次 前言 . II 引言 . III 1 范围 . 1 2 规范性引用文件 . 1 3 术语和定义 . 1 4 缩略语 . 2 5 核心接口操作描述 . 2 6 接口扩展描述 . 3 7 错

2、误代码 . 4 8 接口返回格式 . 4 附录 A（规范性附录） 核心接口描述信息 . 5 附录 B（资料性附录） 核心接口描述示例 . 8 参考文献 . 9 DB35/T 1884 2019 II 前 言 本标准按照 GB/T 1.1 2009给出的规则起草。 请注意本文件的某 些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。 本标准由数字中国研究院（福建）提出。 本标准由福建省信息化标准化技术委员会（ SAFJ/TC 11）归口。 本标准起草单位： 数字中国研究院（福建）、福建工程学院、福建省标准化研究院、福州大学、 福建省星云大数据应用服务有限公司、福建省政府办公厅电子政务

3、中心、福大经纬信息科技有限公司。 本标准主要起草人： 余劲松弟、佟瑞菊、文芳、吴升、涂平、肖桂荣、黄良振、张兴、王洪庆。 DB35/T 1884 2019 III 引 言 2018年 4月 22日至 4月 24日，“以信息化驱动现代化，加快建设数字中 国”为主题的首届数字中国建 设峰会于在福建省福州 市 举行。由 福建省数字福建建设领导小组办公室 推荐的“数字福建政务数据整合 汇聚与共享应用工程”作为 30个最佳实践案例之一在峰会期间对外展示。 政务数据汇聚标准系列，采用模块化方法进行编制，包括核心标准和扩展标准。核心标准包括数据 集规范化描述和核心接口描述。其中 DB35/T 1777 20

4、18政务数据汇聚：数据集规范化描述规定了 政务数据汇聚所形成数据集内容和形式的规范化描述，人口、法人等数据扩展规范可在此基础上参照定 制。政务数据汇聚的核心接口是政务数据汇聚工程开发 和测试过程中的主要操作接口，包括服务描述、 数据描述和数据描述，具体传输协议（如 Post、 SOAP、 Restful）扩展、订阅推送等操作扩展可在核心 接口描述的基础上参照定制。 DB35/T 1884 2019 1 政务数据汇聚 核心接口描述 1 范围 本标准规定了政务数据汇聚的核心接口操作描述、接口扩展描述、错误代码和接口返回格式。 本标准适用于政务数据汇聚核心接口的开发、测试。 2 规范性引用文件 下列

5、文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文件。 凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件 。 GB/T 7408 2005 数据和交换格式 信息交换 日期和时间表示法 GB 11643 1999 公民身份号码 GA/T 2000.156 2016 公安信息代码 第 156部分：常用证件代码 DB35/T 1777 2018 政务数据汇聚：数据集的规范化描述 国务院关于批转发展改革委等部门法人和其他组织统一社会信用代码制度建设总体方案的通知 （国发 2015 33号） IETF RFC 2616 超文本传输协议 HTTP/1.1（

6、Hypertext Transfer Protocol HTTP/1.1） 3 术语和定义 DB35/T 1777 2018界定的以及下列的术语和定义适用于本文件。为了便于使用，以下重复列出了 DB35/T 1777 2018中的一些术语和定义。 3.1 接口描述 interface description 描述通过接口交换所需要的全部信息。 注 1： 参见 WSDL 2.0。 注 2： 含操作、请求、返回、异常描述。 3.2 核心接口操作 core interface description 通过接口交换所需要的 主要接口操作 。 注： 政务数据汇聚核心接口操作含服务描述操作、数据描述操作、

7、数据采集操作。 3.3 服务描述操作 service description operation 客户端发送服务描述请求，服务端返回服务描述。 3.4 数据描述操作 data description operation 客户端发送数据描述请求，服务端返回数据描述 。 DB35/T 1884 2019 2 3.5 数据采集操作 get data operation 客户端发送数据采集请求，服务端返回数据集。 3.6 多重性 multiplicity 包含一组上下限数，用来指出可被允许生成的实例 。 注 1： 参见 ISO/IEC 19505-1:2012。 注 2： 0:1 表示可选且不具有多重

8、性， 0:N 表示可选且具有多重性 ， 1:1 表示必选且不具有多重性， 1:N 表示必选且 具有多重性， 3:N 表示至少有 3 个实例。 4 缩略语 下列缩略语适用于本文件。 GDI：政务数据汇聚（ Governmental Data Ingestion） JSON： JavaScript对象标记（ JavaScript Object Notation） KVP：键值对（ Key Value Pair） MIME：多用途互联网邮件扩展类型（ Multipurpose Internet Mail Extensions） SOAP：简单对象访问协议（ Simple Object Access

9、Protocol） XML：可扩展标记语言（ eXtensible Markup Language） XSD： XML结构定义（ XML Schemas Definition） 5 核心接口操作描述 5.1 总体要求 政务数据汇聚操作基于数据汇聚请求描述定制，数据汇聚请求描述参数包括服务类型和版本号，见 附录 A中的表 A.1。政务数据汇聚核心接口支持服务描述操作、数据描述操作和数据采集操作，政务数据 汇聚接口的应至少支持一种数据集描述格式和一种传输协议，如 KVP、 SOAP等，参见附录 B。 5.2 服务描述操作 服务描述操 作请求参数包括服务类型、版本号和操作名称，见附录 A中的表 A.

10、2。 服务描述操作返回结果包括服务描述元数据、服务操作元数据和服务内容，见附录 A中的表 A.3。 服务描述元数据包括服务名称、服务摘要、服务类型、服务版本、扩展配置、扩展服务描述、联系 信息（单位名称、联系人、电话、邮箱、地址），见附录 A中的表 A.4。 服务操作元数据包含操作名称、地址模版、扩展操作描述，见附录 A中的表 A.5。 服务内容包括数据集名称和扩展内容描述，见附录 A中的表 A.6。 5.3 数据描述操作 数据描述操作请求参数见附录 A中的表 A.7，包括服务 类型、版本号、操作名称和数据集名称。 数据描述操作返回结果包括数 据描述和支持格式，其中 数据描述按照 DB35/T

11、 1777 2018的规定 ， 见附录 A中的表 A.8。 DB35/T 1884 2019 3 5.4 数据采集操作 数据采集操作请求参数见附录 A中的表 A.9，包括服务类型、版本号、操作名称、数据集名称、客户 类别、客户识别码、返回格式、时间范围、和参数扩展，其中时间格式按照 GB/T 7408 2005中第 5章的 规定。 数据采集操作返回结果为与数据描述操作结果相一致的数据。 数据采集请求操作包括静态数据采集请求和动态数据采集请求： a) 对于静态数据，如 请求中无起止时间，则返回所有数据；如有开始时间而无终止时间，则返回 从开始时间之后所有数据；如有起止时间，则返回起止时间范围内数

12、据，如无开始时间而有终 止时间，则返回从开始时间之后至终止时间范围内的所有数据； b) 对于动态数据，如请求中无起止时间，则当前更新数据持续返回；如有开始时间而无终止时间， 则取开始时间至当前时间范围内数据，后续数据按数据更新持续返回；如有起止时间，则返回 起止时间范围内数据，如无开始时间而有终止时间，则返回从开始时间之后至终止时间范围内 的所有数据。 6 接口扩展描述 6.1 核心接口扩展 6.1.1 扩展方式 接口扩 展应与数据汇聚抽象请求描述及 DB35/T 1777 2018保持一致，有以下两种方式： a) 基于核心操作，增加扩展参数并定制返回内容和格式； b) 基于数据汇聚请求定义新

13、操作，包括操作参数及返回内容和格式。 6.1.2 扩展内容 接口扩展应定义如下内容： a) 操作名：操作的名称； b) 参数：请求调用的参数； c) 返回：请求返回的内容和格式； d) 错误信息：调用出错时返回的信息。 6.2 传输协议扩展 数据汇聚传输协议应至少采用如下一种传输协议， HTTP KVP、 FTP、 SOAP等，默认利用前置技术架 构基于 HTTP KVP进行汇聚。 HTTP KVP语法 如下： http:/www.myserver.org:port/path? service=GDI &version=1.0 &request=operation ¶meter=val

14、ue 其中， operation为请求操作名称， parameter为参数名称， value为参数值，参数之间用 &隔开，参 数值之间用英文逗号隔开。 DB35/T 1884 2019 4 7 错误代码 汇聚操作出错时，应基于 IETF RFC 2616返回接口错误代码和错误值。错误代码应由接口类型代码、 操作类型代码及错误类型代码数字字符串依次连接组成。 接口类型代码由 1位阿拉伯数字组成， 1代表数据汇聚接口；操作类型代码由 2位阿拉伯数字构成， 01表示服务描述操作， 02表示数据描述操作， 03表示数据采集操作；错误类型代码由 3位阿拉伯数据构 成；基于该标准的扩展可依此错误代码规则进

15、行扩充。见附录 A中的表 A.10。 8 接口返回格式 返回的服务及数据描述应默认采用 XML编码格式，实例文档的 schemaLocation应包含该实例的模式 定义 XSD，若服务需 要 指定 JSON等其它返回格式， 应 通过规范扩展说明。 DB35/T 1884 2019 5 A A 附 录 A （规范性附录） 核心接口描述信息 表 A.1至表 A.10分别给 出了汇聚请求描述参数、服务描述操作请求参数、服务描述操作返回结果、 服务描述元数据、服务操作元数据、服务内容、数据描述操作请求参数、数据描述操作返回结果、数据 采集操作请求参数、接口错误信息。 表 A.1 汇聚请求描述参数 名称

16、 英文名 短名 定义 数据类型 值 多重性 服务类型 Service Type stype 服务的 类型 字符串 GDI 1:1 服务版本 Service Version sver 服务的版本号 字符串 1.0 1:1 表 A.2 服务描述操作请求参数 名称 英文名 短名 定义 数据类型 值 多重性 服务 类型 Service Type stype 服务的 类型 字符串 GDI 1:1 服务版本 Service Version sver 服务的版本号 字符串 1.0 1:1 操作名称 Operation Name oname 服务请求操作名称 字符串 ServiceDescription 1:

17、1 表 A.3 服务描述操作返回结果 名称 英文名 短名 定义 数据类型 值 多重性 服务描述 元数据 Service Description Metadata sdmeta 服务的元数据描述，含 服务实例所支持的扩展 XML XML 元素 1:1 服务操作 元数据 Service Operation Metadata someta 服务操作的元数据描述 XML XML 元素 3:N 服务内容 Service Content scont 服务所提供的数据信息 XML XML 元素 1:1 表 A.4 服务描述元数据 名称 英文名 短名 定义 数据类型 值 多重性 服务名称 Service Na

18、me sname 服务的名称 字符串 自由字符 1:1 服务摘要 Service Abstract sabs 服务的摘要信息 字符串 自由字符 0:1 服务类型 Service Type stype 服务的类型 字符串 GDI 1:1 承载网络 a Service Network snet 服务的承载网络 字符串 10, 20, 30, 40 1:1 服务版本 Service Version sver 服务的版本 字符串 1.0 1:1 扩展配置 Extended Profile eprof 服务的扩展配置 字符串 服务的扩展标识字符 0:N 服务描述扩展 Service Descriptio

19、n Extension sdext 服务描述 元数据的扩展 XML XML 元素 0:1 单位名称 Organization Name oname 服务的提供单位名称 字符串 自由字符 1:1 DB35/T 1884 2019 6 表 A.4 服务描述元数据 （续） 名称 英文名 短名 定义 数据类型 值 多重性 联系人 Contact contact 提供单位的联系人 字符串 自由字符 0:1 电话 Phone phone 提供单位的联系电话 字符串 自由字符 0:1 邮箱 Email email 提供单位的联系邮箱 字符串 自由字符 0:1 地址 Address address 提供单位的

20、联系地址 字符串 自由字符 0:1 a 承 载网络由 2 位阿拉伯数字组成， 10 代表政务网， 20 代表政务外网， 30 代表政务专网， 40 代表互联网；基于该 标准的扩展可依此代码进行扩充。 表 A.5 服务操作元数据 名称 英文名 短名 定义 数据类型 值 多重性 操作名称 Operation Name oname 操作的名称 字符串 ServiceDescription, DataDescription, GetData 1:1 链接模版 Link Template ltemp 操作的链接地址模版 URL 自由字 符 1:1 服务操作扩展 Service Operation Ext

21、ension soext 服务操作元数据的扩展 XML XML 元素 0:1 表 A.6 服务内容 名称 英文名 短名 定义 数据类型 值 多重性 数据集名称 Dataset Name dname 数据集的名称 字符串 自由字符 1:1 服务内容扩展 Service Content Extension scext 服务内容的扩展 XML XML 元素 0:1 表 A.7 数据描述操作请求参数 名称 英文名 短名 定义 数据类型 值 多重性 服务类型 Service Type stype 服务 的 类型 字符串 GDI 1:1 版本号 Version version 服务 的 版本号 字符串 1

22、.0 1:1 操作名称 Operation Name oname 服务请求操作 的 名称 字符串 DataDescription 1:1 数据集名称 Dataset Name dname 数据集的名称 字符串 自由文本 1:N 表 A.8 数据描述操作返回结果 名称 英文名 短名 定义 数据类型 值 多重性 数据描述 Data Description ddesc - XML XML元 素 1:1 支持格式 Supported Format sform 支持的返回格式 字符串 MIME类型 1:N DB35/T 1884 2019 7 表 A.9 数据采集操作请求参数 名称 英文名 短名 定义

23、数据类型 值 多重性 服务类型 Service Type stype 服务 的 类型 字符串 GDI 1:1 服务版本 Service Version sver 服务 的 版本号 字符串 1.0 1:1 操作 名称 Operation Name oname 服务请求操作 的 名称 字符串 GetData 1:1 数据集名称 Dataset Name dname 数据集的名称 字符串 自由文本 1:N 客户类别 Client Type ctype 发起方的类别 字符串 自然人 , 法人 , 其他 0:1 客户识别码 Client ID cid 客户的识别码 字符串 个人识别码 a, 统一 社会信

24、用代码 b 0:1 返回格式 Format format 返回 的 格式 字符串 MIME类型 0:1 时间范围 Time Period tper 数据时间 的 范围 时间区间 类型 YYYY-MM-DD hh:mm:ss： YYYY-MM-DD hh:mm:ss 0:1 扩展参数 Extended Parameter epara 扩展的数据请求 的 参数 字符串 自由文本 0:N 返回格式为空时，数据将以原始格式返回。 a 客户类别为自 然人时，个人识别码包括 2 部分，为证件代码 +证件号码，其中， 证件代码应符合 GA/T 2000.156 2016的规定， 证件号码中的身份证号码应符合

25、 GB 11643 1999 第 5 章号码的结构和表示形式的规定。 b 客户类别为法人时，客户识别码为统一社会信用代码，应符合 国务院关于批转发展改革委等部门法人和其他组 织统一社会信用代码制度建设总体方案的通知 的相关规定。 表 A.10 接口错误信息 错误参数 值 错误代码 ServiceRequestParemeterError 服务请求参数错误 101001 ServiceRequestParemeterNotComplete 服务请求参数不完整 101002 DataDescriptionNotExist 数据描述不存在 102001 DataNotExist 采集数据不存在 10

26、3001 GetDataRequestLimitsReached 重复采集超过限制 103002 GetDataPermissionDenied 采集请求无权限 103003 DB35/T 1884 2019 8 B B 附 录 B （资料性附录） 核心接口描述示例 B.1 服务描述操作示例 操作名：服务描述 KVP请求： http:/www.myserver.org:port/path?stype=GDI&version=1.0&oname= ServiceDescription 返回 值：参见 表 B.1 表 B.1 服务描述实例返回值 返回数据类型 值 类型 服务描述 服务描述实例 XM

27、L 文档 服务请求参数错误 XML 文档 B.2 数据描述操作示例 操作名：数据描述 KVP请求： http:/www.myserver.org:port/path?stype=GDI&version=1.0&oname= DataDescription&dname=城乡居民人均收入 返回值 ：参见 表 B.2 表 B.2 数据描述实例返回值 返回数据类型 值 类型 数据描述 城乡居民人均收入数据描述 XML 文档 数据描述不存在 XML 文档 B.3 数据采集操作示例 操作名：数据采集 KVP请求： http:/www.myserver.org:port/path?stype=GDI&ver

28、sion=1.0&oname= GetData&dname= 城乡居民人均收 &format=csv&tper=2013-2015 返回值 ：参见 表 B.3 表 B.3 数据采集实例返回值 返回数据类型 值 类型 数据 城乡居民人均收入数据 字符串 采集数据不存在 字符串 DB35/T 1884 2019 9 参 考 文 献 1 GB/T 21062.3 2007 政务信息资源交换体系 第 3部分：数据接口规范 2 DB35/T 918 2009 电子政务信息数据交换 3 ISO/IEC 19505-1:2012 Information technology Object Managemen

29、t Group Unified Modeling Language (OMG UML) Part 1: Infrastructure 4 IETF RFC 6838 Media Type Specifications and Registration Procedures 5 WSDL 2.0 Web Services Description Language (WSDL) Version 2.0 Part 0: Primer _ DB 35 /T 1 88 4 20 19 11 11 福 建 省 地 方 标 准 政务数据汇聚 核心接口描述 DB35/T 1884 2019 * 2019 年 12 月第一版 2019 年 12 月第一次印刷