1. 获取卸料平台基本概况
获取指定项目下卸料平台设备的基本概况
注意
- 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
- 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过
网页授权
接口获取相关信息。
1.1. 基本信息
概况 | 内容 |
---|---|
接口地址 | /api/device/unloading/overview |
请求方法 | GET |
请求数据类型 | URL参数 |
响应数据类型 | JSON |
1.2. 请求数据
1.2.1. 请求头(request-header)
请求头除了默认的参数还需要添加如下请求头参数:
字段 | 描述 |
---|---|
auth-token | 接口访问凭据,你可以通过平台下发的appid和secret获取凭据 |
1.2.2. 请求参数(request-parameter)
字段 | 是否必传 | 描述 |
---|---|---|
projectId | 是 | 项目ID |
deviceName | 否 | 设备名 |
pageNum | 是 | 页码,整数,从1开始 |
pageSize | 是 | 分页数据量,取值为1到100之间的整数 |
参数请求示例:
http://api.example.com/xxx?key=value
1.3. 响应数据
响应数据中 code, message, data 为默认字段,所有字段如下表所示:
字段 | 类型 | 是否必填 | 描述 |
---|---|---|---|
code | number | 是 | 响应码 |
message | string | 是 | 响应消息 |
data | array | 是 | 响应数据 |
deviceName | string | 是 | 设备名称 |
deviceId | string | 是 | 设备id |
state | number | 是 | 设备状态 0-离线 1-在线 2-异常 |
todayLoad | number | 是 | 今日载重 |
historyLoad | number | 是 | 历史载重 |
todayOverCount | number | 是 | 今日超限 |
historyOverCount | number | 是 | 历史超限 |
响应数据结构如下所示:
{
"code": 0,
"message": null,
"data": [
{
"deviceName": "device1",
"deviceId": "asdjakjdakj123j12lkjlk",
"state": 1,
"todayLoad": 211.35,
"historyLoad": 1523.23,
"todayOverCount": 2,
"historyOverCount": 3
}
]
}
1.4. 错误码
当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。