DB53T 594-2014 安全生产信息数据交换接口规范.pdf

DB53/T 5942014 安全生产信息数据交换接口规范 2014-06-09 发布 2014-09-01 实施ICS 13.320 A 91 中华人民共和国国家质量监督 检验检疫总局备案号：42357-2014 云南省地方标准 云南省质量技术监督局 发 布 DB53/T 5942014 I 目 次 前言.II 1 范围.1 2 规范性引用文件.1 3 概述.1 3.1 总体框架.1 3.2 信息共享与交换模式.1 4 交换指标项.1 4.1 概述.1 4.2 属性.1 4.3 内容.2 5 数据接口.2 5.1 概述.2 5.2 请求 XML 文件.2 5.2.1 增加数据请求 XML 文件.2 5.2.2 修改数据请求 XML 文件.5 5.2.3 删除数据请求 XML 文件.5 5.2.4 查询数据请求 XML 文件.7 5.3 响应 XML 文件.9 5.3.1 操作结果消息响应 XML 文件.9 5.3.2 查询结果数据响应 XML 文件.10 附录 A（规范性附录）交换指标项.13 附录 B（规范性附录）数据接口 XML Schema.20 DB53/T 5942014 II 前 言 本标准按照GB/T 1.12009标准化工作导则 第1部分：标准的结构和编写给出的规则起草。本标准由云南省安全生产监督管理局提出并归口。本标准起草单位：云南省安全生产监督管理局、中国软件与技术服务股份有限公司。本标准主要起草人：白良、谭晓勇、马海峰、王东明、刘佩源、付涛、杨耀东、詹亚宇、胡东、王书成。DB53/T 5942014 1 安全生产信息数据交换接口规范 1 范围 本标准规定了安全生产信息数据交换接口规范和交换指标项。本标准适用于安全生产信息交换。2 规范性引用文件 下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅所注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB/T 21062.3 政务信息资源交换体系 第3部分：数据接口规范 3 概述 3.1 总体框架 采用与平台无关、语言无关的WebServices技术，由WebService门户提供统一接口。3.2 信息共享与交换模式 3.2.1 数据交换按 XML 文件格式进行。3.2.2 其他信息系统向安全生产信息系统发送请求。3.2.3 安全生产信息系统向其他信息系统发送响应文件。4 交换指标项 4.1 概述 交换指标项用于规定交换的信息实体。4.2 属性 描述一个交换指标项的属性包括：a)标识符：指标项的内部唯一标识，其格式 4 位数字，每个数字从 0 至 9 进行顺序排列，不够 4位的前面补 0；b)名称：指标项的中文名称；c)说明：指标项内容的描述与解释；d)格式：内容的表示格式如表 1 所示。e)备注：对指标项其他相关内容的补充说明，包括指标项的取值范围、遵循的标准规范要求等。DB53/T 5942014 2 交换指标项表示格式 字字 符符 含含 义义 C 通过字符形式表达的值的类型。C 后加自然数表示定长字符串，C6 表示 6 个定长字符（一个汉字相当于两个字符）N 通过可计算的十进制形式表达的值的类型。N 后加自然数表示定长数值，如 N4 表示 4 位定长数字 D 日期型，通过 YYYYMMDD HH24:MI:SS 的形式表达的值的类型。用 D 后加 4、6、8、10、12、14，分别表示不同数据格式的日期型数据元素。D4 表示 YYYY；D6 表示 YYYYMM；D8 表示 YYYYMMDD；D10 表示 YYYYMMDD HH；D12 表示 YYYYMMDD HH:MI；D14 表示 YYYYMMDD HH:MI:SS；通过该格式来定义时间的精确范围.UL 表示长度不定的文本.从最小长度到最大长度，前面附加最小长度，后面附加最大长度（也可以只附加最大长度）。如 C.6 表示最多 6 个字符；N2.7 表示最少 2 位数字最多 7 位数字 4.3 内容 交换指标项内容见附录A。5 数据接口 5.1 概述 数据接口基于数据库中的表结构按照Web Service规范进行定义，根据不同的“请求XML文件”进行数据的增加、修改、删除、查询操作，并返回相应的“响应XML文件”。接口定义如表2所示。数据接口定义表 接口名字接口名字 参数列表参数列表 说明说明 Passport 身份认证标识 dataRequestXML 请求数据 XML CSISFacade responseXML 信息返回 5.2 请求 XML 文件 5.2.1 增加数据请求 XML 文件 5.2.1.1 概述 增加数据请求XML文件由头部和数据体组成，如图1所示。头部是必需的元素，元素名称是Head，用来描述交换数据属于的业务主题以及对数据进行的操作。数据体是必需的元素，元素名称是Data，用来封装交换的数据。增加数据请求XML文件见附录B中表B.1。DB53/T 5942014 3 增加数据请求 XML 文件结构图 5.2.1.2 头部 头部包含操作和事务标识2个属性，其结构如图2所示。增加数据请求 XML 头部结构图 f)操作 XML 属性名称：Action 说明：该属性代表对属于某业务主题的数据进行的操作。对于“增加”操作其值用“-insert”表示，其中“”代表不同的业务主题。该属性为必需的属性。g)事务标识 XML 属性名称：TransactionId 说明：用于处理该操作的业务类的名称。该属性为可选的属性。5.2.1.3 数据体 数据体由主表和从表2个元素组成，对数据库中需增加的某主表数据及其相应子表数据进行封装。其结构如图3所示。DB53/T 5942014 4 增加数据请求 XML 数据体结构图 h)主表 XML 元素名称：MainTable 说明：代表具有主从关系的相关数据库表中的主表，或者代表数据库中一个与其他表没有关系的独立的表。该元素至少出现1次，可以出现多次。主表由主键名、数据接口模型（BusinessData）2个元素，以及表名、bo类名2个属性组成：1)表名 XML 属性名称：TableName 说明：数据库表的名称。该属性是必需的属性。2)bo 类名 XML 属性名称：bo-class 说明：数据库表对应的bo类。该属性是可选的属性。3)主键 XML 元素名称：PriKey DB53/T 5942014 5 说明：数据库表中的主键，是一个键或多个键的组合。主键由键组成，键：XML 元素名称：Key 说明：组成主键的数据项名称。该元素至少出现 1 次，可以出现多次。4)数据接口模型 XML 元素名称：BusinessData 说明：交换数据按照 GB/T 21062.3 进行封装。i)从表 XML 元素名称：SubTable 说明：代表具有主从关系的相关数据库表中的从表。该元素为可选元素。从表由主键名、数据接口模型（BusinessData）2 个元素，以及表名、关系主表名、bo 类名 3 个属性组成：1)表名 XML 属性名称：TableName 说明：数据库表的名称。该属性是必需的属性。2)关系主表名 XML 属性名称：ref-maintable 说明：从表对应主表的表名。该属性是必需的属性。3)bo 类名 XML 属性名称：bo-class 说明：数据库表对应的bo类。该属性是可选的属性。4)主键 XML 元素名称：PriKey 说明：数据库表中的主键，是一个键或多个键的组合。主键由键组成，键：XML 元素名称：Key 说明：组成主键的数据项的名称。该元素至少出现 1 次，可以出现多次。5)数据接口模型 XML 元素名称：BusinessData 说明：交换数据按照 GB/T 21062.3 进行封装。5.2.2 修改数据请求 XML 文件 修改数据请求XML文件的结构与5.2.1条增加数据请求XML文件一致。其Head元素的Action属性值应为“-update”，其中“”代表不同的业务主题。5.2.3 删除数据请求 XML 文件 5.2.3.1 概述 删除数据请求XML文件由头部和数据体组成，如图4所示。头部是必需的元素，元素名称是Head，用来描述交换数据属于的业务主题以及对数据进行的操作。数据体是必需的元素，元素名称是Data，用来封装交换的数据。删除数据请求XML文件见附录B中B.2。DB53/T 5942014 6 删除数据请求 XML 文件结构图 5.2.3.2 头部 删除数据请求XML文件的头部结构与5.2.1条增加数据请求XML文件的头部结构相同，其Head元素的Action属性值应为“-delete”，其中“”代表不同的业务主题。5.2.3.3 数据体 数据体由配置和删除记录2个元素组成，表明对数据库中哪个表的哪些记录进行删除操作，其结构如图5所示。删除数据请求 XML 文件数据体结构图 j)配置 XML 元素名称：Config 说明：对删除操作进行设定，Config 元素包含表名和 bo 类名 2 个属性：1)表名 XML 属性名称：TableName 说明：数据库表的名称。该属性是必需的属性。2)bo 类名 XML 属性名称：bo-class 说明：数据库表对应的 bo 类。该属性是可选的属性。k)删除记录 XML 元素名称：Del-Record 说明：对根据主键进行删除操作的数据进行封装，该元素至少出现 1 次，可以出现多次。删除记录由主键元素组成：XML元素名称：PriKey DB53/T 5942014 7 说明：数据库表中的主键，是一个键或多个键的组合。主键由键组成，键：XML元素名称：Key 说明：组成主键的数据项。该元素至少出现 1 次，可以出现多次。键由数据项名、数据值、数据类型、数据长度、注释 5 个元素组成：数据项名 XML 元素名称：FieldName 说明：数据项的名称。数据值 XML 元素名称：Value 说明：数据项的值。数据类型 XML 元素名称：DataType 说明：数据项的数据类型。数据长度 XML 元素名称：Length 说明：数据项的数据长度。注释 XML 元素名称：Comment 说明：数据项的业务含义。5.2.4 查询数据请求 XML 文件 5.2.4.1 概述 查询数据请求XML文件由头部和数据体组成，如图6所示。头部是必需的元素，元素名称是Head，用来描述交换数据属于的业务主题以及对数据进行的操作。数据体是必需的元素，元素名称是Data，用来封装查询条件数据。查询数据请求XML文件见附录B中表B.3。查询数据请求 XML 文件结构图 5.2.4.2 头部 查询数据请求XML文件的头部结构与5.2.1条增加数据请求XML文件的头部结构相同，其Head元素的Action属性值应为“-query”，其中“”代表不同的业务主题。5.2.4.3 数据体 数据体由配置和查询条件集2个元素组成，表明对数据库中哪个表按照哪些条件进行查询操作，其结构如图7所示。DB53/T 5942014 8 查询数据请求 XML 文件数据体结构图 l)配置 XML 元素名称：Config 说明：对查询操作进行设定，Config 元素包含表名和 bo 类名 2 个属性：1)表名 XML 属性名称：TableName 说明：数据库表的名称。该属性是必需的属性。2)bo 类名 XML 属性名称：bo-class 说明：数据库表对应的 bo 类。该属性是可选的属性。m)查询条件集 XML 元素名称：Query-conditions 说明：对查询条件的集合进行封装，该元素是必需的元素。查询条件集由条件元素组成，条件：XML 元素名称：Condition 说明：对具体的查询条件进行封装，该元素至少出现 1 次，可以出现多次。由数据项名、数据值、数据类型、数据长度、注释 5 个元素组成：数据项名 XML 元素名称：FieldName 说明：数据项的名称。数据值 XML 元素名称：Value 说明：数据项的值。数据类型 DB53/T 5942014 9 XML