發布日期：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規定的具體查詢參數。
以上為標準部分內容，如需看標準全文，請到相關授權網站購買標準正版。
