平面图弹框 - Monitor.Device_BuildingPlan_GetgetBuildingPlanPopup.Api - 中科图灵开放平台

接口地址：https://api.iot.ink/api/app.php?s=Monitor.Device_BuildingPlan_GetgetBuildingPlanPopup.Api

接口描述：平面图弹框

HTTP/HTTPS

请求协议

GET

请求方式

UTF-8

编码格式

JSON

返回格式

v1.0

版本号

接口参数

参数名字	类型	是否必须	默认值	说明
access_token	字符串	可选		访问令牌，仅当开启签名验证时需要传递，生成令牌可使用App.Auth.ApplyToken接口
buildingId	整型	必须	-	楼层id 示例5
floor	整型	必须	-	楼层示例-1
deptId	整型	必须	-	部门id 示例14
apiRequestRaw	字符串	可选	-
headerInfo	字符串	可选	-	[]

返回字段

返回结果	类型	说明
ret	整型	状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务器错误
data	对象或混合类型	业务数据，由各自接口指定，通常为对象
data.code	字符串
data.msg	字符串
data.data	Array
data.data>>id	字符串	平面图id
data.data>>buildingId	字符串	设备id
data.data>>floor	字符串	楼层
data.data>>deptId	字符串	部门id
data.data>>image	字符串	图片信息--minio
data.data>>bucketName	字符串	桶名
data.data>>original	字符串	原文件名
data.data>>tenantId	字符串
data.data>>createTime	字符串
data.data>>updateTime	字符串
data.data>>delFlag	字符串
data.data>>status	字符串
data.data>>DeviceStatusNumRes	字符串
data.data>>DeviceStatusNumRes>>alarmNum	字符串	报警数量
data.data>>DeviceStatusNumRes>>faultNum	字符串	报警数量
data.data>>DeviceStatusNumRes>>normalNum	字符串	正常数量
data.data>>DeviceStatusNumRes>>offlineNum	字符串	离线数量
data.data>>listDeviceSign	字符串
data.data>>listDeviceSign>>id	字符串
data.data>>listDeviceSign>>system	字符串	所属系统
data.data>>listDeviceSign>>code	字符串	设备编码/编号
data.data>>listDeviceSign>>mainEngine	字符串	所属主机系统
data.data>>listDeviceSign>>address	字符串	地址
data.data>>listDeviceSign>>loopBack	字符串	回路
data.data>>listDeviceSign>>manufacturer	字符串	厂商
data.data>>listDeviceSign>>deviceType	字符串	设备类型
data.data>>listDeviceSign>>deviceModel	字符串	设备模型
data.data>>listDeviceSign>>buildId	字符串	建筑id
data.data>>listDeviceSign>>floor	字符串	楼层
data.data>>listDeviceSign>>addressDesc	字符串	位置描述
data.data>>listDeviceSign>>model	字符串	模型
data.data>>listDeviceSign>>deptId	字符串	部门id
data.data>>listDeviceSign>>tenantId	字符串	站点id
data.data>>listDeviceSign>>createTime	字符串	创建时间
data.data>>listDeviceSign>>delFlag	字符串	删除标识符
data.data>>listDeviceSign>>status	字符串	设备的状态，默认为未启用状态 0:未启用 1：正常 2：报警 3：故障 4：离线
data.data>>listDeviceSign>>mark	字符串	标识符
msg	字符串	提示信息，失败时的错误提示

在线测试

参数	是否必须	值
service	必须
access_token	可选
buildingId	必须
floor	必须
deptId	必须
apiRequestRaw	可选
headerInfo	可选

客户端请求示例

成功响应返回示例：
{
    "code": 0,
    "msg": null,
    "data": {
        "id": 12,
        "buildingId": 5,
        "floor": -1,
        "deptId": 14,
        "image": "60a94debcffb4f7d8fc567c0a2aa5011.png",
        "bucketName": "turing",
        "original": "icon_noie6218877.png",
        "tenantId": 1,
        "createTime": "2020-07-05 10:12:25",
        "updateTime": "2020-07-05 10:13:51",
        "delFlag": "0",
        "status": null,
        "listDeviceSign": [],
        "deviceStatusNumRes": {
            "alarmNum": 0,
            "faultNum": 0,
            "normalNum": 0,
            "offlineNum": 0
        }
    }
}
失败响应返回示例：

错误列表

错误状态码	错误描述信息
400	ret=400，客户端参数错误或非法请求
404	表示接口服务不存在
406	ret=406，access_token令牌校验不通过
407	ret=407，app_key权限不足，或未知应用
408	ret=408，当前用户禁止使用，或用户未登录
409	ret=409，接口流量不足
500	表示服务端内部错误

本文档生成时间：2024-04-20 11:28:29