1DBXX/XXXXX—XXXX農村人居環境長效管護平臺數據交換規范本標準規定了江西省農村人居環境長效管護平臺數據交換的相關術語和定義、設計要求及接口要求。本標準適用于江西省農村人居環境長效管護平臺設計規范。2規范性引用文件下列文件對于本文件的應用是必不可少的。凡是注日期的引用文件，僅所注日期的版本適用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改單）適用于本文件。GB/T29765-2021信息安全技術數據備份與恢復產品技術要求與測試評價方法GB/T20271信息安全技術信息系統通用安全技術要求GB/T20273-2019信息安全技術數據庫管理系統安全技術要求GB/T31496-2015信息技術安全技術信息安全管理體系實施指南GB/T21063.6政務信息資源目錄體系第6部分：技術管理要求GB/T15629信息技術系統間遠程通信和信息交換局域網和城域網GB/T28181-2016安全防范視頻監控聯網系統信息傳輸、交換、控制技術要求DB36/T981-2017電子政務共享數據統一交換平臺技術規范DB36/T984—2017政務服務網集成對接規范DB36/T1179—2019政務數據共享技術規范GB/T33745-2017物聯網術語GB/T36478.1-2018信息交換和共享3術語和定義GB/T33745-2017、GB/T36478.1-2018界定的以及下列術語和定義適用于本文件。3.1農村人居環境長效管護平臺(Rurallivingenvironmentlong-termmanagementplatform)采用物聯網、云計算、大數據、AI等新一代信息技術，通過數字化技術驅動農村人居環境有效治理，實現農村人居環境長效管護數字化、環境監測智能化、公眾監督便捷化。平臺集“投訴、整改、反饋、監督”等功能為一體，以實現農村人居環境持續改善及治理長效管護為目的，推動鄉村由“一時美”向“持久美”轉變。3.2物聯網監測數據共享模塊/系統(IOTmonitoringdatasharingmodule/system)2DBXX/XXXXX—XXXX物聯網監測數據共享模塊/系統（以下簡稱“共享平臺”是面向農村人居環境進行智能化監測的傳感設備，這些設備的動態監測數據統一存儲在農村人居環境長效管護平臺，并建立數據共享模塊來提供數據服務。4概述依據國標GB/T33745-2018中的規定，交換和共享數據模塊/系統既可以是物聯網系統中的一個功能模塊，也可以是一個獨立的系統，通過數據接口方式，數據提供方通過物聯網系統將交換和共享的數據導入到對應的模塊/系統；數據需求方從物聯網相應模塊/系統獲取物聯網數據，數據接口如圖1所示。5接口要求5.1約定本章給出了共享平臺的基本接口方法、參數。接口應與物聯網系統的軟件平臺無關，接口宜采用WebService技術實現。以下接口描述，只規定了共享平臺實現的基本接口方法、參數項目、參數類型、參數格式及命名規范。為便于提供方和需求方統一調用數據，接口方法和參數宜采用英文命名。3DBXX/XXXXX—XXXX6接口設計規范6.1基本規范接口地址：http://xxx.xxx.xxx.xxx:xxxx/。接口協議：WebService。編碼方式：UTF-8。交換格式：JSON。6.2返回錯誤碼code接口錯誤碼返回標準規范見表1：表1：返回錯誤碼code及描述參數名code值描述0成功999失敗正在處理7設備數據上報頻次規范7.1數據上報頻次智能垃圾桶：6小時/條，或12小時/條。水質監測設備：6小時/條，或12小時/條。氣味探測器：6小時/條，或12小時/條。車載/卡牌：1分鐘以上/條。環境探測器：6小時/條。8數據提供方8.1身份認證8.1.1獲取令牌接口接口方法：getToken。接口路徑：api/open/oauth/。請求方式：POST。請求參數：見表2。表2getToken參數名必選類型說明app_id是string由平臺頒發app_secret是string由平臺頒發返回示例：見附錄A.1。4DBXX/XXXXX—XXXX8.2設備管理8.2.1產品列表簡要描述：獲取農村人居環境長效管護平臺標準物聯網產品。接口方法：getProductList。接口路徑：api/open/product/。請求方式：POST。參數：見表3。表3getProductList報頭參數名必選類型說明token是String通信證key參數名必選類型說明productName否string產品名稱productProtocol否Integer產品協議：Integer,產品協議：1.T-LINK協議2.MQTT協議3.LWM2M協議4.TUP協議5.HTTP協議6.JT/T8087.TCP協議8.私有TCP(網關子設備協議)9.私有UDP(網關子設備協議)10.網關產品MQTT(網關產品協議)11.南向云productId是返回示例:見附錄A.2。8.2.2設備列表簡要描述：獲取農村人居環境長效管護平臺設備列表。接口方法：getDeviceList。接口路徑：api/open/device/。請求方式：POST。請求參數：見表4。表4getDeviceList報頭參數名必選類型說明Token是String通信證key參數名必選類型說明netStatus否設備狀態deviceNo否String設備編號5DBXX/XXXXX—XXXX參數名必選類型說明productId是StringgridCode是String區域code返回示例:見附錄A.3。8.2.3新建產品簡要描述：添加產品(產品為設備直連+非NB網關協議)。接口方法：CreateProduct。接口路徑：api/open/product/。請求方式：POST。請求參數：見表5。表5CreateProduct報頭參數名必選類型說明Token是String通信證key請求body（數據類型application/json;charset=utf-8）6XX{XX"accessType":1,"authType":0,"dataEncryption":0,"deviceModel":"string","encryptionType":0,"endpointFormat":0,"lwm2mEdrxTime":null,"manufacturerId":"string","networkType":0,"nodeType":1,"payloadFormat":0,"powerModel":0,"productDesc":"string","productName":"string","productProtocol":0,"productType":"string","secondaryType":"string","thirdType":"string","tupIsThrough":0,"tupDeviceModel":"string"}描述：productName：產品名稱（必填產品名稱最多64個字符，產品名稱必須包含數字或字母或漢字，產品名稱不能重復productType：產品分類（必填）secondaryType：二級分類（必填）thirdType：三級分類（必填）nodeType：節點類型（必填1.設備，2.網關accessType：接入類型（必填）:1.設備直連，2.網關接入，3.南向云接入（只支持1）networkType：網絡類型（必填）:1.WIFI,2.移動蜂窩數據3.NB-IoT,4.以太網,5.藍牙,6.ZigBee（只支持1/2/3/4）productProtocol：產品協議（必填只支持1.T-LINK協議2.MQTT協議3.LWM2M協議5.HTTP協議6.JT/T8087.TCP協議10.網關MQTT協議authType：認證方式1:特征串認證,2:SM9認證,3:證書認證,4:IMEI認證，5:SIMID認證，6:SM2認證，7:IPV6標識認證payloadFormat：消息格式1:json，2:緊湊二進制dataEncryption：數據加密方式1:sm1,2:sm2,3:sm4,4:dtls,5:明文（只支持MQTT/LWM2M）encryptionType：安全類型(只支持MQTT,TCP協議)0:一機一密，1:一型一密tupIsThrough：是否透傳：0.透傳，1不透傳（JT/T808，tcp協議，只有透傳，消息格式必須只能傳null）deviceModel：JT/T808協議設備型號manufacturerId：JT/T808協議制造商IDendpointFormat:Endpoint格式（LWM2M協議必填）:1IMEI2URN:IMEI:###############3URN:IMEIIMSI:返回示例:見附錄A.4。7DBXX/XXXXX—XXXX8.2.4刪除產品簡要描述：刪除產品數據，如果產品下有設備數據，則無法刪除產品。接口方法：deleteProduct。接口路徑：api/open/product/。請求方式：Delete。請求參數：見表6。表6deleteProduct報頭參數名必選類型說明token是String通信證keyMasterKey是stringMasterKey在該設備所屬產品的概況中可以查看報體參數名必選類型說明productId是gridCode是String區域code返回示例：見附錄A.58.2.5更新產品簡要描述：更新產品數據。接口方法：updateProduct。接口路徑：api/open/product/。請求方式：put。請求參數：見表7。表7updateProduct報頭參數名必選類型說明token是String通信證key報體參數名必選類型說明gridCode是String區域code請求body（數據類型application/json;charset=utf-8）{"endpointFormat":null,8DBXX/XXXXX—XXXX"powerModel":null,"productDesc":"string","productId":0,"productName":"string","lwm2mEdrxTime":null}描述：productId:產品ID，必填productName：產品名稱，產品名稱租戶內不能重復，必填productDesc：產品描述，選填endpointFormat：endpoint類型(Lwm2m協議必填)1.IMEI2.URN:IMEI:###############3.URN:IMEI-IMSI:###############-###############4.URN:IMEI+SM9注：認證方式為SM9認證時，endpoint類型為4認證方式為IMEI認證、sm2認證時，endpoint類型為1、2、3powerModel：省電模式(Lwm2m協議必填)1.PSM2.DRX3.eDRXlwm2mEdrxTime：eDRX模式時間窗(LWM2M協議,當省電模式為3時,必填):20～10485.76間的值,精確到小數點后兩位返回示例：見附錄A.6。8.2.6創建設備簡要描述：增加設備。接口方法：CreateDevice。接口路徑：api/open/device/。請求方式：POST。請求參數：見表8。表8CreateDevice報頭參數名必選類型說明token是String通信證key報體參數名必選類型說明MasterKey是StringMasterKey在該設備所屬產品的概況中可以查看gridCode是String區域codedeviseName是String設備名稱deviceSn是String設備編號Imei是StringImei號9DBXX/XXXXX—XXXX報體參數名必選類型說明productId是operator是String操作人返回示例：見附錄A.7。8.2.7刪除設備簡要描述：刪除設備數據。接口方法：deleteDevice。接口路徑：api/open/device/。請求方式：Delete。請求參數：見表9。表9deleteDevice報頭參數名必選類型說明token是String通信證key報體參數名必選類型說明productId是deviceIds是string可以刪除多個設備（最多支持200個設備）。多個設備id，中間以逗號","隔開。MasterKey是StringMasterKey在該設備所屬產品的概況中可以查看gridCode是String區域code8.2.8更新設備簡要描述：更新設備數據。接口方法：updateDevice。接口路徑：api/open/device/。請求方式：PUT。請求參數：見表10。表10updateDevice報頭參數名必選類型說明token是String通信證keyMasterKey是StringDBXX/XXXXX—XXXX請求參數名必選類型說明gridCode是String區域code請求body（數據類型application/json;charset=utf-8）{"deviceName":"string","operator":"string","other":{"autoObserver":0,"imsi":"12545154878451"},"productId":0}描述：deviceName:設備名稱，選填operator:操作者，必填other:LWM2M協議必填參數,其他協議不填：{autoObserver:0.自動訂閱1.取消自動訂閱，訂閱指的是平臺訂閱設備能夠上報的object數據選填;imsi:總長度不超過15位，使用0~9的數字，String類型選填;}productId:產品ID，必填返回示例：見附錄A.98.2.9獲取物模型簡要描述：查詢屬性列表信息，獲取標準數據參數名稱及數據類型接口方法：QueryPropertyList接口路徑：api/open/model/properties/請求方式：GET請求參數：見表11。表11QueryPropertyList報頭參數名必選類型說明token是String通行證keyMasterKey是StringMasterKey在該設備所屬產品的概況中可以查看報體參數名必選類型說明productId是產品IdsearchValue否String可填值：屬性名稱，屬性DBXX/XXXXX—XXXX報頭參數名必選類型說明gridCode否String區域codepageNow否當前頁數pageSize否每頁記錄數返回示例：見附錄A.108.2.10獲取標準產品物模型簡要描述：標準農村人居環境長效管護平臺標準物模型。接口方法：QueryStandardModel。接口路徑：api/open/standardModel/。請求方式：GET。請求參數：見表12。表12QueryStandardModel報頭參數名必選類型說明token是String通信證keyMasterKey是StringMasterKey在該設備所屬產品的概況中可以查看報體參數名必選類型說明standardVersion否String標準物模型版本號thirdType否三級分類id返回示例：見附錄A.11。8.2.11獲取服務列表信息簡要描述：獲取農村人居環境長效管護平臺服務列表信息。接口方法：QueryPropertyList。接口路徑：api/open/model/properties/。請求方式：GET。請求參數：見表13。表13QueryPropertyList報頭參數名必選類型說明DBXX/XXXXX—XXXXtoken是String通信證keyMasterKey是StringMasterKey在該設備所屬產品的概況中可以查看報體參數名必選類型說明productId是產品IdsearchValue否String可填值：屬性名稱，屬性標識符gridCode是String區域codepageNow否當前頁數pageSize否每頁記錄數8.2.12智能垃圾桶數據上報簡要描述：智能垃圾桶設備上報數據。接口方法：uploadRubbishData。接口路徑：api/open/uploadData/。請求方式：Post。請求參數：見表14。表14uploadRubbishData報頭參數名必選類型說明token是String通信證key報體參數名必選類型說明body是String智能垃圾桶標準物模型{"deviceId":"be04c3519c5740c1b82fe0fceb9d2e82","uploadTime":"2021-07-1916:29:41","latitude":"0.0","longitude":"0.0","errorCode":"0000","fireState":"0","tiltAngle":"0","powerState":"0","temperature":24,DBXX/XXXXX—XXXX"deviceState":null,"batteryValue":0,"locationFlag":null,"fireThreshold":0,"fullThreshold":0,"tiltThreshold":null,"batteryVoltage":3.63,"powerThreshold":0,"fullState":"0","inclineState":"0","high":464,"deviceNo":null,"imei":null}8.2.13人員卡牌設備數據上報簡要描述：卡牌設備上報數據。接口方法：uploadCardData。接口路徑：api/open/uploadData/。請求方式：Post。請求參數：見表15。表15uploadCardData報頭參數名必選類型說明Token是String通信證key報體參數名必選類型說明body是String人員卡牌標準物模型{"deviceId":"e978a25e8c6d4e9fbe9286cedc6aedcd","uploadTime":null,"longitude":"114.1700000","latitude":"26.4400000","speed":2,"direction":null,DBXX/XXXXX—XXXX"signal":null,"battery":"31","gpsFlag":null,"receiveTime":"2021-07-2118:13:06.133","createTime":"2021-07-2209:55:54","heading":null,"valid":"0","imei":null}8.2.14智慧廁改設備數據上報簡要描述：廁改設備上報數據。接口方法：uploadToiletData。接口路徑：api/open/uploadData/。請求方式：Post。請求參數：見表16。表16uploadToiletData報頭參數名必選類型說明token是String通信證key報體參數名必選類型說明body是String智慧廁改設備標準物模型DBXX/XXXXX—XXXX{"deviceId":,"deviceName":null,"uploadTime":"2021-08-2715:49:00","humWoman":null,"tempWoman":null,"h2sWoman":null,"nh3Woman":null,"humMan":"81.108642578125","tempMan":"28.8987979888916","h2sMan":"0.0010200000833719969","nh3Man":"0.004118899814784527","squatIdleWoman":0,"squatIdleMan":0,"pfWoman":null,"pfMan":null,"createTime":null,"imei":null}8.2.15污水監測設備上報數據簡要描述：污水監測設備上報數據。接口方法：uploadWaterData。接口路徑：api/open/uploadData/。請求方式：Post。請求參數：見表17。表17uploadWaterData報頭參數名必選類型說明token是String通信證key報體參數名必選類型說明body是String污水監測設備標準物模型{"deviceId":"15036215BK7201SN001625",DBXX/XXXXX—XXXX"uploadTime":"2021-08-0417:01:03","temperature":29,"conductivity":1,"turbidity":1348.2,"ph":7.31,"doxygen":5.670000076293945,"imei":null}8.2.16車載設備數據上報簡要描述：車載設備上報數據。接口方法：uploadCarData。接口路徑：api/open/uploadData/。請求方式：Post。請求參數：見表18。表18uploadCarData報頭參數名必選類型說明token是String通信證key報體參數名必選類型說明body是String車載設備標準物模型{"deviceId":"a6fdce27e9844ba5b0b9f97ae7d40136","uploadTime":"2021-04-0215:42:17","batteryVoltage":360,"batteryStatus":0,"reserved":0,"temperature":55,"speed":0,"latitude":29.384321,"longitude":117.23177,"height":15,"actualLevel":null,"dataSource":null,"syncStatus":0,"syncTime":null,DBXX/XXXXX—XXXX"alarm":0,"mileage":0,"recorderSpeed":0,"gpsswitch":1,"imei":null}8.2.17空氣站設備數據上報簡要描述：空氣站設備上報數據。接口方法：uploadtAirData。接口路徑：api/open/uploadData/。請求方式：Post。請求參數：見表19。表19uploadtAirData報頭參數名必選類型說明token是String通信證key報體參數名必選類型說明body是String空氣站標準物模型{"deviceId":,"temperature":"0","humidity":"0","windSpeed":"0","windDirection":"0","pressure":"0","uploadTime":"2021-07-2211:38:10","rainfall":null,"dailyRainfall":null,"lightIntensity":null,"no2":"4.253","so2":null,"pm10":"32.261","pm25":"6.425"}DBXX/XXXXX—XXXX9數據需求方9.1設備數據管理9.1.1獲取設備監測數據簡要描述：根據設備Id設備類別獲取設備上報監測數據。接口方法：getDeviceDataById。接口路徑：api/open/device/。請求方式：POST。請求參數：見表20。表20getDeviceDataById報頭參數名必選類型說明token是String通行證key參數名必選類型說明deviceId是stringfacilityCategory是string設備類別startTime否string開始時間endTime否string結束時間9.1.2獲取設備原始上傳數據包簡要描述：獲取設備原始上傳數據格式接口方法：getBasicDataList接口路徑：api/open/basicData/請求方式：POST請求參數：見表21。表21getBasicDataList參數名必選類型說明deviceName否string設備名稱deviceId是StringgridCode是String區域codeDBXX/XXXXX—XXXX9.1.3獲取設備上報事件信息簡要描述：獲取設備上報事件信息。接口方法：getEventBasicDataList。接口路徑：api/open/events/。請求方式：POST。請求參數：見表22。表22getEventBasicDataList參數名必選類型說明deviceName否string設備名稱iotEventType否string事件類型deviceId是StringgridCode是String區域code9.1.4獲取智能垃圾桶數據簡要描述：獲取智能垃圾桶設備上報數據。接口方法：getRubbishData。接口路徑：api/open/deviceData/。請求方式：Post。請求參數：見表23。表23getRubbishData報頭參數名必選類型說明token是String通信證key參數名必選類型說明gridCode是String區域codedeviceId是String9.1.5獲取人員卡牌設備數據簡要描述：獲取卡牌設備上報數據。接口方法：getCardData。接口路徑：api/open/deviceData/。請求方式：Post。DBXX/XXXXX—XXXX請求參數：見表24。表24getCardData報頭參數名必選類型說明token是String通信證key請參數名必選類型說明gridCode是String區域codedeviceId是String9.1.6獲取污水監測設備數據簡要描述：獲取污水監測設備上報數據。接口方法：getWaterData。接口路徑：api/open/deviceData/。請求方式：Post。請求參數：見表25。表25getWaterData報頭參數名必選類型說明token是String通信證key報體參數名必選類型說明gridCode是String區域codedeviceId是String9.1.7獲取車載設備數據簡要描述：獲取車載設備上報數據。接口方法：getCarData。接口路徑：api/open/deviceData/。請求方式：Post。請求參數：見表26。表26getCarData報頭參數名必選類型說明token是String通信證keyDBXX/XXXXX—XXXX報體參數名必選類型說明gridCode是String區域codedeviceId是String9.1.8獲取智慧廁改設備數據簡要描述：獲取廁改設備上報數據。接口方法：getToiletData。接口路徑：api/open/deviceData/。請求方式：Post。請求參數：表27。表27getToiletData報頭參數名必選類型說明token是String通信證key報體參數名必選類型說明gridCode是String區域codedeviceId是String9.1.9獲取空氣站設備數據簡要描述：獲取空氣站設備上報數據。接口方法：getAirData。接口路徑：api/open/deviceData/。請求方式：Post。請求參數：見表28。表28getAirData報頭參數名必選類型說明Token是String通信證key報體參數名必選類型說明gridCode是String區域codedeviceId是StringDBXX/XXXXX—XXXX附錄A（資料性）接口返回示例A.1獲取令牌接口返回示例以JSON格式返回結果數據，格式定義如下：表A.1{"msg":"success","expireTime":"2021-03-3010:24:28","expire":86400,"token":"eyJhbGciOiJIUzUxMiJ9.eyJhcHBTZWNyZXQiOiJudWxsIiwiZXhwIjoxNjI5NjgxNTA2LCJjcmVhdGVkIjoxNjI5NjgwNjA2ODM4LCJhcHBJZCI6Im51bGwifQ.l-OCLUw8TTEyngvpExaJ7Q-sBCZiVDVJxGDEEHCcrHxo9-rx_-8RbGVqT7IEjsFqMHAM_CJAfatYjaNfh0JZ7g"}參數名類型說明code當code為0成功返回數據msgString返回結果字符串data集合結果集合expireTimeString過期時間expire過期（秒）tokenString令牌A.2產品列表接口返回示例：以JSON格式返回結果數據，格式定義如下：表A.3{{“productId”:1532043DBXX/XXXXX—XXXX“productName":"tup-test-zcj",}參數名類型說明codeint當code為0成功返回數據msgStringcode對應描述信息productIdstring產品iddeviceCountint產品下面設備總數powerModelint電源模式productProtocolstring產品協議（Integer,產品協議：1.T-LINK協議2.MQTT協議3.LWM2M協議4.TUP協議5.HTTP協議6.JT/T8087.TCP協議8.私有TCP(網關子設備協議)9.私有UDP(網關子設備DBXX/XXXXX—XXXX參數名類型說明協議)10.網關產品MQTT(網關產品協議)11.南向云）payloadFormatint數據上報格式(Integer,消息類型1:json，2:緊湊二進制)powerModelStrstring電源模式描述productProtocolStrstring產品協議描述payloadFormatStrstring數據上報格式描述endpointFormatStrstringendpoint格式描述authTypeStrstring認證方式描述networkTypeStrstring網絡類型描述productNamestring產品名稱描述productDescstring產品描述endpointFormatintendpoint格式authTypeint認證方式（Integer,認證方式1:特征串認證，2:sm9雙向認證,4:IMEI認證,5:SIMID認證,6:sm2認證）apiKeystringapikeycreateTimestring創建時間updateTimestring更新時間productTypeint產品類別secondaryTypestring二級類別thirdTypestring三級類別productTypeValuestring產品類型值secondaryTypeValuestring二級產品類型值thirdTypeValuestring三級產品類型值tupDeviceModelstringtup設備模式A.3設備列表接口返回示例：以JSON格式返回結果數據，格式定義如下：表A.5{{DBXX/XXXXX—XXXX}}參數名類型說明code當code為0成功返回數據MsgStringCode對應信息deviceSnString設備編號deviceIdStringdeviceNameString設備名稱productIdString產品名稱deviceStatus設備激活狀態狀態（.：已注冊1：已激活2：已注銷）deviceStatusStrString設備狀態名稱netStatus設備在線狀態（1：在線2：不在線）netStatusStrString設備在線狀態名稱productProtocolString設備通訊協議（Integer,產品協議：1.T-LINK協議2.MQTT協議3.LWM2M協議4.TUP協議5.HTTP協議6.JT/T8087.TCP協議8.私有TCP(網關子設備協議)9.私有UDP(網關子設備協議)10.網關產品MQTT(網關產品協議)11.南向云）productProtocolStrString通訊協議名稱createTimeString創建時間updateTimeString更新時間activeTimeString激活時間DBXX/XXXXX—XXXXofflineAtString下線時間onlineAtString上線時間facilityCategoryString設備類別dataSourceString數據來源A.4新建產品接口返回示例：以JSON格式返回結果數據，格式定義如下：表A.7{"code":0,"msg":"ok","result":{"productId":10012761,"productName":"測試創建產品","tenantId":"300","productDesc":"創建產品","productType":10024,"secondaryType":10025,"thirdType":10026,"productProtocol":1,"authType":1,"payloadFormat":1,"createTime":1571402267678,"updateTime":1571402268678,"networkType":4,"endpointFormat":1,"powerModel":1,"apiKey":"67141cddbf2e4f62a2ff458f1dd9ba8e","onlineDeviceCount":0,"deviceCount":3,"productTypeValue":"家電","secondaryTypeValue":"測試","thirdTypeValue":"測試tanglv","rootCert":1,"createBy":"user","updateBy":"user","accessType":2,"nodeType":1,"tupIsThrough":1,"dataEncryption":5,"lwm2mEdrxTime":15.2}DBXX/XXXXX—XXXX}參數名類型必選說明code否當code為0成功返回數據msgstring否返回描述resultobject否返回結果productId否產品IDproductNamestring否產品名稱tenantId否productDescstring否產品描述productType否產品類別secondaryType否二級分類thirdType否三級分類productProtocol否Integer,產品協議：Integer,產品協議：1.T-LINK協議2.MQTT協議3.LWM2M協議4.TUP協議5.HTTP協議6.JT/T8087.TCP協議8.私有TCP(網關子設備協議)9.私有UDP(網關子設備協議)10.網關產品MQTT(網關產品協議)11.南向云協議authType否Integer,認證方式1:特征串認證，2:sm9認證，3:dtls雙向認證,4:IMEI認證,5:SIMID認證，6:SM2認證payloadFormat否Integer,消息類型1:json，2:緊湊二進制createTime否創建時間updateTime否更新時間networkType否Integer,網絡類型:1.wifi2.移動蜂窩數據3.NB-IoT4.以太網endpointFormat否Integer,Endpoint格式:1.IMEI2.URN:IMEI:###############3.URN:IMEI-IMSI:###############-###############4.URN:IMEI+SMpowerModel否Integer,省電模式：1.PSM2.DRX3.eDRXapiKeystring否MasterKeyonlineDeviceCount否在線設備數deviceCount否設備總數productTypeValuestring否產品分類名稱secondaryTypeValuestring否二級分類名稱thirdTypeValuestring否三級分類名稱rootCert否T-Link證書認證根證書DBXX/XXXXX—XXXXcreateByString否創建者updateByString否更新者nodeType否節點類型：1.設備，2.網關accessType否接入類型:1.設備直連，2.網關接入，3.南向云接入，4.視圖云接入tupIsThrough否是否透傳：0.透傳，1不透傳（JT/T808，只有透傳，消息格式必須只能傳null）dataEncryption否數據加密方式1:sm1,2:sm2,3:sm4,4:dtls,5:明文lwm2mEdrxTime否eDRX模式時間窗A.5刪除產品接口返回示例：以JSON格式返回結果數據，格式定義如下：表A.9{"code":0,"msg":"string"}參數名類型說明codeint當code為0成功返回數據MsgStringCode描述A.6更新產品接口返回示例：以JSON格式返回結果數據，格式定義如下：表A.11{"code":0,"msg":"ok"}參數名類型說明code當code為0成功返回數據MsgStringCode描述DBXX/XXXXX—XXXXA.7創建設備接口返回示例：以JSON格式返回結果數據，格式定義如下：表A.13{"code":0,"msg":"ok","result":{"deviceId":"89e920fa0eda47a89f04f52a88b17146","deviceName":"test003","tenantId":"300","productId":10003304,"imei":"125658789874565","deviceSn":"","token":"Tyhp7mYXm1k_upy44j32vw8GlKGH8gwvgdayOX27_2E"}}參數名類型說明Code0表示返回成功MsgString返回結果描述productIdtenantIdImei號deviceIdStringdeviceNameString設備名稱deviceSnStringtokenString設備TokenA.8刪除設備接口返回示例：以JSON格式返回結果數據，格式定義如下：表A.15{"code":0,"msg":"string"DBXX/XXXXX—XXXX}參數名類型說明code當code為0成功返回數據MsgStringCode描述A.9更新設備接口返回示例：以JSON格式返回結果數據，格式定義如下：表A.17{"code":0,"msg":"string"}參數名類型說明code當code為0成功返回數據MsgStringCode描述A.10獲取物模型接口返回示例：以JSON格式返回結果數據，格式定義如下：表A.19{"code":0,"msg":"ok","result":{"pageNum":1,"pageSize":1,"propertyId":1,"propertyFlag":"asdggg","propertyName":"屬性1","dataType":"fix-string",DBXX/XXXXX—XXXX"unit":"g","unitName":"克每毫升","description":"""propertyId":2,"propertyFlag":"a1","propertyName":"a1","dataType":"enum","enumDetail":{"3":"4","description":"test""propertyId":3,"propertyFlag":"a2","propertyName":"a2","dataType":"float","unit":"ppm","len":4,"unitName":"百萬分率","max":"2","description":"1""propertyId":4,"propertyFlag":"a3","propertyName":"a3","dataType":"bool","boolDetail":{"false":"關","true":"開""description":"test"}DBXX/XXXXX—XXXX參數名類型說明MsgString返回結果描述resultInt結果集totalInt總數unitNameString單位名稱propertyFlagString屬性標識符propertyNameString屬性名稱dataTypeString數據類型:二進制數據類型及對應枚舉值:整型integer,定長字符串fix-string,定長binaryfix-binary,無符號整型unsigned-integer,變長字符串vary-string,變長binaryvary-binary,double浮點型double,float浮點型float,時間戳timestamp,枚舉值enum。json格式數據類型及對應枚舉值：Int32Int32,floatfloat,doubledouble,枚舉型enum,boolean類型bool,字符串string,時間戳dateunitString單位lenInt長度descriptionString描述stepInt步長propertyIdInt屬性idpageSizeInt每頁條數pageNumInt當前頁數maxInt最大值codeInt返回狀態碼A.11獲取標準產品物模型接口返回示例：DBXX/XXXXX—XXXX以JSON格式返回結果數據，格式定義如下：表A.21{"code":0,"msg":"ok","result":{"properties":[{"propertyFlag":"a1","propertyName":"a1","dataType":"enum","enumDetail":{"3":"4","description":"test"{"propertyFlag":"a2","propertyName":"a2","dataType":"float","unit":"ppm","len":4,"unitName":"百萬分率","max":"2","description":"1""services":[{"serviceId":8001,"serviceFlag":"a3","serviceName":"a3","serviceType":2,"eventType":1,"description":"a","properties":[{"propertyFlag":"a2","serial":2DBXX/XXXXX—XXXX"parameters":[{"parameterFlag":"c1","parameterName":"c1","dataType":"Int32","unit":"g","len":4,"unitName":"克每毫升","max":"2","description":"1","serial":1}參數名類型說明MsgString返回結果描述resultInt結果集totalInt總數serviceTypeIntInteger服務類型1.數據上報2.事件上報3.數據獲取4.參數查詢5.參數配置6.指令下發7.指令下發響應8.無線參數上報serviceFlagString服務標識serviceIdStringInteger服務IdserviceNameString服務名稱eventTypeIntInteger事件類型只有事件上報才有值1:信息2:警告3:故障unitString單位lenInt長度minInt最小值stepInt步長DBXX/XXXXX—XXXXpropertyFlagString屬性標識unitNameString單位名稱serialInt序號propertyNameString屬性名稱dataTypeString數據類型:二進制數據類型及對應枚舉值:整型integer,定長字符串fix-string,定長binaryfix-binary,無符號整型unsigned-integer,變長字符串vary-string,變長binaryvary-binary,double浮點型double,float浮點型float,時間戳timestamp,枚舉值enum。json格式數據類型及對應枚舉值：Int32Int32,floatfloat,doubledouble,枚舉型enum,boolean類型bool,字符串string,時間戳dateparameterFlagString參數標識descriptionString描述parameterNameString參數名稱maxInt最大值codeInt返回狀態碼A.12獲取服務列表信息接口返回示例：以JSON格式返回結果數據，格式定義如下：表A.23{"code":0,"msg":"ok","result":{"pageNum":1,"pageSize":20,"serviceId":1,"serviceFlag":"asdg","serviceName":"阿薩德剛","serviceType":2,"eventType":1,DBXX/XXXXX—XXXX"description":"","properties":[{"propertyId":1,"propertyFlag":"asdggg","propertyName":"屬性1","dataType":"fix-string","unit":"g","unitName":"克每毫升","description":"""propertyId":2,"propertyFlag":"a1","propertyName":"a1","dataType":"enum","enumDetail":{"3":"4","description":"test""propertyId":4,"propertyFlag":"a3","propertyName":"a3","dataType":"bool","boolDetail":{"false":"關","true":"開""description":"test""parameters":[{"parameterId":17,"parameterFlag":"cellId","parameterName":"cellId","dataType":"integer","unit":"null","min":-2147483648,"len":4,DBXX/XXXXX—XXXX"unitName":"","max":2147483647,"description":""}參數名類型說明MsgString返回結果描述result結果集total總數serviceTypeInteger服務類型1.數據上報2.事件上報3.數據獲取4.參數查詢5.參數配置6.指令下發7.指令下發響應8.無線參數上報pageNumInteger當前頁數serviceFlagstring服務標識符descriptionString描述eventTypeStringInteger事件類型只有事件上報才有值1:信息2:警告3:故障serviceIdInteger服務IdunitString單位min最小值parameterIdInteger參數IdInteger長度unitName單位名稱dataType數據類型:二進制數據類型及對應枚舉fix-string,定長binaryfix-binary,無符號整型unsigned-integer,變長字符串vary-string,變長binaryDBXX/XXXXX—XXXXvary-binary,double浮點型double,float浮點型float,時間戳timestamp,枚舉值enum。json格式數據類型及對應枚舉值：Int32Int32,floatfloat,doubledouble,枚舉型enum,boolean類型bool,字符串string,時間戳dateparameterFlag參數標識propertyFlagstring屬性標識propertyNameString屬性名稱A.13智能垃圾桶數據上報接口返回示例：以JSON格式返回結果數據，格式定義如下：表A.25{{"deviceId":"be04c3519c5740c1b82fDBXX/XXXXX—XXXX}}參數名類型必選說明codeint否當code為0成功返回數據MsgString否Code描述deviceIdString是設備iduploadTimeString是上報時間latitudeString是緯度longitudeString是經度errorCodeString是錯誤碼fireStateString否火災狀態tiltAngleString否傾角powerStateString否電量狀態temperatureInt否溫度deviceStateString否設備模式batteryValueInt否電池電量locationFlagString否經緯度標識fireThresholdInt否火災閾值fullThresholdInt否滿溢閾值tiltThresholdString否傾倒閾值batteryVoltageFloat否電池電壓powerThresholdOnt否電量閾值fullStateString否滿空狀態inclineStateString否傾倒狀態highInt否高度deviceNoString是設備編號imeString是Imei號DBXX/XXXXX—XXXXA.14人員卡牌設備數據上報接口返回示例：以JSON格式返回結果數據，格式定義如下：表A.27{{"deviceId":"e978a25e8c6d4e9fbe928"receiveTime":"2021-07-21"createTime":"2021-07-參數名類型是否必填說明codeint否當code為0成功返回數據MsgString否Code描述deviceIdString是設備iduploadTimeString否上報時間latitudeString是緯度longitudeString是經度speedInt否速度directionString否方向DBXX/XXXXX—XXXX參數名類型是否必填說明signalString否信號batteryString否電池電量gpsFlagString否Gps標識imeiString否設備imei號sosAlarmString否報警標記validString否有效性receiveTimeString否接收時間A.15智慧廁改設備數據上報接口返回示例：以JSON格式返回結果數據，格式定義如下：表A.29{{"h2sMan":"0.00102000"nh3Man":"0.0041188}DBXX/XXXXX—XXXX參數名類型必選說明codeint否當code為0成功返回數據MsgString否Code描述deviceIdString是設備iddeviceNameString否設備名稱uploadTimeString是上報時間humWomanString否女廁濕度tempWomanString否女廁溫度h2sWomanString否女廁硫化氫nh3WomanString否女廁氨氣humManString否男廁濕度tempManString否男廁溫度h2sManString否男廁硫化氫nh3ManString否男廁氨氣squatIdleWomanInt否女廁蹲位空閑數量squatIdleManInt否男廁蹲位空閑數量pfWomanString否女廁客流量pfManString否男廁客流量ImeiString是Imei號A.16污水監測設備上報數據接口返回示例：以JSON格式返回結果數據，格式定義如下：表A.31{{"deviceId":"15036215BKDBXX/XXXXX—XXXX}參數名類型必選說明codeint否當code為0成功返回數據MsgString否Code描述deviceIdString是設備iduploadTimeString是上報時間temperatureInt否溫度conductivityFloat否turbidityFloat否濁度phInt否pH值doxygenFloat否溶解氧imeiString是Imei號A.17車載設備數據上報接口返回示例：以JSON格式返回結果數據，格式定義如下：表A.33{{"deviceId":"a6fdce27e9844ba5b0b9DBXX/XXXXX—XXXX}參數名類型必選說明codeint否當code為0成功返回數據MsgString否Code描述deviceIdString是設備idbatteryVoltageString是上報時間batteryStatusInt否溫度reservedFloat否temperatureFloat否濁度speedInt否pH值heightFloat否溶解氧latitudeString是緯度longitudeString是經度alarmInt否是否報警uploadtTimeString是上報時間A.18空氣站設備數據上報接口返回示例：以JSON格式返回結果數據，格式定義如下：DBXX/XXXXX—XXXX表A.35{{參數名類型必選說明codeint否當code為0成功返回數據MsgString否Code描述deviceIdString是設備iduploadTimeString是上報時間temperatureString否溫度humidityString否濕度windSpeedString否風速windDirectionString否風向pressureString否氣壓rainfallString否雨量dailyRainfallString否日累計雨量lightIntensityString否光照強度no2String否二氧化氮DBXX/XXXXX—XXXX參數名類型必選說明so2String否二氧化硫pm10String否Pm10pm25String否Pm25A.19獲取設備監測數據接口返回示例：以JSON格式返回結果數據，格式定義如下：表A.37{{}DBXX/XXXXX—XXXX參數名類型說明codeString狀態碼msgstring狀態碼信息elcInt信號強度eclNameString信號強度名稱pciintpcirsrpint參考信號接收功率sinrint信號與干擾加噪聲比cellIdint小區位置信息snrint網絡信噪比deviceIdstring設備iduploadTimestring上報時間latitudestring緯度longitudestring經度errorCodestring錯誤碼fireStatestring火災狀態tiltAnglestring傾角powerStatestring電量狀態temperatureint溫度deviceStatestring設備模式batteryValueint電池電量locationFlagstring經緯度標識fireThresholdint火災閾值fullThresholdint滿溢閾值tiltThresholdint傾倒閾值batteryVoltagefloat電池電壓powerThresholdint電量閾值fullStatestring滿空狀態inclineStatestring傾倒狀態DBXX/XXXXX—XXXX參數名類型說明highint高度deviceNostring設備編碼imeistring設備imei號A.20獲取設備原始上傳數據包接口返回示例：以JSON格式返回結果數據，格式定義如下：表A.39{{"payload":"{\"hum_man\":73.8302001953125,\6200408935547,\"NH3_man\":0.001418899}DBXX/XXXXX—XXXX參數名類型說明codeint當code為0成功返回數據msgStringcode狀態描述deviceTypestring設備類型deviceIdstring設備iddeviceNamestring設備名稱protocolstring設備傳輸協議messageTypestring消息類型messageTypeStrstring消息類型名稱serviceIdstring服務idserviceNamestring服務名稱payloadstring原始數據timestampstring上傳時間syncTimestring同步時間syncStatusint同步狀態（0：未同步1：已同步）imeistringimei號A.21獲取設備上報事件信息接口返回示例：以JSON格式返回結果數據，格式定義如下：表A.41{{"deviceType":null,"productId":"15042251","deviceId":"4b349c049800421f8479f45f94b63a3f","deviceName":"尹仁生","protocol":"lwm2m","messageType":null,"messageTypeStr":"設備上下線狀態上報","serviceId":null,DBXX/XXXXX—XXXX"serviceName":null,"payload":null,"timestamp":null,"syncTime":"2021-08-1317:50:12","uploadTime":null,"syncStatus":0,"eventContent":null,"eventTypeStr":"信息",}參數名類型說明codeint當code為0成功返回數據msgString返回狀態信息productIdstring產品iddeviceIdstring設備iddeviceNamestring設備名稱protocolstring設備協議messageTypestring消息類型messageTypeStrstring消息類型名稱serviceIdstring服務idserviceNamestring服務名稱payloadstring原始數據timestampstring創建時間syncTimestring同步時間uploadTimestring上報時間syncStatusint同步狀態（0：未同步1：已同步）eventContentstring事件信息內容eventTypeint事件類別eventTypeStrstring事件類別名稱DBXX/XXXXX—XXXX參數名類型說明imeistring設備imei號A.22獲取智能垃圾桶數據接口返回示例：以JSON格式返回結果數據，格式定義如下：表A.43{"code":"0","msg":"成功","data":[{"deviceId":"be04c3519c5740c1b82fe0fceb9d2e82","uploadTime":"2021-07-1916:29:41","latitude":"0.0","longitude":"0.0","errorCode":"0000","fireState":"0","tiltAngle":"0","powerState":"0","temperature":24,"deviceState":null,"batteryValue":0,"locationFlag":null,"fireThreshold":0,"fullThreshold":0,"tiltThreshold":null,"batteryVoltage":3.63,"powerTh