1. 升降机接收数据外部接口
接收升降机实时数据
注意
- 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
- 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过
网页授权
接口获取相关信息。
1.1. 1. 基本信息
概况 | 内容 |
---|---|
接口地址 | /api/device/elevator/current/data |
请求方法 | POST |
请求数据类型 | JSON |
响应数据类型 | JSON |
1.2. 2. 请求数据
1.2.1. 请求头(request-header)
请求头除了默认的参数还需要添加如下请求头参数:
字段 | 描述 |
---|---|
auth-token | 接口访问凭据,你可以通过平台下发的appid和secret获取凭据 |
Content-Type | application/json;charset=UTF-8 |
1.2.2. 请求体(request-body)
字段 | 类型 | 是否必填 | 描述 |
---|---|---|---|
projectId | string | 是 | 项目id |
data | array | 是 | 轻筑设备信息 |
recordTime | string | 是 | 监测时间,格式为:yyyy-mm-dd hh:mm:ss |
deviceCode | string | 是 | 轻筑设备编码 |
operatorId | string | 否 | 操作人ID |
load | string | 是 | 当前载重(kg) |
cperson | string | 否 | 当前人数 |
height | string | 是 | 当前高度(m) |
state | string | 是 | 运行状态,0 停止;1 上升;2 下降 (若不传相关参数,则系统会默认为0) |
speed | string | 是 | 运行速度(m/s) |
stateStaff | string | 否 | 人员在岗状态:0在岗;1离岗 |
alarmOrNot | string | 是 | 是否出现预警,0:标识为无预警,1:标识为存在预警。若存在预警时,预警类型、预警原因与临界值都需填写具体参数 |
alarmType | string | 否 | 当前预警编码类型,参考参数编码说明 |
alarmReason | string | 否 | 预警原因(1:大于;2:小于) |
threshold | string | 否 | 该项参数预警的临界值 |
请求体数据结构如下所示:
{
"projectId": "",
"data": [
{
"recordTime": "",
"deviceCode": "",
"operatorId": "",
"load": "",
"cperson": "",
"height": "",
"state": "",
"speed": "",
"stateStaff": "",
"alarmOrNot": "",
"alarmType": "",
"alarmReason": "",
"threshold": ""
}
]
}
1.3. 3. 响应数据
响应数据中 code, message, data 为默认字段,所有字段如下表所示:
字段 | 类型 | 是否必填 | 描述 |
---|---|---|---|
code | number | 是 | 返回码,1为正常返回,其他为错误返回 |
message | string | 是 | 返回消息 |
data | string | 是 | 正常返回数据字段,可能为null |
响应数据结构如下所示:
{
"code" : 1,
"message" : "XXX",
"data" : null
}
1.4. 4. 错误码
当返回数据中的 code 不为 1 时,为错误返回。其中errCode为详细的错误码。
1.5. 5. 参数编码说明
当返回数据中的 code 不为 1 时,为错误返回。其中errCode为详细的错误码。 编码 升降机预警类型 01 载重 02 运行速度 03 高度