Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

You can get information about departments in the account by sending the GET request to the following URL: /department/{departmentId}.

Permission to run the request: Account Owner, Administrators, Department Administrators, Publishers

Department Administrators and Publishers can get information only on the department they manage and its daughter departments.


Request Headers

ParameterDescription
X-Auth-Account-Url (required)Base URL of the account, e.g. http://myaccount.ispringlearn.com
X-Auth-Email (required)Login of Account Owner,AdministratorDepartment Administrator, or Publisher.
X-Auth-Password (required)Password of Account Owner,AdministratorDepartment Administrator, or Publisher.

After the request has been completed, the system returns the response with the 200 code. The response code contains xml info on the department.


Possible Response Codes

CodeTextDescription
200Successful operation

The request was successfully processed.

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

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



Sample Request

Code Block
languagexml
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

Code Block
languagexml
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>