农村人居环境长效管护平台数据交换规范

DBXX/XXXXX—XXXXII引  言当前农村人居环境长效管护平台接入的物联网监测平台较多，涉及设备品牌繁多，各厂家平台及设备数据标准不一，从而导致对接成本、维护成本、运营成本的增加，制约了平台的快速建设推广。为有效加强全省农村人居环境长效管护平台建设的统一规划、统一管理、协调运行和维护服务，建立健全全省农村人居环境长效管护平台的数据交换规范标准，推动农村人居环境长效管护平台的建设运营有序发展，提升各级政府及其部门的农村人居环境治理水平，现根据国家、地方相关文件要求和标准规范，结合我省农村人居环境治理现状和发展要求，制定本规范。农村人居环境长效管护平台数据交换规范范围本标准规定了江西省农村人居环境长效管护平台数据交换的相关术语和定义、设计要求及接口要求。本标准适用于江西省农村人居环境长效管护平台设计规范。规范性引用文件下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅所注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。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信息交换和共享术语和定义GB/T33745-2017、GB/T36478.1-2018界定的以及下列术语和定义适用于本文件。农村人居环境长效管护平台(Rurallivingenvironmentlong-termmanagementplatform)采用物联网、云计算、大数据、AI等新一代信息技术，通过数字化技术驱动农村人居环境有效治理，实现农村人居环境长效管护数字化、环境监测智能化、公众监督便捷化。平台集“投诉、整改、反馈、监督”等功能为一体，以实现农村人居环境持续改善及治理长效管护为目的，推动乡村由“一时美”向“持久美”转变。物联网监测数据共享模块/系统(IOTmonitoringdatasharingmodule/system)物联网监测数据共享模块/系统（以下简称“共享平台”），是面向农村人居环境进行智能化监测的传感设备，这些设备的动态监测数据统一存储在农村人居环境长效管护平台，并建立数据共享模块来提供数据服务。概述依据国标GB/T33745-2018中的规定，交换和共享数据模块/系统既可以是物联网系统中的一个功能模块，也可以是一个独立的系统，通过数据接口方式，数据提供方通过物联网系统将交换和共享的数据导入到对应的模块/系统；数据需求方从物联网相应模块/系统获取物联网数据，数据接口如图1所示。图1数据接口接口要求约定本章给出了共享平台的基本接口方法、参数。接口应与物联网系统的软件平台无关，接口宜采用WebService技术实现。以下接口描述，只规定了共享平台实现的基本接口方法、参数项目、参数类型、参数格式及命名规范。为便于提供方和需求方统一调用数据，接口方法和参数宜采用英文命名。接口设计规范基本规范接口地址：http://xxx.xxx.xxx.xxx:xxxx/。接口协议：WebService。编码方式：UTF-8。交换格式：JSON。返回错误码code接口错误码返回标准规范见表1：表1：返回错误码code及描述参数名code值描述0成功999失败1111正在处理设备数据上报频次规范7.1数据上报频次智能垃圾桶：6小时/条，或12小时/条。水质监测设备：6小时/条，或12小时/条。气味探测器：6小时/条，或12小时/条。车载/卡牌：1分钟以上/条。环境探测器：6小时/条。数据提供方身份认证获取令牌接口接口方法：getToken。接口路径：api/open/oauth/。请求方式：POST。请求参数：见表2。表2getToken参数名必选类型说明app_id是string由平台颁发app_secret是string由平台颁发返回示例：见附录A.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是Int产品id返回示例:见附录A.2。设备列表简要描述：获取农村人居环境长效管护平台设备列表。接口方法：getDeviceList。接口路径：api/open/device/。请求方式：POST。请求参数：见表4。表4getDeviceList报头参数名必选类型说明Token是String通信证key参数名必选类型说明netStatus否Int设备状态deviceNo否String设备编号productId是String产品idgridCode是String区域code返回示例:见附录A.3。新建产品简要描述：添加产品(产品为设备直连+非NB网关协议)。接口方法：CreateProduct。接口路径：api/open/product/。请求方式：POST。请求参数：见表5。表5CreateProduct报头参数名必选类型说明Token是String通信证key请求body（数据类型application/json;charset=utf-8）{{"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协议必填）:1.IMEI2.URN:IMEI:###############3.URN:IMEI-IMSI:###############-###############4.URN:IMEI+SM9powerModel：省电模式（LWM2M协议必填）：1.PSM2.DRX3.eDRXlwm2mEdrxTime:eDRX模式时间窗(LWM2M协议,当省电模式为3时,必填):20～10485.76间的值,精确到小数点后两位productDesc：产品描述（选填）：产品描述最多100个字符tupDeviceModel:设备型号，选填，设备直连并且非JT/T808协议产品必填返回示例:见附录A.4。删除产品简要描述：删除产品数据，如果产品下有设备数据，则无法删除产品。接口方法：deleteProduct。接口路径：api/open/product/。请求方式：Delete。请求参数：见表6。表6deleteProduct报头参数名必选类型说明token是String通信证keyMasterKey是stringMasterKey在该设备所属产品的概况中可以查看报体参数名必选类型说明productId是Int产品idgridCode是String区域code返回示例：见附录A.5更新产品简要描述：更新产品数据。接口方法：updateProduct。接口路径：api/open/product/。请求方式：put。请求参数：见表7。表7updateProduct报头参数名必选类型说明token是String通信证key报体参数名必选类型说明gridCode是String区域code请求body（数据类型application/json;charset=utf-8）{"endpointFormat":null,"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。创建设备简要描述：增加设备。接口方法：CreateDevice。接口路径：api/open/device/。请求方式：POST。请求参数：见表8。表8CreateDevice报头参数名必选类型说明token是String通信证key报体参数名必选类型说明MasterKey是StringMasterKey在该设备所属产品的概况中可以查看gridCode是String区域codedeviseName是String设备名称deviceSn是String设备编号Imei是StringImei号productId是Int产品idoperator是String操作人返回示例：见附录A.7。删除设备简要描述：删除设备数据。接口方法：deleteDevice。接口路径：api/open/device/。请求方式：Delete。请求参数：见表9。表9deleteDevice报头参数名必选类型说明token是String通信证key报体参数名必选类型说明productId是Int产品iddeviceIds是string可以删除多个设备（最多支持200个设备）。多个设备id，中间以逗号","隔开。MasterKey是StringMasterKey在该设备所属产品的概况中可以查看gridCode是String区域code返回示例：见附录A.8更新设备简要描述：更新设备数据。接口方法：updateDevice。接口路径：api/open/device/。请求方式：PUT。请求参数：见表10。表10updateDevice报头参数名必选类型说明token是String通信证keyMasterKey是String请求参数名必选类型说明gridCode是String区域code请求body（数据类型application/json;charset=utf-8）{"deviceName":"string","operator":"string",{"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，必填获取物模型简要描述：查询属性列表信息，获取标准数据参数名称及数据类型接口方法：QueryPropertyList接口路径：api/open/model/properties/请求方式：GET请求参数：见表11。表11QueryPropertyList报头参数名必选类型说明token是String通行证keyMasterKey是StringMasterKey在该设备所属产品的概况中可以查看报体参数名必选类型说明productId是Int产品IdsearchValue否String可填值：属性名称，属性gridCode否String区域codepageNow否Int当前页数pageSize否Int每页记录数返回示例：见附录A.10获取标准产品物模型简要描述：标准农村人居环境长效管护平台标准物模型。接口方法：QueryStandardModel。接口路径：api/open/standardModel/。请求方式：GET。请求参数：见表12。表12QueryStandardModel报头参数名必选类型说明token是String通信证keyMasterKey是StringMasterKey在该设备所属产品的概况中可以查看报体参数名必选类型说明standardVersion否String标准物模型版本号thirdType否Int三级分类id返回示例：见附录A.11。获取服务列表信息简要描述：获取农村人居环境长效管护平台服务列表信息。接口方法：QueryPropertyList。接口路径：api/open/model/properties/。请求方式：GET。请求参数：见表13。表13QueryPropertyList报头参数名必选类型说明token是String通信证keyMasterKey是StringMasterKey在该设备所属产品的概况中可以查看报体参数名必选类型说明productId是Int产品IdsearchValue否String可填值：属性名称，属性标识符gridCode是String区域codepageNow否Int当前页数pageSize否Int每页记录数智能垃圾桶数据上报简要描述：智能垃圾桶设备上报数据。接口方法：uploadRubbishData。接口路径：api/open/uploadData/。请求方式：Post。请求参数：见表14。报头参数名必选类型说明token是String通信证key表14uploadRubbishData报体参数名必选类型说明body是String智能垃圾桶标准物模型请求Body（数据类型application/json;charset=utf-8）{"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,"powerThreshold":0,"fullState":"0","inclineState":"0","high":464,"deviceNo":null,"imei":null}返回示例：见附录A.13。人员卡牌设备数据上报简要描述：卡牌设备上报数据。接口方法：uploadCardData。接口路径：api/open/uploadData/。请求方式：Post。请求参数：见表15。表15uploadCardData报头参数名必选类型说明Token是String通信证key报体参数名必选类型说明body是String人员卡牌标准物模型请求body{"deviceId":"e978a25e8c6d4e9fbe9286cedc6aedcd","uploadTime":null,"longitude":"114.1700000","latitude":"26.4400000","speed":2,"direction":null,"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}返回示例：见附录A.14。智慧厕改设备数据上报简要描述：厕改设备上报数据。接口方法：uploadToiletData。接口路径：api/open/uploadData/。请求方式：Post。请求参数：见表16。表16uploadToiletData报头参数名必选类型说明token是String通信证key报体参数名必选类型说明body是String智慧厕改设备标准物模型请求body{"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}返回示例：见附录A.15。污水监测设备上报数据简要描述：污水监测设备上报数据。接口方法：uploadWaterData。接口路径：api/open/uploadData/。请求方式：Post。请求参数：见表17。表17uploadWaterData报头参数名必选类型说明token是String通信证key报体参数名必选类型说明body是String污水监测设备标准物模型请求body{"deviceId":"15036215BK7201SN001625","uploadTime":"2021-08-0417:01:03","temperature":29,"conductivity":1,"turbidity":1348.2,"ph":7.31,"doxygen":5.670000076293945,"imei":null}返回示例：见附录A.16。车载设备数据上报简要描述：车载设备上报数据。接口方法：uploadCarData。接口路径：api/open/uploadData/。请求方式：Post。请求参数：见表18。表18uploadCarData报头参数名必选类型说明token是String通信证key报体参数名必选类型说明body是String车载设备标准物模型请求body：{"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,"alarm":0,"mileage":0,"recorderSpeed":0,"gpsswitch":1,"imei":null}返回示例：见附录A.17。空气站设备数据上报简要描述：空气站设备上报数据。接口方法：uploadtAirData。接口路径：api/open/uploadData/。请求方式：Post。请求参数：见表19。表19uploadtAirData报头参数名必选类型说明token是String通信证key报体参数名必选类型说明body是String空气站标准物模型请求body{"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"}返回示例：见附录A.18。数据需求方设备数据管理获取设备监测数据简要描述：根据设备Id设备类别获取设备上报监测数据。接口方法：getDeviceDataById。接口路径：api/open/device/。请求方式：POST。请求参数：见表20。表20getDeviceDataById报头参数名必选类型说明token是String通行证key参数名必选类型说明deviceId是string设备IdfacilityCategory是string设备类别startTime否string开始时间endTime否string结束时间返回示例：见附录A.19。获取设备原始上传数据包简要描述：获取设备原始上传数据格式接口方法：getBasicDataList接口路径：api/open/basicData/请求方式：POST请求参数：见表21。表21getBasicDataList参数名必选类型说明deviceName否string设备名称deviceId是String设备idgridCode是String区域code返回示例：见附录A.20。获取设备上报事件信息简要描述：获取设备上报事件信息。接口方法：getEventBasicDataList。接口路径：api/open/events/。请求方式：POST。请求参数：见表22。表22getEventBasicDataList参数名必选类型说明deviceName否string设备名称iotEventType否string事件类型deviceId是String设备idgridCode是String区域code返回示例：见附录A.21。获取智能垃圾桶数据简要描述：获取智能垃圾桶设备上报数据。接口方法：getRubbishData。接口路径：api/open/deviceData/。请求方式：Post。请求参数：见表23。表23getRubbishData报头参数名必选类型说明token是String通信证key参数名必选类型说明gridCode是String区域codedeviceId是String设备Id返回示例：见附录A.22。获取人员卡牌设备数据简要描述：获取卡牌设备上报数据。接口方法：getCardData。接口路径：api/open/deviceData/。请求方式：Post。请求参数：见表24。表24getCardData报头参数名必选类型说明token是String通信证key请参数名必选类型说明gridCode是String区域codedeviceId是String设备Id返回示例：见附录A.23。获取污水监测设备数据简要描述：获取污水监测设备上报数据。接口方法：getWaterData。接口路径：api/open/deviceData/。请求方式：Post。请求参数：见表25。表25getWaterData报头参数名必选类型说明token是String通信证key报体参数名必选类型说明gridCode是String区域codedeviceId是String设备Id返回示例：见附录A.24。获取车载设备数据简要描述：获取车载设备上报数据。接口方法：getCarData。接口路径：api/open/deviceData/。请求方式：Post。请求参数：见表26。表26getCarData报头参数名必选类型说明token是String通信证key报体参数名必选类型说明gridCode是String区域codedeviceId是String设备Id返回示例：见附录A.25。获取智慧厕改设备数据简要描述：获取厕改设备上报数据。接口方法：getToiletData。接口路径：api/open/deviceData/。请求方式：Post。请求参数：表27。表27getToiletData报头参数名必选类型说明token是String通信证key报体参数名必选类型说明gridCode是String区域codedeviceId是String设备Id返回示例：见附录A.26。获取空气站设备数据简要描述：获取空气站设备上报数据。接口方法：getAirData。接口路径：api/open/deviceData/。请求方式：Post。请求参数：见表28。表28getAirData报头参数名必选类型说明Token是String通信证key报体参数名必选类型说明gridCode是String区域codedeviceId是String设备Id返回示例：见附录A.27。附录A（资料性）接口返回示例A.1获取令牌接口返回示例以JSON格式返回结果数据，格式定义如下：表A.1{"msg":

