中科图灵开放平台 / 智慧消防系统管理模块 / dept-获取用户的数据权限(deptTree)

dept-获取用户的数据权限(deptTree)

接口描述: dept-获取用户的数据权限(deptTree)

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

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
companyCategoryId整型必须-单位类别id 示例19
superviseTypeCode字符串必须-监管类别code 示例supervise_type_01
name字符串必须-单位名称 示例单位
searchType字符串必须-查询类别:默认是区域树查询,1 区域树查询,2 单位树查询 (单位树查询不会返回父节点数据) 示例1
apiRequestRaw字符串可选-
headerInfo字符串可选-[]

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.code字符串
data.msg字符串
data.data数组
data.data>>id字符串单位id
data.data>>parentId字符串上级id
data.data>>children数组子级列表
data.data>>name字符串单位名称
data.data>>type字符串单位类型 1运营单位 2一般单位 3维保单位
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
companyCategoryId 必须
superviseTypeCode 必须
name 必须
searchType 必须
apiRequestRaw 可选
headerInfo 可选

客户端请求示例

成功响应返回示例:
{
    "code": 0,
    "msg": null,
    "data": [
        {
            "id": 1,
            "parentId": 0,
            "children": [],
            "name": "默认单位",
            "type": null
        },
        {
            "id": 2,
            "parentId": 0,
            "children": [],
            "name": "默认单位",
            "type": 1
        },
        {
            "id": 0,
            "parentId": 0,
            "children": [
                {
                    "id": 0,
                    "parentId": 0,
                    "children": [
                        {
                            "id": 6,
                            "parentId": 0,
                            "children": [],
                            "name": "运营单位1",
                            "type": 1
                        },
                        {
                            "id": 14,
                            "parentId": 6,
                            "children": [],
                            "name": "一般单位1",
                            "type": 2
                        },
                        {
                            "id": 15,
                            "parentId": 6,
                            "children": [],
                            "name": "一般单位2",
                            "type": 2
                        },
                        {
                            "id": 16,
                            "parentId": 6,
                            "children": [],
                            "name": "天空之城",
                            "type": 2
                        }
                    ],
                    "name": "武汉市",
                    "type": null
                }
            ],
            "name": "湖北省",
            "type": null
        }
    ]
}
失败响应返回示例:

错误列表

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

本文档生成时间:2024-07-13 21:56:56