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