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

ICS35.240

A90

中华人民共和国公共安全行业标准

/—

GAT10362012

消防基础数据平台接口规范

Secificationsforthebasicfiredatalatforminterfaces

pp

ㅤㅤㅤㅤ

2012-12-26发布2013-01-01实施

中华人民共和国公安部发布

/—

GAT10362012

消防基础数据平台接口规范

1范围

()()

本标准规定了消防基础数据平台以下简称平台对应用实体提供的软件接口以下简称接口功能

及参数。

,()

本标准适用于消防基础数据平台以及需要对消防基础数据以下简称基础数据进行访问和交换

的应用实体的开发和应用。

2规范性引用文件

。,

下列文件对于本文件的应用是必不可少的凡是注日期的引用文件仅注日期的版本适用于本文

。,()。

件凡是不注日期的引用文件其最新版本包括所有的修改单适用于本文件

/—:

消防公共服务平台技术规范第部分总体架构及功能要求

GAT1038.120121

/—:

消防公共服务平台技术规范第部分信息交换接口

GAT1038.320123

、

3术语定义和缩略语

/—、ㅤㅤㅤㅤ。

GAT1038.12012界定的以及下列术语定义和缩略语适用于本文件

3.1

消防基础数据basicfiredata

整体反映消防业务概况的各业务数据。

3.2

消防基础数据平台redatalatform

thebasicfip

、

由基础数据平台软件和基础数据库组成统一提供消防基础数据存储访问和交换的消防数据整合

平台。

3.3

数据审计记录dataauditinrecord

g

、、,。

对基础数据库中基础数据进行增删改等操作的记录信息以下简称审计记录

3.4

数据服务dataservice

、、,

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

服务。

4平台接口

4.1接口功能

、、、

平台应对应用实体提供数据增删改查服务数据批量导入服务数据字典查询服务数据审计记录

,:

查询服务和数据变更消息通知等五类接口功能如下

):、、;

a数据增删改查服务接口对基础数据库中基础数据进行增加删除修改和查询操作

1

/—

GAT10362012

):;

b数据批量导入服务接口将基础数据批量导入基础数据库中

):;

c数据字典查询服务接口对基础数据库中的数据字典进行查询

):;

d数据审计记录查询服务接口对基础数据的审计记录进行查询

):。

e数据变更消息通知接口通过信息交换平台将基础数据的变更消息发送给订阅者

4.2接口参数

4.2.1类名称和说明

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

表1类名称和说明

序号类名称说明

,

1authInfoEntit安全验证类具体要求见4.2.2

y

,

某类型数据实体用户可自定义它的子类作为输入参数用于对基础

、,

2entit数据进行增加删除和修改操作子类中的参数根据用户的业务需

y

,:,:、、

求设定如士兵信息子类包括姓名警衔年龄等参数

,

3returnEntit数据增删改查服务返回值具体要求见4.2.3

y

,

4uerDataReturn数据审计记录返回值具体要求见4.2.4

qy

,

5datadicEntit数据字典实体类具体要求见4.2.5

y

,

6datadicReturn数据字典返回值具体要求见4.2.6

ㅤㅤㅤㅤ

数据字典代码值实体类,

7datadicCodeEntit为数据字典代码的值域

y

,

8datadicCodeReturn数据字典代码值返回值具体要求见4.2.7

,

9commonReturn数据批量导入返回值具体要求见4.2.8

,

查询参数类用户可自定义它的子类作为输入参数用于数据查询操

,,:

10arument作子类中的参数根据用户的业务需求设定如消防机构信息查询

g

,:、、、

子类包括机构名称机构代码地址地理坐标等参数

,。

某类型数据实体对象用于数据查询的输出根据不同的查询输出

[],,:,

11obect对象转换成不同的数据类型如文字的转换成字符型照片转换

j

成二进制数等

4.2.2安全验证类

,,。

用来封装安全验证信息接口调用时需在服务头传入该类参数见表2

表2安全验证参数

序号名称标识类型说明备注

1用户名userIDstring应用系统代码

2密码passwordstring密码

4.2.3数据增删改查服务返回值

,。

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

2

/—

GAT10362012

表3数据增删改查服务返回值参数

序号名称标识类型说明备注

1调用结果代码codestring调用结果消息代码见4.4

调用结果消息代码信息

2调用结果信息messaestrin见4.4

gg

描述

,

增删改数据的总行数或查

3总记录数totalRowCountint

询结果数据总行数

仅查询服务有反

4总页数totalPaeCountint查询结果数据总页数

g

馈值

仅查询服务有反

5当前页currentPaeNoint查询结果数据当前页

g

馈值

仅查询服务有反

6页记录数aeSizeint查询结果数据每页记录数

pg

馈值

仅查询服务有反

返回数据[]查询结果数据列表

7resultobect

j

馈值

4.2.4数据审计记录返回值

ㅤㅤㅤㅤ

,。

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

表数据审计记录返回值参数

4

序号名称标识类型说明备注

1调用结果代码codestring调用结果消息代码见4.4

调用结果消息代码信息

2调用结果信息messaestrin见4.4

gg

描述

3是否返回全部数据returnAllBoolean

所有表的或某一表的最

最大审计记录号

4IDreturnMaxIdstring

大审计记录号

ID

所有表的或某一表的最

5最近审计时间returnMaxTimestring

近审计记录时间

、

6增加修改记录addUdateRecordsstrin

pg

7删除记录deleteRecordsstring

4.2.5数据字典实体类

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

3

/—

GAT10362012

表5数据字典实体

序号名称标识类型说明备注

1数据字典IDdatadicIDstring数据字典ID号

3数据字典名称datadicNamestring数据字典名称

2数据字典标识datadicSinstrin数据字典标识

gg

4数据字典类型datadicSortstring数据字典类型

5数据字典描述descritionstrin数据字典描述

pg

6状态statestring数据字典是否有效

7使用级别useLevelstring使用单位的级别

4.2.6数据字典返回值

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

表6数据字典返回值参数

序号名称标识类型说明备注

1调用结果代码codestring调用结果消息代码见4.4

调用结果消息代码

调用结果信息ㅤㅤㅤㅤ见

2messaestrin4.4

gg

信息描述

3记录数countstring

4数据字典datadicEntit[]datadicEntit数据字典信息

yy

4.2.7数据字典代码值返回值

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

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

序号名称标识