HTTP/HTTPS
请求协议
中科图灵开放平台 / 智慧消防监测概览模块 / 建筑信息总览-根据建筑id查询单位建筑信息
建筑信息总览-根据建筑id查询单位建筑信息
接口地址:https://api.iot.ink/api/app.php?s=Monitor.Device_BuildOverview_GetgetDeptBuildInfo.Api
接口描述: 建筑信息总览-根据建筑id查询单位建筑信息
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
buildingId | 字符串 | 必须 | - | 建筑id 示例1 | |
apiRequestRaw | 字符串 | 可选 | - | ||
headerInfo | 字符串 | 可选 | - | [] |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.code | 字符串 | |
data.msg | 字符串 | |
data.data | Array | |
data.data>>deptId | 字符串 | 单位id |
data.data>>deptName | 字符串 | 单位名称 |
data.data>>deptType | 字符串 | 单位类型 1运营单位 2一般单位 |
data.data>>deptTypeName | 字符串 | 单位类型名称 |
data.data>>buildingId | 字符串 | 建筑id |
data.data>>buildingName | 字符串 | 建筑名称 |
data.data>>buildingAddress | 字符串 | 建筑地址 |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
buildingId | 必须 | |
apiRequestRaw | 可选 | |
headerInfo | 可选 |
客户端请求示例
成功响应返回示例:
{
"code": 0,
"msg": null,
"data": {
"deptId": 14,
"deptName": "一般单位1",
"deptType": 2,
"deptTypeName": "一般单位",
"buildingId": 1,
"buildingName": "金sssB5栋",
"buildingAddress": "江夏区金融港B5栋"
}
}
失败响应返回示例:
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
409 | ret=409,接口流量不足 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-04-28 21:40:11