HTTP/HTTPS
请求协议
中科图灵开放平台 / 智慧消防设备管理模块 / 根据设备编码获取设备列表
根据设备编码获取设备列表
接口地址:https://api.iot.ink/api/app.php?s=Equipment.Device_Device_GetlistDeviceByCode.Api
接口描述: 根据设备编码获取设备列表
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
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
}
]
}
失败响应返回示例:
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
409 | ret=409,接口流量不足 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-05-14 12:26:04