Querying a Department and Its Level-1 Sub-departments
Description
This API is used by an enterprise administrator to query a department and its level-1 sub-departments.
Debugging
You can debug this API in API Explorer.
Prototype
Request Method |
GET |
---|---|
Request Address |
/v1/usg/dcs/member/dept/{dept_code} |
Transport Protocol |
HTTPS |
Request Parameters
Parameter |
Mandatory |
Type |
Location |
Description |
---|---|---|---|---|
deptCode |
Yes |
String |
Path |
Department code.
NOTE:
The code of the root department is 1. |
X-Access-Token |
Yes |
String |
Header |
Authorization token. Use the value of accessToken in the response to the request for Authenticating an App ID. |
X-Request-Id |
No |
String |
Header |
Request ID, which is used for fault tracing and locating. You are advised to use a UUID. If this parameter is not carried, a request ID is automatically generated. |
Accept-Language |
No |
String |
Header |
Language. Values: zh-CN for Chinese (default) and en-US for English. |
Status Codes
HTTP Status Code |
Description |
---|---|
200 |
Operation successful. |
400 |
Invalid parameters. |
401 |
Authentication is not performed or fails. |
403 |
Insufficient permissions. |
500 |
Server exception. |
Response Parameters
Parameter |
Type |
Description |
---|---|---|
childDepts |
Array of QueryDeptResultDTO objects |
Sub-department list. |
corpId |
String |
Enterprise ID. |
deptCode |
String |
Department code. |
deptCodePath |
String |
Department code path. |
deptLevel |
Integer |
Department level. |
deptName |
String |
Department name. |
deptNamePath |
String |
Department name path. |
designatedOutDeptCodes |
Array of IdMarkDTO objects |
List of departments that are allowed to access this department. |
inPermission |
String |
Permissions of users in other departments for accessing details of uses in this department. |
isLeafNode |
Boolean |
Whether the department is a leaf node. |
note |
String |
Remarks. |
outPermission |
String |
Permissions of users in this department for accessing details of uses in other departments. |
parentDeptCode |
String |
ID of the parent department. |
sortLevel |
Integer |
Department sequence number. |
Parameter |
Type |
Description |
---|---|---|
corpId |
String |
Enterprise ID. |
deptCode |
String |
Department code, which is unique in an enterprise. |
deptCodePath |
String |
Department code path. |
deptLevel |
Integer |
Department level. |
deptName |
String |
Department name. |
deptNamePath |
String |
Department name path. |
designatedOutDeptCodes |
Array of IdMarkDTO objects |
List of departments that are allowed to access this department. |
inPermission |
String |
Permissions of users in other departments for accessing details of uses in this department. |
isLeafNode |
Boolean |
Whether the department is a leaf node. |
note |
String |
Remarks. |
outPermission |
String |
Permissions of users in this department for accessing details of uses in other departments. |
parentDeptCode |
String |
ID of the parent department. |
sortLevel |
Integer |
Department sequence number. |
Example Request
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)
Example Response
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": [] } ] }
Error Codes
If an error code starting with MMC or USG is returned when you use this API, rectify the fault by following the instructions provided in Huawei Cloud API Error Center.
Example cURL Command
curl -k -i -X GET -H 'X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki' https://api.meeting.huaweicloud.com/v1/usg/dcs/member/dept/1
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot