Метод: listDepartments
Параметры запроса
| Параметр | Тип | Описание |
|---|---|---|
| token (обязательный) | string | Токен доступа. Вы можете получить токен с помощью запроса |
| pageSize (необязательный) | string | Количество записей на 1 страницу. Если не указан, то 1000 |
| pageToken (необязательный) | string | Токен для перехода на следующую страницу |
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
Администратор подразделения, Автор или пользователь с ролью с индивидуальными настройками могут получать постраничные списки только тех подразделений, которыми управляют, и их дочерних подразделений.
Возвращаемые значения
После того, как запрос успешно обработан, система отправляет объект со следующими свойствами:
| Параметр | Тип | Описание | |
|---|---|---|---|
| department | array | Массив, содержащий значения ’departmentId’, ’name’, ’code’, ’parentDepartmentId’ — ID подразделения, его название, код и родительское подразделение | |
| nextPageToken | string | Токен для перехода на следующую страницу | |
| department_id (обязательный) | string | ID подразделения, о котором вы хотите получить информацию | |
| name | string | Название подразделения | |
| code | string | Код подразделения | |
| parentDepartmentId | string | ID головного подразделения | |
| subordination (необязательный) | array | Объект с данными о типе подчинения линейного руководителя подразделения | |
| coSubordination (необязательный) | array | Объект с данными о типе подчинения функционального руководителя подразделения | |
| subordinationType (обязательный) | string | Тип подчинения линейного и фукнционального руководителя. Возможные значения:
| |
| supervisorId (необязательный) | string | ID руководителя | Указываете, если subordinationType = manual |
| - | Если subordinationType = inherit, no_supervisor, указывать не нужно | ||
Пример запроса
<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="https://ispringlearn.com/go/services/api/soap">
<soapenv:Header/>
<soapenv:Body>
<soap:ListDepartmentsRequest>
<soap:credentials>
<soap:accountUrl>https://myaccount.ispringlearn.ru</soap:accountUrl>
<soap:email>email@email.com</soap:email>
<soap:password>password</soap:password>
</soap:credentials>
<soap:pageToken>string</soap:pageToken>
<soap:pageSize>1000</soap:pageSize>
</soap:ListDepartmentsRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<ns1:ListDepartmentsResult>
<ns1:departments>
<ns1:department>
<ns1:departmentId>string</ns1:departmentId>
<ns1:name>string</ns1:name>
<ns1:code>string</ns1:code>
</ns1:department>
<ns1:department>
...
</ns1:department>
</ns1:departments>
<ns1:nextPageToken>string</ns1:nextPageToken>
</ns1:ListDepartmentsResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>