中科图灵开放平台 / 智慧消防系统管理模块 / 部门管理-获取列表树

部门管理-获取列表树

接口描述: 部门管理-获取列表树

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

接口参数

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

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.code字符串
data.msg字符串
data.data数组
data.data>>id字符串部门id
data.data>>name字符串部门名称
data.data>>parentId字符串上级id
data.data>>level字符串级别 1、2、3
data.data>>deptId字符串所属单位id
data.data>>createBy字符串创建人
data.data>>remark字符串备注
data.data>>children数组子级列表
data.data>>children>>id字符串
data.data>>children>>name字符串
data.data>>children>>parentId字符串
data.data>>children>>level字符串
data.data>>children>>deptId字符串
data.data>>children>>createBy字符串
data.data>>children>>remark字符串
data.data>>children>>children数组
data.data>>children>>children>>id字符串
data.data>>children>>children>>name字符串
data.data>>children>>children>>parentId字符串
data.data>>children>>children>>level字符串
data.data>>children>>children>>deptId字符串
data.data>>children>>children>>createBy字符串
data.data>>children>>children>>remark字符串
data.data>>children>>children>>children数组
data.data>>children>>children>>children>>id字符串
data.data>>children>>children>>children>>name字符串
data.data>>children>>children>>children>>parentId字符串
data.data>>children>>children>>children>>level字符串
data.data>>children>>children>>children>>deptId字符串
data.data>>children>>children>>children>>createBy字符串
data.data>>children>>children>>children>>remark字符串
data.data>>children>>children>>children>>children字符串
msg字符串提示信息,失败时的错误提示

在线测试   

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

客户端请求示例

成功响应返回示例:
{
    "code": 0,
    "msg": null,
    "data": [
        {
            "id": 1,
            "name": "一级部门",
            "parentId": null,
            "level": 1,
            "deptId": 14,
            "createBy": 1,
            "remark": null,
            "children": [
                {
                    "id": 2,
                    "name": "二级部门1",
                    "parentId": 1,
                    "level": 2,
                    "deptId": 14,
                    "createBy": 1,
                    "remark": null,
                    "children": [
                        {
                            "id": 3,
                            "name": "三级部门1",
                            "parentId": 2,
                            "level": 3,
                            "deptId": 14,
                            "createBy": 1,
                            "remark": null,
                            "children": [
                                {
                                    "id": 4,
                                    "name": "四级部门1",
                                    "parentId": 3,
                                    "level": 4,
                                    "deptId": 14,
                                    "createBy": 1,
                                    "remark": null,
                                    "children": null
                                }
                            ]
                        }
                    ]
                },
                {
                    "id": 5,
                    "name": "二级部门2",
                    "parentId": 1,
                    "level": 2,
                    "deptId": 14,
                    "createBy": 1,
                    "remark": null,
                    "children": [
                        {
                            "id": 6,
                            "name": "三级部门2",
                            "parentId": 5,
                            "level": 3,
                            "deptId": 14,
                            "createBy": 1,
                            "remark": null,
                            "children": [
                                {
                                    "id": 7,
                                    "name": "四级部门2",
                                    "parentId": 6,
                                    "level": 4,
                                    "deptId": 14,
                                    "createBy": 1,
                                    "remark": null,
                                    "children": null
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}
失败响应返回示例:

错误列表

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

本文档生成时间:2024-04-23 22:20:33