HTTP/HTTPS
请求协议
中科图灵开放平台 / 智慧消防设备管理模块 / 根据消火栓id查询消火栓详情
根据消火栓id查询消火栓详情
接口地址:https://api.iot.ink/api/app.php?s=Equipment.Device_FireHydrant_GetfindById.Api
接口描述: 根据消火栓id查询消火栓详情
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
id | 整型 | 必须 | - | 消火栓id 示例1 | |
apiRequestRaw | 字符串 | 可选 | - | ||
headerInfo | 字符串 | 可选 | - | [] |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.code | 字符串 | |
data.msg | 字符串 | |
data.data | Array | |
data.data>>id | 整型 | 消火栓id |
data.data>>name | 字符串 | 消火栓名称 |
data.data>>provinceCode | 字符串 | 所在省份code |
data.data>>cityCode | 字符串 | 所在城市code |
data.data>>areaCode | 字符串 | 所在区域code |
data.data>>provinceName | 字符串 | 所在城市 |
data.data>>cityName | 字符串 | 所在城市 |
data.data>>areaName | 字符串 | 所在区域 |
data.data>>radius | 整型 | 保护半径(单位:m) |
data.data>>sign | 字符串 | 是否标记--经纬度 (是=1,否=0) |
data.data>>longitude | Array | 经度(10,6) |
data.data>>latitude | Array | 纬度(10,6) |
data.data>>type | 字符串 | 消火栓类型(1=地下式,2=地上式,3=直埋伸缩) |
data.data>>outletType | 字符串 | 出水口(1=单口式,2=双口式,3=三出水口式) |
data.data>>firstOutletType | 字符串 | 第一出水口类型(1=外螺旋式,2=内扣式) |
data.data>>firstOutletRadius | 整型 | 第一出水口半径(单位:mm) |
data.data>>secondOutletType | 字符串 | 第二出水口类型(1=外螺旋式,2=内扣式) |
data.data>>secondOutletRadius | 整型 | 第二出水口半径(单位:mm) |
data.data>>thirdOutletType | 字符串 | 第三出水口类型(1=外螺旋式,2=内扣式) |
data.data>>thirdOutletRadius | 整型 | 第三出水口半径(单位:mm) |
data.data>>pipelineType | 字符串 | 水管道(1=高压给水,2=临时高压给水,3=低压给水) |
data.data>>address | 字符串 | 详细地址 |
data.data>>deviceId | 整型 | 绑定设备id |
data.data>>tenantId | 整型 | 所属站点id |
data.data>>createTime | Array | 创建时间 |
data.data>>updateTime | Array | 修改时间 |
data.data>>delFlag | 字符串 | 是否删除 0:正常 1已删除 |
data.data>>deptId | 整型 | 单位id -- 备用字段 |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
id | 必须 | |
apiRequestRaw | 可选 | |
headerInfo | 可选 |
客户端请求示例
成功响应返回示例:
{
"code": 0,
"msg": null,
"data": {
"id": 1,
"name": "消火栓01",
"provinceCode": "420000",
"cityCode": "420100",
"areaCode": "420115",
"provinceName": "湖北省",
"cityName": "武汉市",
"areaName": "江夏区",
"radius": 100,
"sign": "0",
"longitude": null,
"latitude": null,
"type": "1",
"outletType": "1",
"firstOutletType": "1",
"firstOutletRadius": 20,
"secondOutletType": null,
"secondOutletRadius": null,
"thirdOutletType": null,
"thirdOutletRadius": null,
"pipelineType": "1",
"address": "金融港B5",
"deviceId": null,
"tenantId": 1,
"createTime": "2020-06-12 16:41:27",
"updateTime": null,
"delFlag": "0",
"deptId": null
}
}
失败响应返回示例:
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
409 | ret=409,接口流量不足 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-04-19 10:11:04