标准文本-《农村人居环境长效管护平台数据交换规范》

1、ICS FORMTEXT 点击此处添加ICS号 FORMTEXT 点击此处添加中国标准文献分类号 FORMTEXT DB FORMTEXT FORMTEXT 江西省地方标准DB FORMTEXT XX/ FORMTEXT XXXXX FORMTEXT XXXX FORMTEXT FORMTEXT 农村人居环境长效管护平台农村人居环境长效管护平台农村人居环境长效管护平台数据交换规范 FORMTEXT Interface specification for village environmental governance and long-term management and protectio

2、n platform FORMTEXT 点击此处添加与国际标准一致性程度的标识 FORMDROPDOWN FORMTEXT FORMTEXT XXXX - FORMTEXT XX - FORMTEXT XX发布 FORMTEXT XXXX - FORMTEXT XX - FORMTEXT XX实施 FORMTEXT 江西省质量监督管理局发布DBXX/ XXXXXXXXX HYPERLINK l _Toc3454 前言 PAGEREF _Toc3454 h III HYPERLINK l _Toc16202 引言 PAGEREF _Toc16202 h IV HYPERLINK l _Toc22

3、721 1 范围 PAGEREF _Toc22721 h 1 HYPERLINK l _Toc11896 2 规范性引用文件 PAGEREF _Toc11896 h 1 HYPERLINK l _Toc31470 3 术语和定义 PAGEREF _Toc31470 h 1 HYPERLINK l _Toc20715 3.1 农村人居环境长效管护平台 (Rural living environment long-term management platform) PAGEREF _Toc20715 h 1 HYPERLINK l _Toc28745 3.2 物联网监测数据共享模块/系统(IOT

4、monitoring data sharing module / system) PAGEREF _Toc28745 h 1 HYPERLINK l _Toc29661 4 概述 PAGEREF _Toc29661 h 2 HYPERLINK l _Toc13060 5 接口要求 PAGEREF _Toc13060 h 2 HYPERLINK l _Toc2839 5.1 约定 PAGEREF _Toc2839 h 2 HYPERLINK l _Toc10425 6 接口设计规范 PAGEREF _Toc10425 h 3 HYPERLINK l _Toc27376 6.1 基本规范 PAGE

5、REF _Toc27376 h 3 HYPERLINK l _Toc32631 6.2 返回错误码code PAGEREF _Toc32631 h 3 HYPERLINK l _Toc26600 7 设备数据上报频次规范 PAGEREF _Toc26600 h 3 HYPERLINK l _Toc20924 8 数据提供方 PAGEREF _Toc20924 h 3 HYPERLINK l _Toc24502 8.1 身份认证 PAGEREF _Toc24502 h 3 HYPERLINK l _Toc29846 8.1.1 获取令牌接口 PAGEREF _Toc29846 h 3 HYPER

6、LINK l _Toc22015 8.2 设备管理 PAGEREF _Toc22015 h 4 HYPERLINK l _Toc31829 8.2.1 产品列表 PAGEREF _Toc31829 h 4 HYPERLINK l _Toc27030 8.2.2 设备列表 PAGEREF _Toc27030 h 4 HYPERLINK l _Toc315 8.2.3 新建产品 PAGEREF _Toc315 h 5 HYPERLINK l _Toc23423 8.2.4 删除产品 PAGEREF _Toc23423 h 7 HYPERLINK l _Toc27333 8.2.5 更新产品 PAG

7、EREF _Toc27333 h 7 HYPERLINK l _Toc7598 8.2.6 创建设备 PAGEREF _Toc7598 h 8 HYPERLINK l _Toc29175 8.2.7 删除设备 PAGEREF _Toc29175 h 9 HYPERLINK l _Toc16518 8.2.8 更新设备 PAGEREF _Toc16518 h 9 HYPERLINK l _Toc31561 8.2.9 获取物模型 PAGEREF _Toc31561 h 10 HYPERLINK l _Toc32156 8.2.10 获取标准产品物模型 PAGEREF _Toc32156 h 11

