HTTP/HTTPS
请求协议
中科图灵开放平台 / 智慧消防监测概览模块 / 建筑信息总览-根据建筑id查询各楼层状态数据
建筑信息总览-根据建筑id查询各楼层状态数据
接口地址:https://api.iot.ink/api/app.php?s=Monitor.Device_BuildOverview_GetgetBuildFloorStates.Api
接口描述: 建筑信息总览-根据建筑id查询各楼层状态数据
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
buildingId | 字符串 | 必须 | - | 建筑id 示例1 | |
apiRequestRaw | 字符串 | 可选 | - | ||
headerInfo | 字符串 | 可选 | - | [] |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.code | 字符串 | |
data.msg | 字符串 | |
data.data | 数组 | |
data.data>>floor | 字符串 | 楼层号 -10000表示"全部楼层" |
data.data>>status | 字符串 | 楼层状态 0故障 1报警 4离线 |
data.data>>unableNum | 字符串 | 未启用的设备数量 |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
buildingId | 必须 | |
apiRequestRaw | 可选 | |
headerInfo | 可选 |
客户端请求示例
成功响应返回示例:
{
"code": 0,
"msg": null,
"data": [
{
"floor": -10000,
"status": null,
"unableNum": 1
},
{
"floor": -2,
"status": 2,
"unableNum": 0
},
{
"floor": -1,
"status": 2,
"unableNum": 0
},
{
"floor": 1,
"status": 1,
"unableNum": 0
},
{
"floor": 2,
"status": 4,
"unableNum": 0
},
{
"floor": 3,
"status": 0,
"unableNum": 0
},
{
"floor": 4,
"status": 2,
"unableNum": 0
},
{
"floor": 5,
"status": 2,
"unableNum": 0
},
{
"floor": 6,
"status": 2,
"unableNum": 0
},
{
"floor": 7,
"status": 2,
"unableNum": 0
},
{
"floor": 8,
"status": 2,
"unableNum": 0
},
{
"floor": 9,
"status": 2,
"unableNum": 0
},
{
"floor": 10,
"status": 2,
"unableNum": 1
},
{
"floor": 11,
"status": 2,
"unableNum": 0
},
{
"floor": 12,
"status": 2,
"unableNum": 0
},
{
"floor": 13,
"status": 2,
"unableNum": 0
},
{
"floor": 14,
"status": 2,
"unableNum": 0
},
{
"floor": 15,
"status": 2,
"unableNum": 0
},
{
"floor": 16,
"status": 2,
"unableNum": 0
},
{
"floor": 17,
"status": 2,
"unableNum": 0
},
{
"floor": 18,
"status": 2,
"unableNum": 0
}
]
}
失败响应返回示例:
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
409 | ret=409,接口流量不足 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-04-28 13:25:17