中科图灵开放平台 / 智慧消防监测概览模块 / 根据消火栓id查询消火栓信息

根据消火栓id查询消火栓信息

接口描述: 根据消火栓id查询消火栓信息

HTTP/HTTPS
请求协议
GET
请求方式
UTF-8
编码格式
JSON
返回格式
v1.0
版本号

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
id整型必须-消火栓id 示例1
apiRequestRaw字符串可选-
headerInfo字符串可选-[]

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.code字符串
data.msg字符串
data.dataArray
data.data>>id字符串
data.data>>system字符串
data.data>>systemName字符串
data.data>>code字符串设备编号
data.data>>mainEngine字符串
data.data>>mainEngineName字符串
data.data>>address字符串
data.data>>loopBack字符串
data.data>>manufacturer字符串
data.data>>manufacturerName字符串
data.data>>deviceType字符串
data.data>>deviceTypeName字符串设备类型名
data.data>>deviceModel字符串
data.data>>deviceModelName字符串
data.data>>buildId字符串
data.data>>buildName字符串
data.data>>floor字符串
data.data>>addressDesc字符串设备位置
data.data>>model字符串
data.data>>deptId字符串
data.data>>deptName字符串
data.data>>tenantId字符串
data.data>>createTime字符串
data.data>>delFlag字符串
data.data>>status字符串
data.data>>mark字符串
data.data>>pushScopeId字符串
data.data>>unit字符串
data.data>>alarmValue字符串
data.data>>pointName字符串
data.data>>lastUploadTime字符串最新的更新时间
data.data>>pointDataResList数组
data.data>>pointDataResList>>id字符串
data.data>>pointDataResList>>messageLogId字符串
data.data>>pointDataResList>>pointCode字符串测点code
data.data>>pointDataResList>>pointName字符串测点名称
data.data>>pointDataResList>>deviceCode字符串设备编号
data.data>>pointDataResList>>uploadTime字符串上传时间
data.data>>pointDataResList>>alarmStatus字符串报警状态
data.data>>pointDataResList>>alarmType字符串报警类型
data.data>>pointDataResList>>alarmValue字符串报警值
data.data>>pointDataResList>>createTime字符串创建时间
data.data>>pointDataResList>>deviceName字符串设备名
data.data>>pointDataResList>>addressDesc字符串地址
data.data>>pointDataResList>>unit字符串单位
data.data>>messageLogId字符串
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
id 必须
apiRequestRaw 可选
headerInfo 可选

客户端请求示例

成功响应返回示例:
{
    "code": 0,
    "msg": null,
    "data": {
        "id": null,
        "system": null,
        "systemName": null,
        "code": "xx00001",
        "mainEngine": null,
        "mainEngineName": null,
        "address": null,
        "loopBack": null,
        "manufacturer": null,
        "manufacturerName": null,
        "deviceType": null,
        "deviceTypeName": "消火栓",
        "deviceModel": null,
        "deviceModelName": null,
        "buildId": null,
        "buildName": null,
        "floor": null,
        "addressDesc": "楼道",
        "model": null,
        "deptId": null,
        "deptName": null,
        "tenantId": null,
        "createTime": null,
        "delFlag": null,
        "status": null,
        "mark": null,
        "pushScopeId": null,
        "unit": null,
        "alarmValue": null,
        "pointName": null,
        "lastUploadTime": "2020-06-23 16:25:16",
        "pointDataResList": [
            {
                "id": null,
                "messageLogId": null,
                "pointCode": "XWPS",
                "pointName": "水压",
                "deviceCode": "xx00001",
                "uploadTime": null,
                "alarmStatus": null,
                "alarmType": null,
                "alarmValue": "0",
                "createTime": null,
                "deviceName": null,
                "addressDesc": "楼道",
                "unit": "Mpa"
            }
        ],
        "messageLogId": null
    }
}
失败响应返回示例:

错误列表

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

本文档生成时间:2024-03-28 17:55:04