8、 HYPERLINK l _Toc11514 8.2.11 获取服务列表信息 PAGEREF _Toc11514 h 11 HYPERLINK l _Toc20814 8.2.12 智能垃圾桶数据上报 PAGEREF _Toc20814 h 12 HYPERLINK l _Toc3262 8.2.13 人员卡牌设备数据上报 PAGEREF _Toc3262 h 13 HYPERLINK l _Toc25115 8.2.14 智慧厕改设备数据上报 PAGEREF _Toc25115 h 14 HYPERLINK l _Toc2090 8.2.15 污水监测设备上报数据 PAGEREF _Toc2

9、090 h 14 HYPERLINK l _Toc11254 8.2.16 车载设备数据上报 PAGEREF _Toc11254 h 15 HYPERLINK l _Toc9558 8.2.17 空气站设备数据上报 PAGEREF _Toc9558 h 16 HYPERLINK l _Toc22239 9 数据需求方 PAGEREF _Toc22239 h 17 HYPERLINK l _Toc17783 9.1 设备数据管理 PAGEREF _Toc17783 h 17 HYPERLINK l _Toc7045 9.1.1 获取设备监测数据 PAGEREF _Toc7045 h 17 HYP

10、ERLINK l _Toc29071 9.1.2 获取设备原始上传数据包 PAGEREF _Toc29071 h 18 HYPERLINK l _Toc28097 9.1.3 获取设备上报事件信息 PAGEREF _Toc28097 h 18 HYPERLINK l _Toc10600 9.1.4 获取智能垃圾桶数据 PAGEREF _Toc10600 h 18 HYPERLINK l _Toc9260 9.1.5 获取人员卡牌设备数据 PAGEREF _Toc9260 h 19 HYPERLINK l _Toc12134 9.1.6 获取污水监测设备数据 PAGEREF _Toc12134

11、h 19 HYPERLINK l _Toc19740 9.1.7 获取车载设备数据 PAGEREF _Toc19740 h 20 HYPERLINK l _Toc24570 9.1.8 获取智慧厕改设备数据 PAGEREF _Toc24570 h 20 HYPERLINK l _Toc9419 9.1.9 获取空气站设备数据 PAGEREF _Toc9419 h 20附录A（资料性）接口返回示例22前言本标准按照GB/T 1.12009标准化工作导则 第1部分:标准的结构和编写给出的规则起草。本标准由江西省农业农村厅提出并归口。本标准起草单位：江西省农业技术推广中心、江西电信信息产业有限公司、

12、江西省数字乡村研究院本标准主要起草人：陈勋洪、钟志宏、杨眉、黄建昌、张敏、徐军亮、姜凯文、邓碧岩、官文峰。引言当前农村人居环境长效管护平台接入的物联网监测平台较多，涉及设备品牌繁多，各厂家平台及设备数据标准不一，从而导致对接成本、维护成本、运营成本的增加，制约了平台的快速建设推广。为有效加强全省农村人居环境长效管护平台建设的统一规划、统一管理、协调运行和维护服务，建立健全全省农村人居环境长效管护平台的数据交换规范标准，推动农村人居环境长效管护平台的建设运营有序发展，提升各级政府及其部门的农村人居环境治理水平，现根据国家、地方相关文件要求和标准规范，结合我省农村人居环境治理现状和发展要求，制定本

13、规范。农村人居环境长效管护平台数据交换规范范围本标准规定了江西省农村人居环境长效管护平台数据交换的相关术语和定义、设计要求及接口要求。本标准适用于江西省农村人居环境长效管护平台设计规范。规范性引用文件下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅所注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB/T 29765-2021 信息安全技术数据备份与恢复产品技术要求与测试评价方法GB/T 20271 信息安全技术信息系统通用安全技术要求GB/T 20273-2019 信息安全技术数据库管理系统安全技术要求GB/T 31496-2015

