中科图灵开放平台 / 智慧消防设备管理模块 / 建筑树

建筑树

接口描述: 建筑树

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

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
apiRequestRaw字符串必须-{ "buildingName":"", "deptId":null, "tenantId":null, "searchType":"" }
headerInfo字符串可选-[]

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.code字符串
data.msg字符串
data.data数组
data.data>>id字符串
data.data>>parentId字符串
data.data>>children数组
data.data>>children>>id字符串
data.data>>children>>parentId字符串
data.data>>children>>children数组
data.data>>children>>children>>id字符串
data.data>>children>>children>>parentId字符串
data.data>>children>>children>>children数组
data.data>>children>>children>>children>>id字符串
data.data>>children>>children>>children>>parentId字符串
data.data>>children>>children>>children>>children数组
data.data>>children>>children>>children>>children>>id字符串
data.data>>children>>children>>children>>children>>parentId字符串
data.data>>children>>children>>children>>children>>children数组
data.data>>children>>children>>children>>children>>children>>id字符串
data.data>>children>>children>>children>>children>>children>>parentId字符串
data.data>>children>>children>>children>>children>>children>>children数组
data.data>>children>>children>>children>>children>>children>>buildingName字符串
data.data>>children>>children>>children>>children>>buildingName字符串
data.data>>children>>children>>children>>buildingName字符串
data.data>>children>>children>>buildingName字符串
data.data>>children>>buildingName字符串
data.data>>buildingName字符串
msg字符串提示信息,失败时的错误提示

在线测试   

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

客户端请求示例

成功响应返回示例:
{
    "code": 0,
    "msg": null,
    "data": [
        {
            "id": 0,
            "parentId": 0,
            "children": [
                {
                    "id": 420000,
                    "parentId": 0,
                    "children": [
                        {
                            "id": 420100,
                            "parentId": 420000,
                            "children": [
                                {
                                    "id": 420111,
                                    "parentId": 420100,
                                    "children": [
                                        {
                                            "id": 10213,
                                            "parentId": 420111,
                                            "children": [
                                                {
                                                    "id": 8,
                                                    "parentId": 10213,
                                                    "children": [],
                                                    "buildingName": "关南小区"
                                                }
                                            ],
                                            "buildingName": "佛祖岭街道"
                                        },
                                        {
                                            "id": 10213,
                                            "parentId": 420111,
                                            "children": [
                                                {
                                                    "id": 7,
                                                    "parentId": 10213,
                                                    "children": [],
                                                    "buildingName": "光谷天地"
                                                },
                                                {
                                                    "id": 9,
                                                    "parentId": 10213,
                                                    "children": [],
                                                    "buildingName": "光谷天地23"
                                                },
                                                {
                                                    "id": 10,
                                                    "parentId": 10213,
                                                    "children": [],
                                                    "buildingName": "关南小区23r"
                                                }
                                            ],
                                            "buildingName": "关山街道"
                                        }
                                    ],
                                    "buildingName": "洪山区"
                                },
                                {
                                    "id": 420115,
                                    "parentId": 420100,
                                    "children": [
                                        {
                                            "id": 42011110213,
                                            "parentId": 420115,
                                            "children": [
                                                {
                                                    "id": 2,
                                                    "parentId": 42011110213,
                                                    "children": [],
                                                    "buildingName": "金融港B6栋"
                                                }
                                            ],
                                            "buildingName": "关山街道"
                                        }
                                    ],
                                    "buildingName": "江夏区"
                                }
                            ],
                            "buildingName": "武汉市"
                        }
                    ],
                    "buildingName": "湖北省"
                },
                {
                    "id": 410000,
                    "parentId": 0,
                    "children": [
                        {
                            "id": 410900,
                            "parentId": 410000,
                            "children": [
                                {
                                    "id": 410923,
                                    "parentId": 410900,
                                    "children": [
                                        {
                                            "id": 4109231256,
                                            "parentId": 410923,
                                            "children": [
                                                {
                                                    "id": 6,
                                                    "parentId": 4109231256,
                                                    "children": [],
                                                    "buildingName": "佛祖岭C区"
                                                }
                                            ],
                                            "buildingName": "近德固乡"
                                        }
                                    ],
                                    "buildingName": "南乐县"
                                }
                            ],
                            "buildingName": "濮阳市"
                        }
                    ],
                    "buildingName": "河南省"
                }
            ],
            "buildingName": "全部"
        }
    ]
}
失败响应返回示例:

错误列表

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

本文档生成时间:2024-04-19 23:17:42