文档首页/ 华为云会议 Meeting/ 服务端API参考/ 企业部门管理/ 接口参考/ 查询部门及其一级子部门列表
更新时间：2023-12-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询部门及其一级子部门列表

描述

企业管理员通过该接口查询部门及其一级子部门列表。

调试

您可以在API Explorer中调试该接口。

接口原型

表1 接口原型

请求方法

GET

请求地址

/v1/usg/dcs/member/dept/{dept_code}

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

deptCode

是

String

Path

部门编码。

说明：

根部门的部门编码是1。

X-Access-Token

是

String

Header

授权令牌。获取“执行App ID鉴权”响应的accessToken。

X-Request-Id

否

String

Header

请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。

Accept-Language

否

String

Header

语言参数，默认为中文zh-CN，英文为en-US。

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常

响应参数

表4 响应参数

参数

类型

描述

childDepts

Array of QueryDeptResultDTO objects

子部门列表。

corpId

String

企业ID。

deptCode

String

部门编码。

deptCodePath

String

部门编码路径。

deptLevel

Integer

部门层级。

deptName

String

部门名称。

deptNamePath

String

部门名路径。

designatedOutDeptCodes

Array of IdMarkDTO objects

允许访问的部门列表。

inPermission

String

其他用户对该部门下用户的访问权限。

isLeafNode

Boolean

是否叶子节点。

note

String

备注。

outPermission

String

该部门下用户访问权限控制。

parentDeptCode

String

父部门编码。

sortLevel

Integer

部门排序号。
表5 QueryDeptResultDTO 数据结构

参数

类型

描述

corpId

String

企业ID。

deptCode

String

部门编码，企业内唯一。

deptCodePath

String

部门编码路径。

deptLevel

Integer

部门层级。

deptName

String

部门名称。

deptNamePath

String

部门名路径。

designatedOutDeptCodes

Array of IdMarkDTO objects

允许访问的部门列表。

inPermission

String

其他用户对该部门下用户的访问权限。

isLeafNode

Boolean

是否叶子节点。

note

String

备注。

outPermission

String

该部门下用户访问权限控制。

parentDeptCode

String

父部门编码。

sortLevel

Integer

部门排序号。
表6 IdMarkDTO 数据结构

参数

类型

描述

id

String

部门编码。

mark

String

id对应的回显描述，一般为名称等。

请求消息示例

GET /v1/usg/dcs/member/dept/1
Connection: keep-alive
X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki
Host: api.meeting.huaweicloud.com 
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

响应消息示例

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: 539e8b710378987ffc5eb844b5e5c290

{
    "corpId": "15659",
    "deptCode": "1",
    "deptLevel": 1,
    "deptName": "wangyue",
    "deptNamePath": "wangyue",
    "isLeafNode": false,
    "parentDeptCode": null,
    "deptCodePath": "1",
    "note": null,
    "inPermission": "UNLIMITED",
    "outPermission": "UNLIMITED",
    "designatedOutDeptCodes": [],
    "sortLevel": 1000,
    "childDepts": [
        {
            "deptCode": "U5b",
            "deptLevel": 2,
            "deptName": "openTest001",
            "deptNamePath": "wangyue#openTest001",
            "isLeafNode": true,
            "parentDeptCode": "1",
            "deptCodePath": "1#U5b",
            "note": null,
            "corpId": "15659",
            "inPermission": "UNLIMITED",
            "outPermission": "UNLIMITED",
            "sortLevel": 10000,
            "designatedOutDeptCodes": []
        }
    ]
}

错误码

当您使用华为云会议服务端API时，如果遇到“MMC”或者“USG”开头的错误码，请参考华为云API错误中心。

CURL命令示例

curl -k -i -X GET -H 'X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki' https://api.meeting.huaweicloud.com/v1/usg/dcs/member/dept/1
父主题： 接口参考