14、 信息技术安全技术信息安全管理体系实施指南GB/T 21063.6 政务信息资源目录体系 第6部分：技术管理要求GB/T 15629 信息技术系统间远程通信和信息交换局域网和城域网GB/T 28181-2016 安全防范视频监控联网系统信息传输、交换、控制技术要求DB36/T 981-2017 电子政务共享数据统一交换平台技术规范DB36/T 9842017 政务服务网集成对接规范DB36/T 11792019 政务数据共享技术规范GB/T 33745-2017 物联网术语GB/T 36478.1-2018 信息交换和共享术语和定义GB/T 33745-2017、GB/T 36478.1-20

15、18界定的以及下列术语和定义适用于本文件。农村人居环境长效管护平台 (Rural living environment long-term management platform)采用物联网、云计算、大数据、AI等新一代信息技术，通过数字化技术驱动农村人居环境有效治理，实现农村人居环境长效管护数字化、环境监测智能化、公众监督便捷化。平台集“投诉、整改、反馈、监督”等功能为一体，以实现农村人居环境持续改善及治理长效管护为目的，推动乡村由“一时美”向“持久美”转变。 物联网监测数据共享模块/系统(IOT monitoring data sharing module / system)物联网监测数据

16、共享模块/系统（以下简称“共享平台”），是面向农村人居环境进行智能化监测的传感设备，这些设备的动态监测数据统一存储在农村人居环境长效管护平台，并建立数据共享模块来提供数据服务。概述依据国标GB/T 33745-2018中的规定，交换和共享数据模块/系统既可以是物联网系统中的一个功能模块，也可以是一个独立的系统，通过数据接口方式，数据提供方通过物联网系统将交换和共享的数据导入到对应的模块/系统；数据需求方从物联网相应模块/系统获取物联网数据，数据接口如图1所示。图1 数据接口接口要求约定本章给出了共享平台的基本接口方法、参数。接口应与物联网系统的软件平台无关，接口宜采用WebService技术实

17、现。以下接口描述，只规定了共享平台实现的基本接口方法、参数项目、参数类型、参数格式及命名规范。 为便于提供方和需求方统一调用数据，接口方法和参数宜采用英文命名。接口设计规范基本规范接口地址： HYPERLINK http:/xxx.xxx.xxx.xxx:xxxx/TiotCloud-B http:/xxx.xxx.xxx.xxx:xxxx/。 接口协议：WebService。编码方式：UTF-8。交换格式：JSON。返回错误码code接口错误码返回标准规范见表1：表1：返回错误码code及描述参数名code值描述0成功999失败1111正在处理设备数据上报频次规范7.1 数据上报频次 智能垃

18、圾桶：6小时/条，或12小时/条。水质监测设备：6小时/条，或12小时/条。气味探测器：6小时/条，或12小时/条。车载/卡牌：1分钟以上/条。 环境探测器：6小时/条。 数据提供方身份认证获取令牌接口接口方法： getToken。接口路径：api/open/oauth/。请求方式：POST。请求参数： 见表2。表2 getToken参数名必选类型说明app_id是string由平台颁发app_secret是string由平台颁发返回示例：见附录A.1。设备管理产品列表简要描述： 获取农村人居环境长效管护平台标准物联网产品。接口方法：getProductList。接口路径： api/open/

19、product/。请求方式：POST。参数： 见表3。表3 getProductList报头参数名必选类型说明token是String通信证key参数名必选类型说明productName否string产品名称productProtocol否Integer产品协议：Integer,产品协议：1.T-LINK协议 2.MQTT协议 3.LWM2M协议 4.TUP协议 5.HTTP协议 6.JT/T808 7.TCP协议 8.私有TCP(网关子设备协议) 9.私有UDP(网关子设备协议) 10.网关产品MQTT(网关产品协议) 11.南向云productId是Int产品id返回示例:见附录A.2。设

