当前位置: 首页 / 发现 / 政策规范 / 正文

消防基础数据平台接口规范 GA/T1036-2012

来源:发布时间:2018/7/3

前言


中华人民共和国公共安全行业标准
消防基础数据平台接口规范
Specifications for the basic fire data platform interfaces
GA/T 1036—2012
2012-12-26 发布 2013-01-01实施
中华人民共和国公安部 发布


本标准按照GB/T 1.1-2009给出的规则起草。
本标准由公安部消防局提出。
本标准由公安部计算机与信息处理标准化技术委员会归口。
本标准起草单位:公安部沈阳消防研究所。
本标准主要起草人:吕欣驰、傅永财、朱春玲、马青波、姜学赟、王佩青、楼兰、施邦平。

1 范围


本标准规定了消防基础数据平台(以下简称平台)对应用实体提供的软件接口(以下简称接口)功能及参数。
本标准适用于消防基础数据平台,以及需要对消防基础数据(以下简称基础数据)进行访问和交换的应用实体的开发和应用。


2 规范性引用文件


下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件,仅注日期的版本适用于本文件。凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。
GA/T 1038.1-2012 消防公共服务平台技术规范 第1部分:总体架构及功能要求
GA/T 1038.3-2012 消防公共服务平台技术规范 第3部分:信息交换接口


3 术语、定义和缩略语


GA/T 1038.1-2012界定的以及下列术语、定义和缩略语适用于本文件。
3.1
消防基础数据 basic fire data

整体反映消防业务概况的各业务数据。
3.2
消防基础数据平台 the basic fire data platform

由基础数据平台软件和基础数据库组成统一提供消防基础数据存储、访问和交换的消防数据整合平台。
3.3
数据审计记录 data auditing record

对基础数据库中基础数据进行增、删、改等操作的记录信息,以下简称审计记录。
3.4
数据服务 data service

对消防基础数据的增删改查、批量导入、数据字典查询以及审计记录查询等服务的总称,以下简称服务。


4 平台接口


4.1 接口功能
4.2 接口参数
4.3 接口描述

4.1 接口功能


平台应对应用实体提供数据增删改查服务、数据批量导入服务、数据字典查询服务、数据审计记录查询服务和数据变更消息通知等五类接口,功能如下:
a) 数据增删改查服务接口:对基础数据库中基础数据进行增加、删除、修改和查询操作;
b) 数据批量导入服务接口:将基础数据批量导入基础数据库中;
c) 数据字典查询服务接口:对基础数据库中的数据字典进行查询;
d) 数据审计记录查询服务接口:对基础数据的审计记录进行查询;
e) 数据变更消息通知接口:通过信息交换平台将基础数据的变更消息发送给订阅者。


4.2 接口参数


4.2.1 类名称和说明
平台接口使用的自定义类名称和说明见表1。

类名称和说明 4.2.2 安全验证类
用来封装安全验证信息,接口调用时需在服务头传入该类,参数见表2。安全验证参数

4.2.3 数据増删改查服务返回值
数据增删改查服务的返回值信息,参数见表3。

数据増删改查服务返回值参数

4.2.4 数据审计记录返回值
基础数据审计记录的返回值信息,参数见表4。

数据审计记录返回值参数

4.2.5 数据字典实体类
数据字典实体类参数见表5。

数据字典实体

4.2.6 数据字典退回值
数据字典返回值参数见表6。

数据字典返回值参数

4.2.7 数据字典代码值返回值
数据字典代码值返回值参数见表7。

数据字典代码值返回值参数


4.2.8 数据批量导入服务返回值
数据批量导入服务的返回值信息,参数见表8。

数据批量导入服务返回值参数


4.3 接口描述


4.3.1 数据増删改查服务接口
4.3.1.1 总体描述
实现对消防基础数据库中基础数据的增加、删除、修改和查询四种功能,描述见表9,其中查询应支持分页查询,每页记录数小于100条。

表9 数据增删改查服务接口

4.3.1.2 数据增加
数据增加的输入、输出参数见表10。

表10 数据增加输入、输出参数

4.3.1.3 数据删除
数据删除的输人、输出参数见表11。

表11 数据删除输入、输出参数

