1. 环境检测历史数据
获取环境历史数据
注意
- 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
- 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过
网页授权
接口获取相关信息。
1.1. 基本信息
概况 | 内容 |
---|---|
接口地址 | /api/device/environment/history |
请求方法 | GET |
请求数据类型 | URL参数 |
响应数据类型 | JSON |
1.2. 请求数据
1.2.1. 请求头(request-header)
请求头除了默认的参数还需要添加如下请求头参数:
字段 | 描述 |
---|---|
auth-token | 接口访问凭据,你可以通过平台下发的appid和secret获取凭据 |
1.2.2. 请求参数(request-parameter)
字段 | 是否必传 | 描述 |
---|---|---|
dateType | 是 | 时间类型 1-近一天 2-近一周 3-近一月 |
deviceId | 是 | 设备id |
projectId | 是 | 项目ID |
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 | array | 是 | 响应数据 |
averageHistory | number | 是 | 平均值 |
countHistory | number | 是 | 总数 |
createTime | number | 是 | 创建时间 |
createUserId | string | 是 | 创建用户id |
deviceId | string | 是 | 设备id |
editTime | number | 是 | 编辑时间 |
editUserId | string | 是 | 编辑用户id |
fieldCode | string | 是 | 编码 |
id | string | 是 | id |
isDelete | string | 是 | 删除标识 |
maxHistory | number | 是 | 最大值 |
minHistory | number | 是 | 最小值 |
recordTime | number | 是 | 记录时间 |
remarks | string | 是 | 备注 |
type | number | 是 | 类型 |
version | number | 是 | 版本 |
响应数据结构如下所示:
{
"code": 0,
"message": null,
"data": [
{
"averageHistory": 0.5891945392491468,
"countHistory": 1465,
"createTime": 0,
"createUserId": "",
"deviceId": "xxxxxxxxxxxx",
"editTime": 0,
"editUserId": "",
"fieldCode": "windSpeed",
"id": "",
"isDelete": "",
"maxHistory": 3.12,
"minHistory": 0,
"recordTime": 1653192000000,
"remarks": "",
"type": 0,
"version": 0
}
]
}
1.4. 错误码
当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。