20、备列表简要描述： 获取农村人居环境长效管护平台设备列表。接口方法：getDeviceList。接口路径： api/open/device/。请求方式：POST。请求参数：见表4。表4 getDeviceList报头参数名必选类型说明Token是String通信证key参数名必选类型说明netStatus否Int设备状态deviceNo否String设备编号productId是String产品idgridCode是String区域code返回示例:见附录A.3。新建产品简要描述： 添加产品(产品为设备直连+非NB网关协议)。接口方法：CreateProduct。接口路径： api/open/pr

21、oduct/。请求方式：POST。 请求参数： 见表5。表5 CreateProduct报头参数名必选类型说明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, payl

22、oadFormat: 0, powerModel: 0, productDesc: string, productName: string, productProtocol: 0, productType: string, secondaryType: string, thirdType: string, tupIsThrough: 0, tupDeviceModel: string描述：productName：产品名称（必填）：产品名称最多 64 个字符，产品名称必须包含数字或字母或汉字，产品名称不能重复productType：产品分类（必填）secondaryType：二级分类（必填）th

23、irdType：三级分类（必填）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/T808 7.TCP协议 10.网关MQTT协议authType：认证方式 1:特征串认证,2:SM9认证,3:证书认

24、证,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协议 制造

25、商IDendpointFormat:Endpoint格式（LWM2M协议必填）:1.IMEI2.URN:IMEI:#3.URN:IMEI-IMSI: #-# 4.URN:IMEI+SM9powerModel：省电模式（LWM2M协议必填）：1.PSM 2.DRX 3.eDRXlwm2mEdrxTime:eDRX模式时间窗(LWM2M协议,当省电模式为3时,必填):20 10485.76 间的值,精确到小数点后两位productDesc：产品描述（选填）：产品描述最多100个字符tupDeviceModel:设备型号，选填，设备直连并且非JT/T808协议产品必填返回示例: 见附录A.4。删除产

26、品简要描述： 删除产品数据，如果产品下有设备数据，则无法删除产品。接口方法：deleteProduct。接口路径： api/open/product/。请求方式：Delete。请求参数：见表6。表6 deleteProduct报头参数名必选类型说明token是String通信证keyMasterKey是stringMasterKey在该设备所属产品的概况中可以查看报体参数名必选类型说明productId是Int产品idgridCode是String区域code返回示例：见附录A.5更新产品简要描述： 更新产品数据。接口方法：updateProduct。接口路径： api/open/produc

27、t/。请求方式：put。请求参数：见表7。表7 updateProduct报头参数名必选类型说明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：产品名称，产品名称租户

28、内不能重复，必填productDesc：产品描述，选填endpointFormat：endpoint类型(Lwm2m协议必填) 1.IMEI 2.URN:IMEI:# 3.URN:IMEI-IMSI: #-# 4.URN:IMEI+SM9注：认证方式为SM9认证时，endpoint类型为4 认证方式为IMEI认证、sm2认证时，endpoint类型为1、2、3powerModel：省电模式(Lwm2m协议必填) 1.PSM 2.DRX 3.eDRXlwm2mEdrxTime：eDRX模式时间窗(LWM2M协议,当省电模式为3时,必填):20 10485.76 间的值,精确到小数点后两位返回示例

29、：见附录A.6。创建设备简要描述： 增加设备。接口方法：CreateDevice。接口路径： api/open/device/。请求方式：POST。请求参数：见表8。表8 CreateDevice报头参数名必选类型说明token是String通信证key报体参数名必选类型说明MasterKey是StringMasterKey在该设备所属产品的概况中可以查看gridCode是String区域codedeviseName是String设备名称deviceSn是String设备编号Imei是StringImei号productId是Int产品idoperator是String操作人返回示例：见附录A

