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