【GA公共安全标准】 消防基础数据平台接口规范

ICS35.240
中华人民共和国公共安全行业标准GA/T1036-—2012
消防基础数据平台接口规范
Specifications for the basic fire data platform interfaces2012-12-26发布
中华人民共和国公安部
2013-01-01实施
本标准按照GB/T1.1—2009给出的规则起草。本标准由公安部消防局提出，
本标准由公安部计算机与信息处理标准化技术委员会归口，本标准起草单位：公安部沈阳消防研究所。GA/T1036—2012
本标准主要起草人：吕欣驰、傅永财、朱春玲、马青波、姜学资、王佩青、楼兰、施邦平。1范围
消防基础数据平台接口规范
GA/T1036—2012
本标准规定了消防基础数据平台（以下简称平台）对应用实体提供的软件接口（以下简称接口）功能及参数。
本标准适用于消防基础数据平台，以及需要对消防基础数据（以下简称基础数据）进行访问和交换的应用实体的开发和应用。
2规范性引用文件
下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GA/T1038.1—2012消防公共服务平台技术规范第1部分：总体架构及功能要求GA/T1038.3-2012消防公共服务平台技术规范第3部分：信息交换接口3术语、定义和缩略语
GA/T1038.1--2012界定的以及下列术语、定义和缩略语适用于本文件。3.1
消防基础数据basicfiredata
整体反映消防业务概况的各业务数据。3.2
消防基础数据平台
thebasicfiredataplatform
由基础数据平台软件和基础数据库组成统一提供消防基础数据存储、访问和交换的消防数据整合平台。
数据审计记录dataauditingrecord对基础数据库中基础数据进行增、剧、改等操作的记录信息，以下简称审计记录。3.4
数据服务
dataservice
对消防基础数据的增删改查、批量导人、数据字典查询以及审计记录查询等服务的总称，以下简称服务。
4平台接口
4.1接口功能
平台应对应用实体提供数据增别改查服务、数据批量导人服务、数据字典查询服务、数据审计记录查询服务和数据变更消息通知等五类接口，功能如下a）数据增删改查服务接口：对基础数据库中基础数据进行增加、剧除、修改和查询操作；1
GA/T1036-—2012
数据批量导人服务接口：将基础数据批量导人基础数据库中；数据字典查询服务接口：对基础数据库中的数据字典进行查询；数据审计记录查询服务接口：对基础数据的审计记录进行查询；数据变更消息通知接口：通过信息交换平台将基础数据的变更消息发送给订阅者。接口参数
类名称和说明
平台接口使用的自定义类名称和说明见表1。表1类名称和说明
类名称
authinfoEntity
entity
returnEntity
queryDataReturn
datadicEntity
datadicReturn
datadicCodeEntity
datadicCodeReturn
commonReturn
argument
object
4.2.2安全验证类
安全验证类，具体要求见4.2.2
某类型数据实体，用户可自定义它的子类作为输人参数用于对基础数据进行增加、剧除和修改操作，子类中的参数根据用户的业务需求设定，如；士兵信愈子类，包括：姓名、警衔、年龄等参数数据增删改查服务返回值，具体要求见4.2.3数据审计记录返回值，具体要求见4.2.4数据字典实体类，具体要求见4.2.5数据字典返回值，具体要求见4.2.6数据字典代码值实体类，为数据字典代码的值域数据字典代码值返回值，具体要求见4.2.7数据批量导人返回值，具体要求见4.2.8查询参数类，用户可自定义它的子类作为输人参数用于数据查询操作，子类中的参数根据用户的业务需求设定，如：消防机构信息查询子类，包括：机构名称、机构代码、地址、地理坐标等参数某类型数据实体对象，用于数据查询的输出。根据不间的查询输出对象，转换成不同的数据类型，如；文字的转换成字符型，照片转换成二进制数等
用来封装安全验证信息，接口调用时需在服务头传人该类，参数见表2。表2
用户名
userID
password
数据增删改查服务返回值
安全验证参数
string
string
数据增改查服务的返回值信息，参数见表3。2
应用系统代码
调用结果代码
调用结果信息
总记录数
总页数
当前页
页记录数
返回数据
message
数据增翻改意服务返回值参数
string
string
totalRowCount
totalPageCount
currentPageNo
pageSize
result
数据审计记录返回值
objectE
基础数据审计记录的返回值信息，参数见表4，表4www.bzxz.net
调用结果代码
调用结果信息
是否返回全部数据
最大审计记录ID号
最近审计时间
增加、修改记录
除记录
数据字典实体类
数据字典实体类参数见表5。
调用结果消息代码
调用结果消息代码信息
增删改数据的总行数，或查
询结果数据总行数
查询结果数据总页数
查询结果数据当前页
查询结果数据每页记录数
查询结果数据列表
数据审计记录返回值参数
message
returnAll
returnMaxId
returnMaxTime
addUpdateRecords
deleteRecords
string
string
Boolean
string
string
string
string
调用结果消息代码
GA/T1036—2012
仅查询服务有反
仅查询服务有反
仅查询服务有反
仅查询服务有反
调用结果消息代码信息
所有表的或某一表的最
大审计记录ID号
所有表的或某一表的最
近审计记录时间
GA/T1036—2012
数据字典ID
数据字典名称
数据字典标识
数据字典类型
数据字典描述
使用级别
数据字典返回值
数据字典返回值参数见表6。
调用结果代码
调用结果信息
记录数
数据字典
数据字典实体
datadicID
datadicName
datadicSign
datadicSort
deseription
useLevel
message
string
string
string
string
string
string
string
数据字典返回值参数
string
string
string
datadicEntity
数据字典代码值返回值
数据字典代码值返回值参数见表7。表7
调用结果代码
调用结果信息
记录数
数据字典代码值
datadicEntity
数据字典代码值返回值参数
message
datadicCodeEntity
数据批量导入服务返回值
数据批量导入服务的返回值信息，参数见表8。4
string
string
string
datadicCodeEntity
数据字典ID号
数据字典名称
数据字典标识
数据字典类型
数据字典描述
数据字典是否有效
使用单位的级别
调用结果消息代码
调用结果消息代码
信息描递
数据字典信息
调用结果消息代码
调用结果消息代码
信息描述
数据字典代码的
调用结果代码
调用结果信息
接口描述
数据批量导入服务返回值参数
message
数据增删改查服务接口
总体描述
string
string
GA/T1036-—2012
调用结果消息代码
调用结果消息代码
信息描述
实现对消防基础数据库中基础数据的增加、除、修改和查询四种功能，描述见表9，其中查询应支持分页查询，每页记录数小于100条。表9数据增翻改查服务接口
接口名称
接口名称标识
提供方
发起方
接收方
接口类型
包含操作
数据增加
数据增翻改查服务接口
serviceExecute
基础数据平台
应用实体
基础数据平台
WebService
1.数据增加，2.数据删除，3.数据修改，4.数据查询数据增加的输入、输出参数见表10。表10
输人、输出
returnEntity
entity子类
returnEntity
数据增加输入，输出参数
需增加的数据实体类
code,messsgetotalRowCount有
值，其他参数无值
GA/T1036—2012
数据型除
数据删除的输入、输出参数见表11。表11
数据删除输入、输出参数
输人、输出
returnEntity
数据修改
entity子类
returnEntity
数据修改的输人、输出参数见表12。说明
除数据实体类
code,message,totalRowCount
有值，其他参数无值
数据修改输入、输出参数
输人、输出
returnEntity
数据查询
entity子类
returnEntity
数据查询的输人、输出参数见表13。说明
需修改数据实体类
cade,message,totalRowCount
有值，其他参数无值
数据查询输入、输出参数
输入、输出
returnEntity
数据批量导入服务接口
总体描述
argument子类
returnEntity
需查询的数据实体类
Code,messagetotalRowCount.
totalPageCount，currentPageNopageSize，result有值
实现将批量采集的基础数据打包成XML格式成批量导人消防基础库，描述见表14，一次批量导人的数据量应控制在1000条数据以下。6
接口名称
接口名称标识
提供方
发起方
接收方
接口类型
包含操作
数据批量导入
数据批量导入服务接口
数据批量导人服务接口
importData
基础数据平台
应用实体
基础数据平台
WebService
数据批量导人
数据批量导人的输入，输出参数见表15。表15
输人、输出
addUpdateXmi
deleteXml
commonReturn
批量导入数据格式
string
string
数据批量导入输入、输出参数
commonReturn
增加、修改的数据审
删除的数据申
GA/T1036—2012
格式见4.3.2.3
格式见4.3.2.3
批量导人数据操作时输人参数的数据组织方式，由数据集标签、表名标签<表名>，字段名称标签<字段名称、数据组成，具体格式见示例。示例：
一数据集
<表名1>
<字段名1>具体数据
<字段名2>具体数据
<字段名3><！[CDATALyyy-mm-ddhh：mm:ss>-时间格式<字段名n/>

<表名n>
<字段名1>具体数据
<字段名2>具体数据
<字段名3>一时间格式<字段名n/>


GA/T1036-—2012
数据字典查询服务接口
总体描述
实现查询数据字典主表及子表相关数据，描述见表16。表16
接口名称
接口名称标识
提供方
发起方
接收方
接口类型
包含操作
数据字典查询
数据字典查询服务接口
数据字典查询服务接口
基础数据平台
应用实体
基础数据平台
WebService
1.数据字典查询，2.数据字典变更查询，3.数据字典代码值查询，4.根据数据字典ID号查询数据字典代码值
数据字典查询的输入、输出参数见表17。表17
输人、输出
dataDicName
dataDieSign
dataDicSort
useLevel
pageNo
pageSize
datadicReturn
数据宇典变更查询
数据字典查询输入、输出参数
string
string
string
string
datadicReturn
数据字典变更查询的输入、输出参数见表188
数据字典名称
数据字典标识
数据字典类型
使用单位的级别
页号（从1开始）
页记录数
输入、输出
beginDate
endDate
pageNo
pageSize
datadieReturn
数据字典变更查询输入、输出参数类型
string
string
datadicReturn
数据字典代码值查询
数据字典代码值查询的输人、输出参数见表19说明
查询范图起始时间
查询范围结束时间
页号(从1开始）
页记录数
表19数据字典代码值查询输入、输出参数输人、输出
datadicCode
pageNo
pageSize
datadicCodeReturn
string
datedicCodeReturn
根据数据字典ID号查询数据字典代码值说明
数据字典中的代码
页号(从1开始）
页记录数
根据数据字典ID号查询数据字典代码值的输入、输出参数见表20，表20
输人，输出
datadicD
pageNo
pageSize
GA/T1036—2012
格式：yyy-mm-dd
格式：yyyy-mm-dd
根据数据字典ID号查询数据字典代码值输入、输出参数类型
string
datadicCodeReturn
datadicCodeReturn
数据审计记录查询服务接口
总体描述
数据字典ID号
页号（从1开始）
页记录数
实现从数据审计记录中将所查询内容打包成XML文件返回，描述见表21。备注
GA/T1036-2012
接口名称
接口名称标识
提供方
发起方
接收方
接口类型
包含操作
数据审计记录查询服务接口
数据审计记录查询服务接口
queryData
基础数据平台
应用实体
基础数据平台
WebService
1.根据审计记录ID号查询，2.根据审计记录ID号范图查询，3.根据审计记录ID号范圈和指定表名查询，4.根据审计记录时间查询，5.根据审计记录时间范图查询，6.根据审计记录时间范围和指定表名查询，7.根据基础数据表ID号和指定表名查询，8.最大审计记录ID号查询，9.指定表的最大审计记录ID号查询根据审计记录ID号查询
根据审计记录ID号查询的输人，输出参数见表22。表22根据审计记录ID号查询输入、输出参数输人，输出
auditID
queryDataReturn
queryDateReturn
根据审计记录ID号范围查询
审计记录ID号
根据审计记录ID号范围查询的输入.输出参数见表23，表23
根据审计记录ID号范围查询输入、输出参数输人、输出
begin_auditID
end_auditID
queryDataReturn
queryDataReturn
根据审计记录ID号范围和指定表名查询说明
查询范圈起始审计记
桑ID号
查询范围结束审计记
录D号
根据审计记录ID号范围和指定表名查询的输入、输出参数见表2410
查询范图内最小审计记录
查询范围内最大审计记录
小提示：此标准内容仅展示完整标准里的部分截取内容，若需要完整标准请到上方自行免费下载完整标准文档。