ICS35.020CCSL70DB65/T4776.3—2024社區(qū)管理基礎(chǔ)數(shù)據(jù)采集系統(tǒng)第3部分：接口協(xié)議要求Basicdatacollectionsystemforcommunitymanagement—Part3:Interfaceprotocolrequirements新疆維吾爾自治區(qū)市場監(jiān)督管理局發(fā)布IDB65/T4776.3—2024前言 12規(guī)范性引用文件 13術(shù)語和定義 14縮略語 15接口協(xié)議結(jié)構(gòu) 16接口功能 27接口資源描述 38接口消息 59消息交互流程 810消息交互安全性 8附錄A(規(guī)范性)接口消息對(duì)象特征屬性 9附錄B(規(guī)范性)接口消息對(duì)象和對(duì)象集合JSONSchema描述 DB65/T4776.3—2024本文件按照GB/T1.1—2020《標(biāo)準(zhǔn)化工作導(dǎo)則第1部分：標(biāo)準(zhǔn)化文件的結(jié)構(gòu)和起草規(guī)則》的規(guī)定起草。本文件是DB65/T4776《社區(qū)管理基礎(chǔ)數(shù)據(jù)采集系統(tǒng)》的第3部分。DB65/T4776已經(jīng)發(fā)布了以下內(nèi)——第1部分：數(shù)據(jù)元；——第2部分：數(shù)據(jù)采集規(guī)范；——第3部分：接口協(xié)議要求。本文件由新疆維吾爾自治區(qū)工業(yè)和信息化廳提出、歸口并組織實(shí)施。本文件起草單位：中通服公眾信息產(chǎn)業(yè)股份有限公司、桂林遠(yuǎn)望智能通信科技有限公司、新疆維吾爾自治區(qū)財(cái)政廳信息網(wǎng)絡(luò)中心、中電信數(shù)智科技有限公司新疆分公司。本文件主要起草人：王秀英、蔡曉東、陳郁青、車?yán)^江、王權(quán)、馬新成、魏晟坤、李英、王昱、凌肖、郭莎、王籽懿。本文件實(shí)施應(yīng)用中的疑問，請(qǐng)咨詢中通服公眾信息產(chǎn)業(yè)股份有限公司。對(duì)文件的修改意見建議，請(qǐng)反饋至新疆維吾爾自治區(qū)工業(yè)和信息化廳(烏魯木齊市友好南路179號(hào))、中通服公眾信息產(chǎn)業(yè)股份有限公司(烏魯木齊市黃河路191號(hào))、新疆維吾爾自治區(qū)市場監(jiān)督管理局(烏魯木齊市新華南路167號(hào))郵編：830000中通服公眾信息產(chǎn)業(yè)股份有限公司聯(lián)系電話傳真郵編：830000新疆維吾爾自治區(qū)市場監(jiān)督管理局聯(lián)系電話傳真郵編：8300041DB65/T4776.3—2024本文件規(guī)定了社區(qū)管理基礎(chǔ)數(shù)據(jù)采集系統(tǒng)的接口協(xié)議結(jié)構(gòu)、接口功能、接口資源描述、接口消息、消息交互流程、消息交互安全性的要求。本文件適用于對(duì)社區(qū)管理基礎(chǔ)數(shù)據(jù)的人工或外部系統(tǒng)的采集、交互、處理和存儲(chǔ)。2規(guī)范性引用文件下列文件中的內(nèi)容通過文中的規(guī)范性引用而構(gòu)成本文件必不可少的條款。其中，注日期的引用文件，僅該日期對(duì)應(yīng)的版本適用于本文件；不注日期的引用文件，其最新版本(包括所有的修改單)適用于本文件。GA/T1400.4—2017公安視頻圖像信息應(yīng)用系統(tǒng)第4部分：接口協(xié)議要求DB65/T4776.1—2023社區(qū)管理基礎(chǔ)數(shù)據(jù)采集系統(tǒng)第1部分：數(shù)據(jù)元IETFRFC2616超文本傳輸協(xié)議—HTTP/1.1(HypertextTransferProtocol—HTTP/1.1)3術(shù)語和定義DB65/T4776.1—2023、GA/T1400.4-2017界定的術(shù)語和定義適用于本文件。4縮略語下列縮略語適用于本文件HTTP:超文本傳輸協(xié)議(HyperTextTransferProtocol)JSONSchema:對(duì)象標(biāo)記語言模式(JavaScriptObjectNotationSchema)R:讀取(Read)REST:表述性狀態(tài)傳遞(RepresentationalStateTransfer)TCP:傳輸控制協(xié)議(TransmissionControlProtocol)UDP:用戶數(shù)據(jù)報(bào)協(xié)議(UserDatagramProtocol)URI:統(tǒng)一資源標(biāo)識(shí)符(UniformResourceIdentifier)5接口協(xié)議結(jié)構(gòu)5.1接口交互關(guān)系社區(qū)管理基礎(chǔ)數(shù)據(jù)采集系統(tǒng)提供公共功能接口、數(shù)據(jù)查詢接口、數(shù)據(jù)接收接口三類接口，為外部系統(tǒng)提供公共功能、數(shù)據(jù)查詢、數(shù)據(jù)接收等服務(wù)，接口交互關(guān)系見圖1。2DB65/T4776.3—2024公共功能接口請(qǐng)求公共功能接口請(qǐng)求公共功能處理結(jié)果數(shù)據(jù)查詢接口請(qǐng)求外部系統(tǒng)"數(shù)據(jù)查詢結(jié)果數(shù)據(jù)接收接口請(qǐng)求數(shù)據(jù)接收結(jié)果社區(qū)管理基礎(chǔ)數(shù)據(jù)采集系統(tǒng)圖1接口交互關(guān)系圖5.2協(xié)議結(jié)構(gòu)5.2.1應(yīng)采用REST架構(gòu)定義，接口消息對(duì)象數(shù)據(jù)傳輸時(shí)采用JSON格式序列化。接口協(xié)議結(jié)構(gòu)見圖2。分析接口圖2接口協(xié)議結(jié)構(gòu)圖5.2.2所有接口交互信息定義為REST架構(gòu)下的資源，使用URI唯一標(biāo)識(shí)。5.2.3接口交互連接方式應(yīng)支持HTTP長連接和短連接，實(shí)現(xiàn)機(jī)制應(yīng)符合IETFRFC2616的規(guī)定。5.2.4外部系統(tǒng)的接口訪問形式應(yīng)符合GA/T1400.4-2017中A.3的規(guī)定。6接口功能6.1公共功能接口應(yīng)符合GA/T1400.4—2017中5.1的規(guī)定。6.2數(shù)據(jù)查詢接口3DB65/T4776.3—20246.2.1應(yīng)支持外部系統(tǒng)從社區(qū)管理基礎(chǔ)數(shù)據(jù)采集系統(tǒng)查詢門禁設(shè)備列表、門禁設(shè)備關(guān)聯(lián)的全部準(zhǔn)入人員數(shù)據(jù)，以及一段時(shí)間內(nèi)門禁設(shè)備關(guān)聯(lián)準(zhǔn)入人員的變更數(shù)據(jù)。6.2.2應(yīng)支持外部系統(tǒng)從社區(qū)管理基礎(chǔ)數(shù)據(jù)采集系統(tǒng)查詢車輛抓拍設(shè)備列表、車輛抓拍設(shè)備關(guān)聯(lián)的全部準(zhǔn)入車輛信息，以及一段時(shí)間內(nèi)車輛抓拍設(shè)備關(guān)聯(lián)準(zhǔn)入車輛的變更數(shù)據(jù)。6.2.3數(shù)據(jù)查詢接口和第8章接口消息的對(duì)應(yīng)關(guān)系見表1。表1數(shù)據(jù)查詢接口與接口消息對(duì)照表123全部準(zhǔn)入人員數(shù)據(jù)R消息4全部準(zhǔn)入車輛數(shù)據(jù)R消息566.3數(shù)據(jù)接收接口6.3.1應(yīng)支持從外部系統(tǒng)接收人員進(jìn)出信息。6.3.2應(yīng)支持從外部系統(tǒng)接收車輛進(jìn)出信息。6.3.3數(shù)據(jù)接收接口和第8章接口消息的對(duì)應(yīng)關(guān)系見表2。表2數(shù)據(jù)接收接口與接口消息對(duì)照表127接口資源描述7.1接口資源URI見表3。4DB65/T4776.3—2024表3接口資源URI序號(hào)資源URI說明1/DCS頂級(jí)資源2DCS/System/Register注冊(cè)3DCS/System/UnRegister注銷4DCS/System/Keepalive?；?/DCS/System/Time校時(shí)6/DCS/api/person/device/list查詢門禁設(shè)備列表7DCS/api/vehicle/device/list查詢車輛抓拍設(shè)備列表8/DCS/api/device/persons查詢?nèi)块T禁設(shè)備關(guān)聯(lián)的全部準(zhǔn)入人員數(shù)據(jù)9DCS/api/device/vehicles查詢?nèi)寇囕v抓拍設(shè)備關(guān)聯(lián)的全部準(zhǔn)入車輛數(shù)據(jù)/DCS/api/device/persons/<DEVICE_NUMBER>根據(jù)門禁設(shè)備編號(hào)，查詢門禁設(shè)備關(guān)聯(lián)的準(zhǔn)入人員變更數(shù)據(jù)/DCS/api/device/vehicles/<DEVICE_NUMBER>根據(jù)車輛抓拍設(shè)備編號(hào)，查詢車輛抓拍設(shè)備關(guān)聯(lián)的準(zhǔn)入車輛變更數(shù)據(jù)/DCS/api/person/inout/record人員進(jìn)出信息接收/DCS/api/vehicle/inout/record車輛進(jìn)出信息接收7.2.1資源對(duì)象類型資源對(duì)象(以下簡稱“對(duì)象”)包括設(shè)備對(duì)象、人員對(duì)象、車輛對(duì)象、人員進(jìn)出信息對(duì)象、車輛進(jìn)出信息對(duì)象等接口消息對(duì)象。7.2.2對(duì)象描述方法對(duì)象應(yīng)按以下方法進(jìn)行描述：a)通過“對(duì)象名稱”、“對(duì)象標(biāo)簽”、“對(duì)象集合標(biāo)簽”、“對(duì)象特征屬性”、“JSONSchema描述”等屬性進(jìn)行描述；b)對(duì)象的特征屬性應(yīng)符合本文件附錄A的要求；c)對(duì)象及對(duì)象集合的JSONSchema描述應(yīng)符合本文件附錄B的要求。7.2.3接口消息對(duì)象見表4。5DB65/T4776.3—2024表4接口消息對(duì)象序號(hào)對(duì)象名稱對(duì)象標(biāo)簽對(duì)象集合標(biāo)簽對(duì)象特征屬性JSONSchema描述1應(yīng)答狀態(tài)對(duì)象ResponseStatus一應(yīng)符合A.3的規(guī)定應(yīng)符合B.1的規(guī)定2設(shè)備對(duì)象DeviceInfoResponseDeviceList應(yīng)符合A.4的規(guī)定應(yīng)符合B.2的規(guī)定3人員對(duì)象PersonInfoResponsePersonList應(yīng)符合A.5的規(guī)定應(yīng)符合B.3的規(guī)定4車輛對(duì)象VehicleInfoResponseVehicleList應(yīng)符合A.6的規(guī)定應(yīng)符合B.4的規(guī)定5人員進(jìn)出信息對(duì)象PersonInoutRecord一應(yīng)符合A.7的規(guī)定應(yīng)符合B.5的規(guī)定6車輛進(jìn)出信息對(duì)象VehicleInoutRecord一應(yīng)符合A.8的規(guī)定應(yīng)符合B.6的規(guī)定8接口消息8.1接口消息描述8.1.1接口消息描述格式見表5。表5接口消息描述URI功能方法查詢字符串消息體返回結(jié)果POSTGETPUTDELETE注釋8.1.2表5各項(xiàng)說明如下：—URI項(xiàng)描述資源URI; —方法項(xiàng)列出資源涉及的HTTP方法，包括POST、GET、PUT及DELETE;—-查詢字符串項(xiàng)描述資源的“鍵-值對(duì)”; 消息體項(xiàng)說明HTTP請(qǐng)求的消息體； 返回結(jié)果項(xiàng)描述HTTP請(qǐng)求的響應(yīng)；——注釋項(xiàng)給出接口消息的特殊說明；——接口消息Content-Type頭部域應(yīng)設(shè)為application/*+JSON。6DB65/T4776.3—20248.2公共功能接口消息8.2.1注冊(cè)消息應(yīng)符合GA/T1400.4—2017中7.3.1的規(guī)定。8.2.2注銷消息應(yīng)符合GA/T1400.4-2017中7.3.2的規(guī)定。8.2.3保活消息應(yīng)符合GA/T1400.4-2017中7.3.3的規(guī)定。8.2.4校時(shí)消息8.3數(shù)據(jù)查詢接口消息8.3.1門禁設(shè)備列表R消息見表6。表6門禁設(shè)備列表R消息URI/DCS/api/person/device/list功能查詢門禁設(shè)備列表方法查詢字符串消息體返回結(jié)果GET無無<ResponseDeviceList>注釋ResponseDeviceList的定義應(yīng)符合A.4的規(guī)定8.3.2車輛抓拍設(shè)備列表R消息見表7。表7車輛抓拍設(shè)備列表R消息URI/DCS/api/vehicle/device/list功能查詢車輛抓拍設(shè)備列表方法查詢字符串消息體返回結(jié)果GET無無<ResponseDeviceList>注釋ResponseDeviceList的定義應(yīng)符合A.4的規(guī)定8.3.3全部準(zhǔn)入人員數(shù)據(jù)R消息見表8。7表8全部準(zhǔn)入人員數(shù)據(jù)R消息查詢字符串無無ResponsePersonList的定義應(yīng)符合8.3.4全部準(zhǔn)入車輛數(shù)據(jù)R消息表9全部準(zhǔn)入車輛數(shù)據(jù)R消息查詢字符串無無ResponseVehicleList的定義8.3.5準(zhǔn)入人員變更數(shù)據(jù)R消息表10準(zhǔn)入人員變更數(shù)據(jù)R消息/DCS/api/device/persons/<DEV查詢字符串無無ResponsePersonList的定義應(yīng)8.3.6準(zhǔn)入車輛變更數(shù)據(jù)R消息表11準(zhǔn)入車輛變更數(shù)據(jù)R消息URI/DCS/api/device/vehicles/<DEVICE_NUMBER>功能根據(jù)車輛抓拍設(shè)備編號(hào)，獲取車輛抓拍設(shè)備關(guān)聯(lián)的準(zhǔn)入車輛變更數(shù)據(jù)方法查詢字符串消息體返回結(jié)果GET無無<ResponseVehicleList>注釋ResponseVehicleList的定義應(yīng)符合A.6的規(guī)定8.4數(shù)據(jù)接收接口消息8DB65/T4776.3—20248.4.1人員進(jìn)出信息C消息見表12。表12人員進(jìn)出信息C消息URIDCS/api/person/inout/record功能存儲(chǔ)人員進(jìn)出信息方法查詢字符串消息體返回結(jié)果POST無<PersonInoutRecord><ResponseStatus>注釋ResponseStatus的定義應(yīng)符合A.3的規(guī)定PersonlnoutRecord的定義應(yīng)符合A.7的規(guī)定8.4.2車輛進(jìn)出信息C消息見表13。表13車輛進(jìn)出信息C消息DCS/api/vehicle/inout/record存儲(chǔ)車輛進(jìn)出信息查詢字符串消息體返回結(jié)果無<VehicleInoutRecord><ResponseStatus>ResponseStatus的定義應(yīng)符合A.3的規(guī)定VehicleInoutRecord的定義應(yīng)符合A.8的規(guī)定9消息交互流程應(yīng)符合GA/T1400.4-2017中第8章的規(guī)定。10消息交互安全性應(yīng)符合GA/T1400.4-2017中第9章的規(guī)定。9DB65/T4776.3—2024(規(guī)范性)接口消息對(duì)象特征屬性A.1基礎(chǔ)數(shù)據(jù)類型特征屬性見表A.1。表A.1基礎(chǔ)數(shù)據(jù)類型表說明字符串一一一一一一A.2表中選項(xiàng)字符說明應(yīng)符合以下要求：a)R=requirement表示必選字段；O=Option表示可選字段；R/O表示特定條件下必選，其他可選；b)字段長度應(yīng)符合DB65/T4776.1—2023中5.4的規(guī)定；c)在多值情況時(shí)，類型欄只標(biāo)識(shí)單值的類型，長度只標(biāo)識(shí)單值的長度。A.3應(yīng)答狀態(tài)對(duì)象特征屬性見表A.2。表A.2應(yīng)答狀態(tài)對(duì)象特征屬性選說明1R2R為本次操作的響應(yīng)說明3一RA.4設(shè)備對(duì)象及列表A.4.1設(shè)備列表對(duì)象DB65/T4776.3—2024特征屬性見表A.3。表A.3設(shè)備列表對(duì)象特征屬性序號(hào)名稱標(biāo)識(shí)符類型JSON長度必選/可選說明1狀態(tài)碼codestringc..3R0-正常1-參數(shù)格式錯(cuò)誤2-參數(shù)內(nèi)容無效3-系統(tǒng)忙9-其他未知錯(cuò)誤2狀態(tài)描述messagestringc..255R為本次操作的響應(yīng)說明3列表內(nèi)容resultList<DeviceInfo>一一DeviceInfo的定義應(yīng)符合A.4.2的規(guī)定A.4.2設(shè)備對(duì)象特征屬性見表A.4。表A.4設(shè)備對(duì)象特征屬性說明1R定2R定3R定4號(hào)R定50定60定7R定8R定A.5人員對(duì)象及列表A.5.1人員列表對(duì)象特征屬性見表A.5。DB65/T4776.3—2024表A.5人員列表對(duì)象特征屬性說明1R2R為本次操作的響應(yīng)說明3一一A.5.2人員對(duì)象特征屬性見表A.6。表A.6人員對(duì)象特征屬性說明1R2人員姓名R定30定4人員照片0定5R6集時(shí)間RA.6車輛對(duì)象及列表A.6.1車輛列表對(duì)象特征屬性見表A.7。表A.7車輛列表對(duì)象特征屬性序號(hào)名稱標(biāo)識(shí)符類型JSON長度必選/可選說明1狀態(tài)碼codestringc..3R0-正常1-參數(shù)格式錯(cuò)誤2-參數(shù)內(nèi)容無效3-系統(tǒng)忙9-其他未知錯(cuò)誤2狀態(tài)描述messagestringc..255R為本次操作的響應(yīng)說明3列表內(nèi)容resultList<VehicleInfo>一一VehicleInfo的定義應(yīng)符合A.6.2的規(guī)定A.6.2車輛對(duì)象DB65/T4776.3—2024特征屬性見表A.8。表A.8車輛對(duì)象特征屬性說明1R2R3R4R506車輛車身0708090車輛信息采集時(shí)間R定A.7人員進(jìn)出信息對(duì)象特征屬性見表A.9。表A.9人員進(jìn)出信息對(duì)象特征屬性說明1人員進(jìn)出R2R3進(jìn)出人員姓名R4照片URI05開門時(shí)間R6RA.8車輛進(jìn)出信息對(duì)象特征屬性見表A.10。表A.10車輛進(jìn)出信息對(duì)象特征屬性序號(hào)名稱標(biāo)識(shí)符類型JSON長度必選/可選說明DB65/T4776.3—2024說明1號(hào)R定2號(hào)RDB65/T4776.1—2023中7.63碼R定40定50定60定7全景圖URI0定8抓拍圖URIR定9抓拍圖在全景圖0定抓拍圖在全景圖0定00定抓拍時(shí)間R應(yīng)符合DB65/T4776.1—202DB65/T4776.3—2024(規(guī)范性)接口消息對(duì)象和對(duì)象集合JSONSchema描述B.1應(yīng)答狀態(tài)對(duì)象//應(yīng)答狀態(tài)對(duì)象"code":"string","message":"string","result":"bool"}B.2設(shè)備對(duì)象//設(shè)備對(duì)象{"DEVICE_NUMBER":"string","DEVICE_NAME":"string","DEVICE_TYPE":"int","DEVICE_SN":"string","DEVICE_POSITION_LNG":"double","DEVICE_POSITION_LAT":"double","DEVICE_STATUS":"string","DEVICE_COLLECT_TIME":"dateTime"}//設(shè)備列表對(duì)象"code":"string","message":"string","result":[{{}}B.3人員對(duì)象{DB65/T4776.3—2024"PERSONNUMBER":"string","PERSON_NAME":"string","ID_NUMBER":"string","PERSON_PHONE_URI":"string","PERSON_TYPE":"int","PERSON_COLLECT_TIME":"dateTime"http://人員列表對(duì)象"code":"string","message":"string","result":[{}]B.4車輛對(duì)象"VEHICLE_NUMBER":"string","PLATE_NUMBER":"string","PLATE_COLOR_CODE":"string","PLAT