发布日期：2022-11-01 19:57 浏览次数：
GB 26875的本部分规定了城市消防远程监控系统监控中心对外数据交换协议的缩略语、XMLSchema定义、一般要求、数据查询接口和数据实时发布接口。
本部分适用于城市消防远程监控系统监控中心与外部系统之间的数据交换。
下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。
GB 18030 信息技术 中文编码字符集
GB/T 26875.4-2011 城市消防远程监控系统 第4部分：基本数据项
GB 50440 城市消防远程监控系统技术规范
RFC 2616 超文本传输协议（Hypertext Transfer Protocol-HTTP/1.1）
RFC 2818 超文本传输安全协议（HTTP Over TLS）
RFC 3023 XML媒体类型（XML Media Types）
RFC 3629 ISO 10646的转换格式（UTF-8，a transformation format of ISO 10646）
RFC 6749 OAuth 2.0 认证框架（The OAuth 2.0 Authorization Framework）
GB 50440界定的术语和定义适用于本文件。
下列缩略语适用于本文件。
HTTP：超文本传输协议（Hypertext Transfer Protocol）
HTTPS：超文本传输安全协议（HTTP Over TLS）
REST：表述性状态转移（Representational State Transfer）
URI：统一资源标识符（Uniform Resource Identifier）
XML：可扩展标记语言（eXtensible Markup Language）
XML Schema：可扩展标记语言架构定义（XML Schema Definition）
5.1 GB/T 26875.4-2011中规定的各类信息的XML Schema定义见附录A。
5.2 数据订阅请求、取消数据订阅请求、数据订阅响应及相关数据通知的XML Schema定义见附录B。
5.3 附录A、附录B所述XML Schema中引用的公用数据类型的XML Schema定义见附录C。
6.1 本协议使用的字符集应满足GB18030或RFC 3629的规定。
6.2 本协议应以HTTP或HTTPS协议作为底层承载协议。采用HTTP协议时，应满足 RFC 2616的规定；采用HTTPS协议时，应满足RFC 2818的规定。
6.3 本协议宜采用OAuth 2.0协议进行客户端验证和授权，并满足RFC6749的规定。
6.4 监控中心如未能处理接收到的请求时，返回的HTTP响应的状态代码（Status Code）应是400，实体主体（Entity Body）应是RFC 3023中描述的媒体类型为“application/xml”的错误响应。错误响应的XML Schema定义见A．15，其中description元素为错误描述；code元素为错误代码，取值范围为1～9999，仅1000～9999用于自定义错误，错误代码的定义见表1。
表1 错误代码表
错误代码 | 错误含义 |
1 | 未知错误 |
2 | 监控中心暂时停止数据交换服务 |
3 | 监控中心不支持的数据交换请求 |
4 | 客户应用的身份无法确定 |
5 | 客户应用被禁用 |
6 | 客户应用的IP被禁止 |
7 | 客户应用的请求频率超过限制 |
8 | 客户应用的权限不足 |
9 | 请求参数无效 |
10 | 请求参数缺失 |
11 | 请求无法被处理 |
100 | 监控中心不存在指定的数据 |
200 | 订阅请求无法添加 |
201 | 取消订阅时，subscribe＿id不存在 |
1000~9999 | 自定义 |
7.1 数据查询请求
7.1.1 任何查询请求应支持表2规定的通用查询参数。
表2 通用查询参数
参数名称 | 类型 | 是否必需 | 描述 |
format | 字符型 | 否 | 响应数据格式，可以为xml，默认值为xml |
ie | 字符型 | 否 | 查询请求的编码类型，可以为UTF-8或GBK，默认值为UTF-8 |
oe | 字符型 | 否 | 响应数据的编码类型，可以为UTF-8或GBK，默认值为UTF-8 |
page_no | 整数型 | 否 | 用于支持数据集合分页，表示第几页，默认值为1 |
page_size | 整数型 | 否 | 用于支持数据集合分页，表示每页返回多少条数据，默认值为20 |
7.1.2 查询请求接口应支持HTTP的GET方法。
注：GET方法是HTTP规定的客户端与服务器的交互方法之一，一般用于获取或查询资源信息。
7.1.3 查询请求接口应采用REST风格的HTTP接口，接口URL基本格式为http（s）：//．．．/openapi/vl/query/｛uri｝｛query＿string｝，其中｛uri｝应支持7.3规定的各类查询的｛uri｝路径，｛uri｝可在任何“/”处截止，不以“/”结尾；｛query＿string｝由通用查询参数和具体查询参数组合而成，在格式上，以“？”字符为起点，每个参数以“＆”隔开，再以“＝”分开参数名称与参数值，同一参数的参数值如有多个，则以“，”连接参数值。如？keyl＝value＆．key2＝value21，value22＆．．．．．
7.2 数据查询响应
7.2.1 查询响应数据的格式由查询请求的format参数指定。
7.2.2 查询响应数据的编码类型由查询请求的oe参数指定。
7.3 数据查询细则
7.3.1 监控中心查询
7.3.1.1 ｛uri｝为jkzx＿list/｛jkzx＿guid｝。
7.3.1.2 ｛query＿string｝可使用表3规定的具体查询参数。
表3 监控中心具体查询参数
项目名称 | 参数名称 |
中心名称 | zxmc |
所属区域 | ssqy |
中心详址 | ZXXZ |
中心级别 | zxjb |
上级中心名称 | sjzxmc |
7.3.1.3 响应数据的XML Schema定义见A．1。
7.3.2 监控人员查询
7.3.2.1 ｛uri｝为jkzx＿list/｛jkzx＿guid｝/jkry＿list/｛jkry＿guid｝。
7.3.2.2｛query＿string｝除可以使用7.3.1.2规定的参数外，还可使用表4规定的具体查询参数。
以上为标准部分内容，如需看标准全文，请到相关授权网站购买标准正版。