30、.7。删除设备简要描述： 删除设备数据。接口方法：deleteDevice。接口路径： api/open/device/。请求方式：Delete。请求参数：见表9。表9 deleteDevice报头参数名必选类型说明token是String通信证key报体参数名必选类型说明productId是Int产品iddeviceIds是string可以删除多个设备（最多支持200个设备）。多个设备id，中间以逗号 , 隔开 。MasterKey是StringMasterKey在该设备所属产品的概况中可以查看gridCode是String区域code返回示例：见附录A.8更新设备简要描述： 更新设备数据。

31、接口方法：updateDevice。接口路径： api/open/device/。请求方式：PUT。请求参数：见表10。表10 updateDevice报头参数名必选类型说明token是String通信证keyMasterKey是String请求参数名必选类型说明gridCode是String区域code请求body（数据类型application/json;charset=utf-8） deviceName: string, operator: string, other: autoObserver:0, imsi:12545154878451, productId: 0描述：deviceN

32、ame: 设备名称，选填operator: 操作者，必填other: LWM2M协议必填参数,其他协议不填： autoObserver:0.自动订阅 1.取消自动订阅，订阅指的是平台订阅设备能够上报的object数据 选填; imsi:总长度不超过15位，使用09的数字，String类型 选填;productId: 产品ID，必填 返回示例：见附录A.9获取物模型简要描述： 查询属性列表信息，获取标准数据参数名称及数据类型接口方法：QueryPropertyList接口路径： api/open/model/properties/请求方式：GET请求参数：见表11。表11 QueryProper

33、tyList报头参数名必选类型说明token是String通行证keyMasterKey是StringMasterKey在该设备所属产品的概况中可以查看报体参数名必选类型说明productId是Int产品IdsearchValue否String可填值：属性名称，属性gridCode否String区域codepageNow否Int当前页数pageSize否Int每页记录数返回示例：见附录A.10获取标准产品物模型简要描述： 标准农村人居环境长效管护平台标准物模型。接口方法：QueryStandardModel。接口路径： api/open /standardModel/。请求方式：GET。请求参

34、数：见表12。表12 QueryStandardModel报头参数名必选类型说明token是String通信证keyMasterKey是StringMasterKey在该设备所属产品的概况中可以查看报体参数名必选类型说明standardVersion否String标准物模型版本号thirdType否Int三级分类id返回示例：见附录A.11。 获取服务列表信息简要描述： 获取农村人居环境长效管护平台服务列表信息。接口方法：QueryPropertyList。接口路径： api/open/model/properties/。请求方式：GET。请求参数：见表13。表13 QueryProperty

35、List报头参数名必选类型说明token是String通信证keyMasterKey是StringMasterKey在该设备所属产品的概况中可以查看报体参数名必选类型说明productId是Int产品IdsearchValue否String可填值：属性名称，属性标识符gridCode是String区域codepageNow否Int当前页数pageSize否Int每页记录数智能垃圾桶数据上报简要描述： 智能垃圾桶设备上报数据。接口方法：uploadRubbishData。接口路径： api/open/uploadData/。请求方式：Post。请求参数：见表14。报头参数名必选类型说明token

36、是String通信证key表14 uploadRubbishData报体参数名必选类型说明body是String智能垃圾桶标准物模型请求Body（数据类型application/json;charset=utf-8） deviceId: be04c3519c5740c1b82fe0fceb9d2e82, uploadTime: 2021-07-19 16:29:41, latitude: 0.0, longitude: 0.0, errorCode: 0000, fireState: 0, tiltAngle: 0, powerState: 0, temperature: 24, device

37、State: 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

38、/。请求方式：Post。请求参数：见表15。表15 uploadCardData报头参数名必选类型说明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: 202

39、1-07-21 18:13:06.133, createTime: 2021-07-22 09:55:54, heading: null, valid: 0, imei: null 返回示例：见附录A.14。智慧厕改设备数据上报简要描述： 厕改设备上报数据。接口方法：uploadToiletData。接口路径： api/open/uploadData/。请求方式：Post。请求参数：见表16。表16 uploadToiletData报头参数名必选类型说明token是String通信证key报体参数名必选类型说明body是String智慧厕改设备标准物模型请求body deviceId: 150