4.3.1.4 数据修改
数据修改的输入、输出参数见表12。

表12 数据修改输入、输出参数


4.3.1.5 数据查询
数据查询的输入、输出参数见表13。

表13 数据查询输入、输出参数

4.3.2 数据批量导入服务接口
4.3.2.1 总体描述
实现将批量采集的基础数据打包成XML格式成批量导入消防基础库,描述见表14,一次批量导入的数据量应控制在1000条数据以下。

表14 数据批量导入服务接口

4.3.2.2 数据批量导入
数据批量导入的输入、输出参数见表15。

表15 数据批量导入输入、输出参数

4.3.2.3 批量导入数据格式
批量导入数据操作时输入参数的数据组织方式,由数据集标签<dataset>、表名标签< 表名>、字段名称标签 < 字段名称>、数据组成,具体格式见示例。
示例:



示例

4.3.3 数据字典查询服务接口
4.3.3.1 总体描述
实现查询数据字典主表及子表相关数据,描述见表16。

表16 数据字典查询服务接口

4.3.3.2 数据字典查询
数据字典查询的输入、输出参数见表17。

表17 数据字典查询输入、输出参数


4.3.3.3 数据字典变更查询
数据字典变更查询的输入、输出参数见表18。

表18 数据字典变更查询输入、输出参数

4.3.3.4 数据字典代码值查询
数据字典代码值查询的输入、输出参数见表19。

表19 数据字典代码值查询输入、输出参数

4.3.3.5 根据数据字典ID号查询数据字典代码值
根据数据字典ID号查询数据字典代码值的输入、输出参数见表20。

 表20 根据数据字典ID号查询数据字典代码值输入、输出参数

4.3.4 数据审计记录查询服务接口
4.3.4.1 总体描述

实现从数据审计记录中将所查询内容打包成XML文件返回,描述见表21。

表21 数据审计记录查询服务接口

4.3.4.2 根据审计记录ID号查询
根据审计记录ID号查询的输入、输出参数见表22。

表22 根据审计记录ID号查询输入、输出参数

4.3.4.3 根据审计记录ID号范围查询
根据审计记录ID号范围查询的输入、输出参数见表23。

表23 根据审计记录ID号查询输入、输出参数

4.3.4.4 根据审计记录ID号范围和指定表名查询
根据审计记录ID号范围和指定表名查询的输入、输出参数见表24。

表24 根据审计记录ID号范围和指定表名查询输入、输出参数

4.3.4.5 根据审计记录时间查询
根据审计记录时间查询的输入、输出参数见表25。

表25 根据审计记录时间查询输入、输出参数

4.3.4.6 根据审计记录时间范围查询
根据审计记录时间范围查询的输入、输出参数见表26。

表26 根据审计记录时间范围查询输入、输出参数

4.3.4.7 根据审计记录时间范围和指定表名查询
根据审计记录时间范围和指定表名查询的输入、输出参数见表27。

表27 根据审计记录时间范围和指定表名查询输入、输出参数

4.3.4.8 根据基础数据表ID号和指定表名查询
根据基础数据表ID号和指定表名查询的输入、输出参数见表28。

表28 根据基础数据表ID号和指定表名查询输入、输出参数

4.3.4.9 最大审计记录ID号查询
最大审计记录ID号查询的输入、输出参数见表29。

表29 最大审计记录ID号查询输入、输出参数

4.3.4.10 指定表的最大审计记录ID号查询
指定基础数据表的最大审计记录ID号查询的输入、输出参数见表30。

表30 指定表的最大审计记录ID号查询输入、输出参数

4.3.5 数据变更消息通知接口
4.3.5.1 总体描述
实现当基础数据表发生数据变更时,通过信息交换平台,向该数据表的实时消息订阅者发送数据变更消息通知,与信息交换平台的接口应符合GA/T 1038.3-2012的规定。
4.3.5.2 消息体主要包含的域
消息体的类型为“text”,格式采用XML,消息体主要包含的域见表31。

表31 消息体主要包含的域

4.3.5.3 消息体格式
消息体的格式见示例,其中域参数的含义见表31。
示例:

4.4 调用结果消息代码


调用结果消息代码及描述见表32。
调用结果消息代码
调用结果消息代码