"success",

"code":

0,

"data":

{

"expireTime":

"2021-03-30

10:24:28",

"expire":

86400,

"token":

"eyJhbGciOiJIUzUxMiJ9.eyJhcHBTZWNyZXQiOiJudWxsIiwiZXhwIjoxNjI5NjgxNTA2LCJjcmVhdGVkIjoxNjI5NjgwNjA2ODM4LCJhcHBJZCI6Im51bGwifQ.l-OCLUw8TTEyngvpExaJ7Q-sBCZiVDVJxGDEEHCcrHxo9-rx_-8RbGVqT7IEjsFqMHAM_CJAfatYjaNfh0JZ7g"

}}返回参数说明：见表A.2：表A.2参数名类型说明codeint当code为0成功返回数据msgString返回结果字符串data集合结果集合expireTimeString过期时间expireInt过期（秒）tokenString令牌A.2产品列表接口返回示例：以JSON格式返回结果数据，格式定义如下： 表A.3{"code":"0","msg":"成功","data":[{“productId”:1532043"apiKey":"b0910dc269db472fb45823292e706f3e", "authType":1, "createBy":"user", "createTime":1535942487000, "dataEncryption":5, "deviceCount":4, "endpointFormat":1, "lwm2mEdrxTime":25.2, "networkType":3, "nodeType":1, "payloadFormat":2, "powerModel":1, "productDesc":"", "productId":307, “productName":"tup-test-zcj", "productProtocol":4, "productType":1, "productTypeValue":"家电", "rootCert":"", "secondaryType":2, "secondaryTypeValue":"测试", "tenantId":"10007905", "thirdType":13, "thirdTypeValue":"测试tanglv", "tupIsThrough":1, "updateBy":"user", "updateTime":1535943389000}],}}返回参数说明：见表A.4。表A.4参数名类型说明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(网关子设备协议)10.网关产品MQTT(网关产品协议)11.南向云）payloadFormatint数据上报格式(Integer,消息类型1:json，2:紧凑二进制)powerModelStrstring电源模式描述productProtocolStrstring产品协议描述payloadFormatStrstring数据上报格式描述endpointFormatStrstringendpoint格式描述authTypeStrstring认证方式描述networkTypeStrstring网络类型描述productNamestring产品名称描述productDescstring产品描述endpointFormatintendpoint格式authTypeint认证方式（Integer,认证方式1:特征串认证，2:sm9认证，3:dtls双向认证,4:IMEI认证,5:SIMID认证,6:sm2认证）apiKeystringapikeycreateTimestring创建时间updateTimestring更新时间productTypeint产品类别secondaryTypestring二级类别thirdTypestring三级类别productTypeValuestring产品类型值secondaryTypeValuestring二级产品类型值thirdTypeValuestring三级产品类型值tupDeviceModelstringtup设备模式A.3设备列表接口返回示例：以JSON格式返回结果数据，格式定义如下：表A.5{"code":"0","msg":"成功","data":[{"deviceSn":"006","deviceId":,"deviceName":"测试厕改设备","productId":null,"deviceStatus":0,"deviceStatusStr":"已激活","netStatus":0,"netStatusStr":"在线","productProtocol":7,"productProtocolStr":"TCP协议","createTime":"2021-07-2109:32:46","updateTime":null,"activeTime":null,"offlineAt":"2021-07-2409:06:35","onlineAt":"2021-07-2409:06:44","facilityCategory":"XXX","dataSource":null}],"count":159}返回参数说明：见表A.6。表A.6参数名类型说明codeint当code为0成功返回数据MsgStringCode对应信息deviceSnString设备编号deviceIdString设备iddeviceNameString设备名称productIdString产品名称deviceStatusInt设备激活状态状态（.：已注册1：已激活2：已注销）deviceStatusStrString设备状态名称netStatusInt设备在线状态（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激活时间offlineAtString下线时间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}}返回参数说明：见表A.8。表A.8参数名类型必选说明codeint否当code为0成功返回数据msgstring否返回描述resultobject否返回结果productIdInt否产品IDproductNamestring否产品名称tenantIdInt否租户IDproductDescstring否产品描述productTypeInt否产品类别secondaryTypeint否二级分类thirdTypeInt否三级分类productProtocolint否Integer,产品协议：Integer,产品协议：1.T-LINK协议2.MQTT协议3.LWM2M协议4.TUP协议5.HTTP协议6.JT/T8087.TCP协议8.私有TCP(网关子设备协议)9.私有UDP(网关子设备协议)10.网关产品MQTT(网关产品协议)11.南向云协议authTypeint否Integer,认证方式1:特征串认证，2:sm9认证，3:dtls双向认证,4:IMEI认证,5:SIMID认证，6:SM2认证payloadFormatint否Integer,消息类型1:json，2:紧凑二进制createTimeInt否创建时间updateTimeInt否更新时间networkTypeInt否Integer,网络类型:1.wifi2.移动蜂窝数据3.NB-IoT4.以太网endpointFormatInt否Integer,Endpoint格式:1.IMEI2.URN:IMEI:###############3.URN:IMEI-IMSI:###############-###############4.URN:IMEI+SMpowerModelInt否Integer,省电模式：1.PSM2.DRX3.eDRXapiKeystring否MasterKeyonlineDeviceCountInt否在线设备数deviceCountint否设备总数productTypeValuestring否产品分类名称secondaryTypeValuestring否二级分类名称thirdTypeValuestring否三级分类名称rootCertInt否T-Link证书认证根证书createByString否创建者updateByString否更新者nodeTypeInt否节点类型：1.设备，2.网关accessTypeInt否接入类型:1.设备直连，2.网关接入，3.南向云接入，4.视图云接入tupIsThroughInt否是否透传：0.透传，1不透传（JT/T808，只有透传，消息格式必须只能传null）dataEncryptionInt否数据加密方式1:sm1,2:sm2,3:sm4,4:dtls,5:明文lwm2mEdrxTimeInt否eDRX模式时间窗A.5删除产品接口返回示例：以JSON格式返回结果数据，格式定义如下：表A.9{"code":0,"msg":"string"}返回参数说明：见表A.10。表A.10参数名类型说明codeint当code为0成功返回数据MsgStringCode描述A.6更新产品接口返回示例：以JSON格式返回结果数据，格式定义如下：表A.11{"code":0,"msg":"ok"}返回参数说明：见表A.12。表A.12参数名类型说明codeint当code为0成功返回数据MsgStringCode描述A.7创建设备接口返回示例：以JSON格式返回结果数据，格式定义如下：表A.13{ "code":0, "msg":"ok", "result":{ "deviceId":"89e920fa0eda47a89f04f52a88b17146", "deviceName":"test003", "tenantId":"300", "productId":10003304, "imei":"125658789874565", "deviceSn":"", "token":"Tyhp7mYXm1k_upy44j32vw8GlKGH8gwvgdayOX27_2E" }}返回参数说明：见表A.14。表A.14参数名类型说明CodeInt0表示返回成功MsgString返回结果描述productIdInt产品idtenantIdInt租户idimeiIntImei号deviceIdString设备iddeviceNameString设备名称deviceSnString设备sn号tokenString设备TokenA.8删除设备接口返回示例：以JSON格式返回结果数据，格式定义如下：表A.15{"code":0,"msg":"string"}返回参数说明：见表A.16。表A.16参数名类型说明codeint当code为0成功返回数据MsgStringCode描述A.9更新设备接口返回示例：以JSON格式返回结果数据，格式定义如下：表A.17{"code":0,"msg":"string"}返回参数说明：表A.18。表A.18参数名类型说明codeint当code为0成功返回数据MsgStringCode描述A.10获取物模型接口返回示例：以JSON格式返回结果数据，格式定义如下：表A.19{ "code":0, "msg":"ok", "result":{ "pageNum":1, "pageSize":1, "total":1, "list":[{ "propertyId":1, "propertyFlag":"asdggg", "propertyName":"属性1", "dataType":"fix-string", "unit":"g", "len":1, "unitName":"克每毫升", "description":"" },{ "propertyId":2, "propertyFlag":"a1", "propertyName":"a1", "dataType":"enum", "enumDetail":{ "1":"2", "3":"4", "5":"6" }, "len":1, "description":"test" },{ "propertyId":3, "propertyFlag":"a2", "propertyName":"a2", "dataType":"float", "unit":"ppm", "min":"1", "len":4, "unitName":"百万分率", "max":"2", "step":"1", "description":"1" },{ "propertyId":4, "propertyFlag":"a3", "propertyName":"a3", "dataType":"bool", "boolDetail":{ "false":"关", "true":"开" }, "len":1, "description":"test" }] }}返回参数说明：见表A.20。表A.20参数名类型说明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获取标准产品物模型接口返回示例：以JSON格式返回结果数据，格式定义如下：表A.21{ "code":0, "msg":"ok", "result":{ "properties":[{ "propertyFlag":"a1", "propertyName":"a1", "dataType":"enum", "enumDetail":{ "1":"2", "3":"4", "5":"6" }, "len":1, "description":"test" }, { "propertyFlag":"a2", "propertyName":"a2", "dataType":"float", "unit":"ppm", "min":"1", "len":4, "unitName":"百万分率", "max":"2", "step":"1", "description":"1" } ], "services":[{ "serviceId":8001, "serviceFlag":"a3", "serviceName":"a3", "serviceType":2, "eventType":1, "description":"a", "properties":[{ "propertyFlag":"a2", "serial":2 }], "parameters":[{ "parameterFlag":"c1", "parameterName":"c1", "dataType":"Int32", "unit":"g", "min":"1", "len":4, "unitName":"克每毫升", "max":"2", "step":"1", "description":"1", "serial":1 }] }] }}返回参数说明：见表A.22。表A.22参数名类型说明MsgString返回结果描述resultInt结果集totalInt总数serviceTypeIntInteger服务类型1.数据上报2.事件上报3.数据获取4.参数查询5.参数配置6.指令下发7.指令下发响应8.无线参数上报serviceFlagString服务标识serviceIdStringInteger服务IdserviceNameString服务名称eventTypeIntInteger事件类型只有事件上报才有值1:信息2:警告3:故障unitString单位lenInt长度minInt最小值stepInt步长propertyFlagString属性标识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, "total":1, "list":[{ "serviceId":1, "serviceFlag":"asdg", "serviceName":"阿萨德刚", "serviceType":2, "eventType":1, "description":"", "properties":[{ "propertyId":1, "propertyFlag":"asdggg", "propertyName":"属性1", "dataType":"fix-string", "unit":"g", "len":1, "unitName":"克每毫升", "description":"" },{ "propertyId":2, "propertyFlag":"a1", "propertyName":"a1", "dataType":"enum", "enumDetail":{ "1":"2", "3":"4", "5":"6" }, "len":1, "description":"test" },{ "propertyId":4, "propertyFlag":"a3", "propertyName":"a3", "dataType":"bool", "boolDetail":{ "false":"关", "true":"开" }, "len":1, "description":"test" }], "parameters":[{ "parameterId":17, "parameterFlag":"cellId", "parameterName":"cellId", "dataType":"integer", "unit":"null", "min":-2147483648, "len":4, "unitName":"", "max":2147483647, "description":"" }] }] }}返回参数说明：见表A.24。表A.24参数名类型说明MsgString返回结果描述resultInt结果集totalInt总数serviceTypeIntInteger服务类型1.数据上报2.事件上报3.数据获取4.参数查询5.参数配置6.指令下发7.指令下发响应8.无线参数上报pageNumIntInteger当前页数serviceFlagstring服务标识符descriptionString描述eventTypeStringInteger事件类型只有事件上报才有值1:信息2:警告3:故障serviceIdIntInteger服务IdunitString单位minInt最小值parameterIdIntInteger参数IdlenIntInteger长度unitNameInt单位名称dataTypeInt数据类型:二进制数据类型及对应枚举值:整型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,时间戳dateparameterFlagInt参数标识propertyFlagstring属性标识propertyNameString属性名称A.13智能垃圾桶数据上报接口返回示例：以JSON格式返回结果数据，格式定义如下：表A.25{"code":0,"msg":"ok","result":{ {"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,"powerThreshold":0,"fullState":"0","inclineState":"0","high":464,"deviceNo":null,"imei":null}}参数说明：见表A.26。表A.26参数名类型必选说明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号A.14人员卡牌设备数据上报接口返回示例：以JSON格式返回结果数据，格式定义如下：表A.27{"code":"0","msg":"成功","data":[{"deviceId":"e978a25e8c6d4e9fbe9286cedc6aedcd","uploadTime":null,"longitude":"114.1700000","latitude":"26.4400000","speed":2,"direction":null,"signal":null,"battery":"31","gpsFlag":null,"receiveTime":"2021-07-2118