1. 环境监测预警数据

获取环境监测预警数据

注意

  • 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
  • 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过网页授权接口获取相关信息。

1.1. 基本信息

概况 内容
接口地址 /api/device/environment/warn
请求方法 GET
请求数据类型 URL参数
响应数据类型 JSON

1.2. 请求数据

1.2.1. 请求头(request-header)

请求头除了默认的参数还需要添加如下请求头参数:

字段 描述
auth-token 接口访问凭据,你可以通过平台下发的appid和secret获取凭据

1.2.2. 请求参数(request-parameter)

字段 是否必传 描述
deviceId 设备id
pageNum 页码,整数,从1开始
pageSize 分页数据量,取值为1到100之间的整数
dateType 时间参数:1-1天内,2-一周内,3-30天内
paramType 环境监测参数类型 1-温度 2-pm25 3-pm10 4-风速 5-湿度 6-噪声

参数请求示例:

http://api.example.com/xxx?key=value

1.3. 响应数据

响应数据中 code, message, data 为默认字段,所有字段如下表所示:

字段 类型 是否必填 描述
code number 响应码
message string 响应消息
data object 响应数据
pages number 总页数
hasNext boolean 是否有下一页
total number 总条数
list array 数据
warningMethod string 判断类型 0-大于;1-大于等于;2-等于;3-小于等于;4-小于;
unit string 单位
warningMethodName string 判断说明
warningDate number 预警时间
name string 预警项名称
threshold number 阈值
value number 监测值
level number 预警等级(0 =1级预警,1 = 2级预警)

响应数据结构如下所示:

{
    "code": 0,
    "message": null,
    "data": {
        "pages": 1,
        "hasNext": false,
        "total": 2,
        "list": [
            {
                "warningMethod":"1",
                "unit":"℃",
                "warningMethodName":"大于",
                "warningDate":1533795390000,
                "name":"温度",
                "threshold":35.5,
                "value":38.2,
                "level":null
            }
        ]
    }
}

1.4. 错误码

当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。

© All Rights Reserved            updated 2024-08-23 10:14:55

results matching ""

    No results matching ""