Page tree
Skip to end of metadata
Go to start of metadata

Request: GET /department/{departmentId}

Permissions to Run the Request

Account Owner, Account Administrators, Department Administrators, Publishersor custom roles

Department Administrators, Publishers, and users with a custom role can get information only on the department they manage and its enclosed departments.

Request Headers


ParameterDescription
X-Auth-Account-Url (required)The base URL of the account, e.g. http://myaccount.ispringlearn.com
X-Auth-Email (required)The login of Account Owner,AdministratorDepartment Administrator, Publisher, or a user  with a custom role.
X-Auth-Password (required)The password of Account Owner,AdministratorDepartment Administrator, Publisher, or a user  with a custom role.


Possible Response Codes


CodeTextDescription
200Successful operation

The request was successfully processed. The response code contains xml info on the department.

400Bad RequestA request error.
401UnauthorizedAn authorization error.
403Permission Denied

The user doesn't have enough permissions to get information on the department.


Sample Request


GET /department/d479bc48-5b70-11e9-b123-22e9fbac4a59 HTTP/1.1
Host: api-learn.ispringlearn.com
X-Auth-Account-Url: https://myaccount.ispringlearn.com
X-Auth-Email: email@email.com
X-Auth-Password: password


Sample Response

HTTP/1.1 200 Successful operation
Connection: close

<?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>
  • No labels