40、67733001, deviceName: null, uploadTime: 2021-08-27 15: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: nul

41、l, createTime: null, imei: null 返回示例：见附录A.15。污水监测设备上报数据简要描述： 污水监测设备上报数据。接口方法：uploadWaterData。接口路径： api/open/uploadData/。请求方式：Post。请求参数：见表17。表17 uploadWaterData报头参数名必选类型说明token是String通信证key报体参数名必选类型说明body是String污水监测设备标准物模型请求body deviceId: 15036215BK7201SN001625, uploadTime: 2021-08-04 17:01:03, tempe

42、rature: 29, conductivity: 1, turbidity: 1348.2, ph: 7.31, doxygen: 5.670000076293945, imei: null 返回示例：见附录A.16。车载设备数据上报简要描述： 车载设备上报数据。接口方法：uploadCarData。接口路径： api/open/uploadData/。请求方式：Post。请求参数：见表18。表18 uploadCarData报头参数名必选类型说明token是String通信证key报体参数名必选类型说明body是String车载设备标准物模型请求body： deviceId: a6fdce

43、27e9844ba5b0b9f97ae7d40136, uploadTime: 2021-04-02 15: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:

44、0, gpsswitch: 1, imei: null 返回示例：见附录A.17。空气站设备数据上报简要描述： 空气站设备上报数据。接口方法：uploadtAirData。接口路径： api/open/uploadData/。请求方式：Post。请求参数：见表19。 表19 uploadtAirData报头参数名必选类型说明token是String通信证key报体参数名必选类型说明body是String空气站标准物模型请求body deviceId: temperature: 0, humidity: 0, windSpeed: 0, windDirection: 0

45、, pressure: 0, uploadTime: 2021-07-22 11: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。表20 getDeviceDataB

46、yId报头参数名必选类型说明token是String通行证key参数名必选类型说明deviceId是string设备IdfacilityCategory是string设备类别startTime否string开始时间endTime否string结束时间返回示例：见附录A.19。获取设备原始上传数据包简要描述： 获取设备原始上传数据格式接口方法：getBasicDataList接口路径： api/open/ basicData/请求方式：POST 请求参数：见表21。表21 getBasicDataList参数名必选类型说明deviceName否string设备名称deviceId是String设

47、备idgridCode是String区域code返回示例：见附录A.20。获取设备上报事件信息简要描述： 获取设备上报事件信息。接口方法：getEventBasicDataList。接口路径： api/open/events/。请求方式：POST。请求参数：见表22。表22 getEventBasicDataList参数名必选类型说明deviceName否string设备名称iotEventType否string事件类型deviceId是String设备idgridCode是String区域code返回示例：见附录A.21。获取智能垃圾桶数据简要描述： 获取智能垃圾桶设备上报数据。接口方法：g

48、etRubbishData。接口路径： api/open/deviceData/。请求方式：Post。请求参数：见表23。表23 getRubbishData报头参数名必选类型说明token是String通信证key参数名必选类型说明gridCode是String区域codedeviceId是String设备Id返回示例：见附录A.22。获取人员卡牌设备数据简要描述： 获取卡牌设备上报数据。接口方法：getCardData。接口路径： api/open/deviceData/。请求方式：Post。请求参数：见表24。表24 getCardData报头参数名必选类型说明token是String通

49、信证key请参数名必选类型说明gridCode是String区域codedeviceId是String设备Id返回示例：见附录A.23。获取污水监测设备数据简要描述： 获取污水监测设备上报数据。接口方法：getWaterData。接口路径： api/open/deviceData/。请求方式：Post。请求参数：见表25。表25 getWaterData报头参数名必选类型说明token是String通信证key报体参数名必选类型说明gridCode是String区域codedeviceId是String设备Id返回示例：见附录A.24。获取车载设备数据简要描述： 获取车载设备上报数据。接口方法

