Запрос: GET /departments
Права для выполнения запроса
Владелец аккаунта, Администратор, Администратор подразделения, Автор или роль с индивидуальными настройками.
Администратор подразделения, Автор или пользователь с ролью с индивидуальными настройками могут получать информацию только о подразделениях, которыми управляют, и вложенных в них подразделениях.
Заголовки и параметры запроса
Заголовок | Описание |
|---|---|
| X-Auth-Account-Url | Базовый URL аккаунта, например, https://myaccount.ispringlearn.ru. |
| X-Auth-Email | Логин Владельца аккаунта, Администратора, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками. |
| X-Auth-Password | Пароль Владельца аккаунта, Администратора, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками. |
| Параметр | Описание |
pageSize (необязательный) | Количество записей на 1 страницу. Если не указан, то 1000. |
pageToken (необязательный) | Токен для перехода на следующую страницу. |
Параметры ответа
Параметр | Описание | |
|---|---|---|
| department | Массив с данными о подразделении. | |
| departmentId | ID подразделения. | |
| name | Название подразделения. | |
| parentDepartmentId | Родительское подразделение. | |
| code | Код подразделения. | |
| subordination (необязательный) | Объект с данными о типе подчинения линейного руководителя подразделения. | |
| coSubordination (необязательный) | Объект с данными о типе подчинения функционального руководителя подразделения. | |
| subordinationType (обязательный) | Тип подчинения линейного и фукнционального руководителя. Возможные значения:
| |
| supervisorId (необязательный) | ID руководителя. | Указываете, если subordinationType = manual. |
| - | Если subordinationType = inherit, no_supervisor, указывать не нужно. | |
Коды ответов
Код | Текст | Description |
|---|---|---|
| 200 | OK | Запрос успешно обработан. Тело ответа будет содержать данные с информацией о подразделениях в xml. |
| 400 | Bad Request | Ошибка в запросе. |
| 401 | Unauthorized | Ошибка авторизации. |
| 403 | Permission Denied | У пользователя недостаточно прав для получения списка подразделений. |
Пример запроса
GET /departments?pageSize=1000&pageToken=ODE1YjhiOTgtMDYxMi0xMWVhLTliZDYtMGE1ODBhZjQwNzg4 Host: api-learn.ispringlearn.ru X-Auth-Account-Url: https://myaccount.ispringlearn.ru X-Auth-Email: email@email.com X-Auth-Password: password
Пример ответа
https/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<response>
<departments>
<department>
<departmentId>2a3e04a2-fa51-11e9-90a8-0a580af40a83</departmentId>
<name>Sample Company, LLC</name>
<code>0</code>
</department>
</departments>
<nextPageToken>MmEzZTA0YTItZmE1MS0xMWU5LTkwYTgtMGE1ODBhZjQwYTgz</nextPageToken>
</response>