Help Center/ Meeting/ Server API Reference/ Department Management/ APIs/ Querying Department Information by Department Code
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Department Information by Department Code

Description

This API is used to query department information by department code.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

GET

Request Address

/v1/usg/abs/departments/{dept_code}

Transport Protocol

HTTPS

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Location

Description

dept_code

Yes

String

Path

Department code.

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

Table 3 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

Table 4 QueryDeptResultDTO data structure

Parameter

Type

Description

deptCode

String

Department code.

deptName

String

Department name.

isLeafNodes

Boolean

Whether the department is a leaf node, that is, the department does not have sub-departments.

childDepts

Array of ChildDeptDTO objects

Sub-department details.
Table 5 ChildDeptDTO data structure

Parameter

Type

Description

deptCode

String

Department code.

deptName

String

Department name.

isLeafNodes

Boolean

Whether the department is a leaf node, that is, the department does not have sub-departments.

Example Request

GET /v1/usg/abs/departments/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

{
    "deptCode": "1",
        "deptName": "Root Department",
    "isLeafNodes": false,
    "childDepts": [
        {
            "deptCode": "rSD4S",
                "deptName": "Sub-department 1",
            "isLeafNodes": true
        },
        {
            "deptCode": "OFFNk",
                "deptName": "Sub-department 2",
            "isLeafNodes": false
        },
        {
            "deptCode": "ccYgH",
                "deptName": "Sub-department 3",
            "isLeafNodes": true
        }
    ]
}

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/abs/departments/1
Parent topic: APIs