中科图灵开放平台 / 智慧消防设备管理模块 / 根据设备编码获取设备列表

根据设备编码获取设备列表

接口描述: 根据设备编码获取设备列表

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

接口参数

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

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.code字符串
data.msg字符串
data.data数组
data.data>>id字符串设备id
data.data>>system字符串
data.data>>code字符串设备编码
data.data>>mainEngine字符串
data.data>>address字符串
data.data>>loopBack字符串
data.data>>manufacturer字符串
data.data>>deviceType字符串
data.data>>deviceModel字符串
data.data>>buildId字符串
data.data>>floor字符串
data.data>>addressDesc字符串
data.data>>model字符串
data.data>>deptId字符串
data.data>>tenantId字符串
data.data>>createTime字符串
data.data>>delFlag字符串
data.data>>status字符串
data.data>>statusName字符串
data.data>>mark字符串
data.data>>chargingPileId字符串
data.data>>channel字符串
data.data>>partTypeExplain字符串
data.data>>partType字符串
data.data>>fireMainCode字符串
data.data>>userCode字符串
data.data>>updateTime字符串
data.data>>communicationCardNum字符串
data.data>>deviceTypeName字符串
data.data>>isHandle字符串
data.data>>deviceNum字符串
data.data>>uid字符串
data.data>>category字符串
data.data>>productId字符串
data.data>>remark字符串
data.data>>ipAddr字符串
data.data>>mac字符串
data.data>>icon字符串
data.data>>sysName字符串
data.data>>inoutFlag字符串
msg字符串提示信息,失败时的错误提示

在线测试   

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

客户端请求示例

成功响应返回示例:
{
    "code": 0,
    "msg": null,
    "data": [
        {
            "id": 62192,
            "system": "fc_system_fhm",
            "code": "004b88042110001a",
            "mainEngine": null,
            "address": null,
            "loopBack": null,
            "manufacturer": 10,
            "deviceType": 233,
            "deviceModel": 268,
            "buildId": null,
            "floor": null,
            "addressDesc": "11",
            "model": null,
            "deptId": 463,
            "tenantId": 98,
            "createTime": "2022-07-27 11:16:57",
            "delFlag": "0",
            "status": -1,
            "statusName": null,
            "mark": "",
            "chargingPileId": null,
            "channel": null,
            "partTypeExplain": null,
            "partType": null,
            "fireMainCode": null,
            "userCode": null,
            "updateTime": "2022-08-01 14:58:51",
            "communicationCardNum": null,
            "deviceTypeName": null,
            "isHandle": null,
            "deviceNum": null,
            "uid": null,
            "category": null,
            "productId": null,
            "remark": null,
            "ipAddr": null,
            "mac": null,
            "icon": null,
            "sysName": null,
            "inoutFlag": null
        }
    ]
}
失败响应返回示例:

错误列表

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

本文档生成时间:2024-05-14 12:26:04