AVAILABLE WITH BUSINESS SUBSCRIPTION
Request: GET /department/{departmentId}
Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators, Publishers, or custom roles.
Department Administrators, Publishers, and users with a custom role can get information only on the department they manage and its enclosed departments.
Parameter | Description |
---|
Authorization (required) | Access token. You can obtain a token by making a request.+ |
Response Parameters
Parameter | Description |
---|
departmentId | The department ID. |
name | The name of department. |
code | The department code. |
subordination (optional) | An array with data on the type of department supervisor subordination. |
coSubordination (optional) | An array with data on the type of functional manager subordination. |
subordinationType (required) | The type of supervisor and functional manager subordination. - inherit — Inherit from parent department.
- manual — Assign manually.
- no_supervisor — No supervisor.
|
supervisorId (optional) | The supervisor and functional manager ID. | Specify the supervisor ID, if subordinationType = manual. |
- | If subordinationType = inherit, no_supervisor, there is no need to specify the supervisor ID. |
Possible Response Codes
Code | Text | Description |
---|
200 | OK | The request was successfully processed. The response body contains xml info on the department. |
400 | Bad Request | A request error. |
401 | Unauthorized | An authorization error. |
403 | Permission Denied | The user doesn't have enough permissions to get information on the department. |
Sample Request
GET /department/d479bc48-5b70-11e9-b123-22e9fbac4a59 https/1.1
Host: api-learn.ispringlearn.com
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE
XML
Sample Response
https/1.1 200 OK
<?xml version="1.0"?>
<response>
<department>
<departmentId>d479bc48-5b70-11e9-b123-22e9fbac4a59</departmentId>
<name>Sales Department</name>
<parentDepartmentId>b00ba37c-5b6f-11e9-bb45-0a580af40556</parentDepartmentId>
<code>5</code>
</department>
</response>
XML