發(fā)布日期：2022-11-01 19:57 瀏覽次數(shù)：
GB 26875的本部分規(guī)定了城市消防遠(yuǎn)程監(jiān)控系統(tǒng)監(jiān)控中心對外數(shù)據(jù)交換協(xié)議的縮略語、XMLSchema定義、一般要求、數(shù)據(jù)查詢接口和數(shù)據(jù)實(shí)時(shí)發(fā)布接口。
本部分適用于城市消防遠(yuǎn)程監(jiān)控系統(tǒng)監(jiān)控中心與外部系統(tǒng)之間的數(shù)據(jù)交換。
下列文件對于本文件的應(yīng)用是必不可少的。凡是注日期的引用文件，僅注日期的版本適用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改單）適用于本文件。
GB 18030 信息技術(shù) 中文編碼字符集
GB/T 26875.4-2011 城市消防遠(yuǎn)程監(jiān)控系統(tǒng) 第4部分：基本數(shù)據(jù)項(xiàng)
GB 50440 城市消防遠(yuǎn)程監(jiān)控系統(tǒng)技術(shù)規(guī)范
RFC 2616 超文本傳輸協(xié)議（Hypertext Transfer Protocol-HTTP/1.1）
RFC 2818 超文本傳輸安全協(xié)議（HTTP Over TLS）
RFC 3023 XML媒體類型（XML Media Types）
RFC 3629 ISO 10646的轉(zhuǎn)換格式（UTF-8，a transformation format of ISO 10646）
RFC 6749 OAuth 2.0 認(rèn)證框架（The OAuth 2.0 Authorization Framework）
GB 50440界定的術(shù)語和定義適用于本文件。
下列縮略語適用于本文件。
HTTP：超文本傳輸協(xié)議（Hypertext Transfer Protocol）
HTTPS：超文本傳輸安全協(xié)議（HTTP Over TLS）
REST：表述性狀態(tài)轉(zhuǎn)移（Representational State Transfer）
URI：統(tǒng)一資源標(biāo)識符（Uniform Resource Identifier）
XML：可擴(kuò)展標(biāo)記語言（eXtensible Markup Language）
XML Schema：可擴(kuò)展標(biāo)記語言架構(gòu)定義（XML Schema Definition）
5.1 GB/T 26875.4-2011中規(guī)定的各類信息的XML Schema定義見附錄A。
5.2 數(shù)據(jù)訂閱請求、取消數(shù)據(jù)訂閱請求、數(shù)據(jù)訂閱響應(yīng)及相關(guān)數(shù)據(jù)通知的XML Schema定義見附錄B。
5.3 附錄A、附錄B所述XML Schema中引用的公用數(shù)據(jù)類型的XML Schema定義見附錄C。
6.1 本協(xié)議使用的字符集應(yīng)滿足GB18030或RFC 3629的規(guī)定。
6.2 本協(xié)議應(yīng)以HTTP或HTTPS協(xié)議作為底層承載協(xié)議。采用HTTP協(xié)議時(shí)，應(yīng)滿足 RFC 2616的規(guī)定；采用HTTPS協(xié)議時(shí)，應(yīng)滿足RFC 2818的規(guī)定。
6.3 本協(xié)議宜采用OAuth 2.0協(xié)議進(jìn)行客戶端驗(yàn)證和授權(quán)，并滿足RFC6749的規(guī)定。
6.4 監(jiān)控中心如未能處理接收到的請求時(shí)，返回的HTTP響應(yīng)的狀態(tài)代碼（Status Code）應(yīng)是400，實(shí)體主體（Entity Body）應(yīng)是RFC 3023中描述的媒體類型為“application/xml”的錯誤響應(yīng)。錯誤響應(yīng)的XML Schema定義見A．15，其中description元素為錯誤描述；code元素為錯誤代碼，取值范圍為1～9999，僅1000～9999用于自定義錯誤，錯誤代碼的定義見表1。
表1 錯誤代碼表
錯誤代碼 | 錯誤含義 |
1 | 未知錯誤 |
2 | 監(jiān)控中心暫時(shí)停止數(shù)據(jù)交換服務(wù) |
3 | 監(jiān)控中心不支持的數(shù)據(jù)交換請求 |
4 | 客戶應(yīng)用的身份無法確定 |
5 | 客戶應(yīng)用被禁用 |
6 | 客戶應(yīng)用的IP被禁止 |
7 | 客戶應(yīng)用的請求頻率超過限制 |
8 | 客戶應(yīng)用的權(quán)限不足 |
9 | 請求參數(shù)無效 |
10 | 請求參數(shù)缺失 |
11 | 請求無法被處理 |
100 | 監(jiān)控中心不存在指定的數(shù)據(jù) |
200 | 訂閱請求無法添加 |
201 | 取消訂閱時(shí)，subscribe＿id不存在 |
1000~9999 | 自定義 |
7.1 數(shù)據(jù)查詢請求
7.1.1 任何查詢請求應(yīng)支持表2規(guī)定的通用查詢參數(shù)。
表2 通用查詢參數(shù)
參數(shù)名稱 | 類型 | 是否必需 | 描述 |
format | 字符型 | 否 | 響應(yīng)數(shù)據(jù)格式，可以為xml，默認(rèn)值為xml |
ie | 字符型 | 否 | 查詢請求的編碼類型，可以為UTF-8或GBK，默認(rèn)值為UTF-8 |
oe | 字符型 | 否 | 響應(yīng)數(shù)據(jù)的編碼類型，可以為UTF-8或GBK，默認(rèn)值為UTF-8 |
page_no | 整數(shù)型 | 否 | 用于支持?jǐn)?shù)據(jù)集合分頁，表示第幾頁，默認(rèn)值為1 |
page_size | 整數(shù)型 | 否 | 用于支持?jǐn)?shù)據(jù)集合分頁，表示每頁返回多少條數(shù)據(jù)，默認(rèn)值為20 |
7.1.2 查詢請求接口應(yīng)支持HTTP的GET方法。
注：GET方法是HTTP規(guī)定的客戶端與服務(wù)器的交互方法之一，一般用于獲取或查詢資源信息。
7.1.3 查詢請求接口應(yīng)采用REST風(fēng)格的HTTP接口，接口URL基本格式為http（s）：//．．．/openapi/vl/query/｛uri｝｛query＿string｝，其中｛uri｝應(yīng)支持7.3規(guī)定的各類查詢的｛uri｝路徑，｛uri｝可在任何“/”處截止，不以“/”結(jié)尾；｛query＿string｝由通用查詢參數(shù)和具體查詢參數(shù)組合而成，在格式上，以“？”字符為起點(diǎn)，每個(gè)參數(shù)以“＆”隔開，再以“＝”分開參數(shù)名稱與參數(shù)值，同一參數(shù)的參數(shù)值如有多個(gè)，則以“，”連接參數(shù)值。如？keyl＝value＆．key2＝value21，value22＆．．．．．
7.2 數(shù)據(jù)查詢響應(yīng)
7.2.1 查詢響應(yīng)數(shù)據(jù)的格式由查詢請求的format參數(shù)指定。
7.2.2 查詢響應(yīng)數(shù)據(jù)的編碼類型由查詢請求的oe參數(shù)指定。
7.3 數(shù)據(jù)查詢細(xì)則
7.3.1 監(jiān)控中心查詢
7.3.1.1 ｛uri｝為jkzx＿list/｛jkzx＿guid｝。
7.3.1.2 ｛query＿string｝可使用表3規(guī)定的具體查詢參數(shù)。
表3 監(jiān)控中心具體查詢參數(shù)
項(xiàng)目名稱 | 參數(shù)名稱 |
中心名稱 | zxmc |
所屬區(qū)域 | ssqy |
中心詳址 | ZXXZ |
中心級別 | zxjb |
上級中心名稱 | sjzxmc |
7.3.1.3 響應(yīng)數(shù)據(jù)的XML Schema定義見A．1。
7.3.2 監(jiān)控人員查詢
7.3.2.1 ｛uri｝為jkzx＿list/｛jkzx＿guid｝/jkry＿list/｛jkry＿guid｝。
7.3.2.2｛query＿string｝除可以使用7.3.1.2規(guī)定的參數(shù)外，還可使用表4規(guī)定的具體查詢參數(shù)。
以上為標(biāo)準(zhǔn)部分內(nèi)容，如需看標(biāo)準(zhǔn)全文，請到相關(guān)授權(quán)網(wǎng)站購買標(biāo)準(zhǔn)正版。