50、：getCarData。接口路径： api/open/deviceData/。请求方式：Post。请求参数：见表26。表26 getCarData报头参数名必选类型说明token是String通信证key报体参数名必选类型说明gridCode是String区域codedeviceId是String设备Id返回示例：见附录A.25。获取智慧厕改设备数据简要描述： 获取厕改设备上报数据。接口方法：getToiletData。接口路径： api/open/deviceData/。请求方式：Post。请求参数：表27。表27 getToiletData报头参数名必选类型说明token是String通信

51、证key报体参数名必选类型说明gridCode是String区域codedeviceId是String设备Id返回示例：见附录A.26。获取空气站设备数据简要描述： 获取空气站设备上报数据。接口方法：getAirData。接口路径： api/open/deviceData/。请求方式：Post。请求参数：见表28。表28 getAirData报头参数名必选类型说明Token是String通信证key报体参数名必选类型说明gridCode是String区域codedeviceId是String设备Id返回示例：见附录A.27。附录A（资料性）接口返回示例A.1 获取令牌接口返回示例 以JSON格

52、式返回结果数据，格式定义如下：表A.1 msg:success, code:0, data:expireTime:2021-03-3010:24:28,expire:86400,token:eyJhbGciOiJIUzUxMiJ9.eyJhcHBTZWNyZXQiOiJudWxsIiwiZXhwIjoxNjI5NjgxNTA2LCJjcmVhdGVkIjoxNjI5NjgwNjA2ODM4LCJhcHBJZCI6Im51bGwifQ.l-OCLUw8TTEyngvpExaJ7Q-sBCZiVDVJxGDEEHCcrHxo9-rx_-8RbGVqT7IEjsFqMHAM_CJAfatYjaNfh

53、0JZ7g 返回参数说明：见表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: 15359424

54、87000,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: 测试,ten

55、antId: 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.L

56、WM2M协议 4.TUP协议 5.HTTP协议 6.JT/T808 7.TCP协议 8.私有TCP(网关子设备协议) 9.私有UDP(网关子设备协议) 10.网关产品MQTT(网关产品协议) 11.南向云）payloadFormatint数据上报格式(Integer,消息类型 1:json，2:紧凑二进制)powerModelStrstring电源模式描述productProtocolStrstring产品协议描述payloadFormatStrstring数据上报格式描述endpointFormatStrstringendpoint格式描述authTypeStrstring认证方式描述net

57、workTypeStrstring网络类型描述productNamestring产品名称描述productDescstring产品描述endpointFormatintendpoint格式authTypeint认证方式（Integer,认证方式 1:特征串认证，2:sm9认证，3:dtls双向认证,4:IMEI认证,5:SIMID认证,6:sm2认证）apiKeystringapikeycreateTimestring创建时间updateTimestring更新时间productTypeint产品类别secondaryTypestring二级类别thirdTypestring三级类别produ

58、ctTypeValuestring产品类型值secondaryTypeValuestring二级产品类型值thirdTypeValuestring三级产品类型值tupDeviceModelstringtup设备模式A.3 设备列表接口返回示例：以JSON格式返回结果数据，格式定义如下：表 A.5 code: 0, msg: 成功, data: deviceSn: 006, deviceId: deviceName: 测试厕改设备, productId: null, deviceStatus: 0, deviceStatusStr: 已激活, netStatus: 0,

59、 netStatusStr: 在线, productProtocol: 7, productProtocolStr: TCP协议, createTime: 2021-07-21 09:32:46, updateTime: null, activeTime: null, offlineAt: 2021-07-24 09:06:35, onlineAt: 2021-07-24 09:06:44, facilityCategory: XXX, dataSource: null , count: 159返回参数说明：见表A.6。表A.6参数名类型说明codeint当code 为0 成功返回数据MsgS

60、tringCode对应信息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协议