Включить страницу |
---|
| Лэйблы с указанием тарифа |
---|
| Лэйблы с указанием тарифа |
---|
|
Метод: getUsers
Информация |
---|
При запросе getUser вы получите одинаковый статус для уволенных и заблокированных — 3. Чтобы различать статусы сотрудников, используйте запрос getUserV2. Так, в параметре status заблокированные сотрудники будут обозначаться статусом 3, уволенные — 5.
Если в вашем аккаунте LMS более 1000 пользователей, используйте запрос Получение постраничного списка пользователей. |
Параметры запроса
Параметр | Тип | Описание |
---|
credentials token (обязательный) | credentials | string | Токен доступа. Вы можете получить токен с помощью запросаСмотрите описание объекта Credentials. |
groupId (необязательный) | string | Если этот параметр указан, будут выбраны пользователи, которые относятся к указанной группе. |
departmentId (необязательный) | string | Если этот параметр указан, будут выбраны пользователи указанного подразделения. |
Права пользователя для выполнения запроса
...
После того, как запрос успешно обработан, система возвращает объект со следующими свойствами:
Параметр | Тип | Описание |
---|
users | UserProfile[] | Массив с профилями пользователей. Объект UserProfile имеет такие же свойства, как метод getUserProfile |
workLeaveStatus (необязательный) | string | Рабочий статус отсутствия. Массив с параметрами: - workLeaveReason — причины отсутствия,
- startDate — дата начала отсутствия. Указывается в формате yyyy-mm-dd,
- endDate — дата завершения отсутствия. Указывается в формате yyyy-mm-dd
|
Возможные ошибки
Ошибка | Описание |
---|
Permission denied | У пользователя недостаточно прав для выполнения запроса. Например, администратор Администратор подразделения не может получить список пользователей другого подразделения. |
Пример запроса
Блок кода |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="httphttps://schemas.xmlsoap.org/soap/envelope/"
xmlns="httphttps://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<GetUsersRequest>
<credentials>
<accountUrl>http://myaccount.ispringlearn.ru</accountUrl> <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
<email>email@email.com</email>
<password>password</password>
</credentials>
</GetUsersRequest>
<groupId>string</groupId>
<departmentId>string</departmentId>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> |
...
Блок кода |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="httphttps://schemas.xmlsoap.org/soap/envelope/"
xmlns="httphttps://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<GetUsersResult>
<userProfile>
<userId>43eb7146-6280-11e9-b274-a6210366ac32</userId>
<role>publisher</role>
<departmentId>e95b4ad0-5f50-11e9-80c4-0a580af406eb</departmentId>
<status>1</status>
<fields>
<field>
<name>LOGIN</name>
<value>elena@ispring.ru</value>
</field>
<field>
<name>EMAIL</name>
<value>elena@ispring.ru</value>
</field>
<field>
<name>FIRST_NAME</name>
<value>Елена</value>
</field>
<field>
<name>LAST_NAME</name>
<value>Смирнова</value>
</field>
<field>
<name>JOB_TITLE</name>
<value>Бухгалтер</value>
</field>
<field>
<name>COUNTRY</name>
<value>643</value>
</field>
</fields>
<groups>
<id>e0b394fc-44b9-11e9-92c8-0a580af401f6</id>
</groups>
<manageableDepartmentIds>
<id>3fa85f64-5717-4562-b3fc-2c963f66afa6</id>
</manageableDepartmentIds>
<userRoles>
<userRole>
<roleId>eaf01e14-2ae1-11e9-89a5-0242ac13000a</roleId>
<roleType>department_administrator</roleType>
<manageableDepartmentIds>
<id>f9de0c52-6f59-11ea-b88f-cee299842653</id>
<id>f9d9f306-6f59-11ea-ad9a-cee299842653</id>
</manageableDepartmentIds>
</userRole>
</userRoles>
<addedDate>2019-04-30</addedDate>
<lastLoginDate>2019-04-30</lastLoginDate>
</userProfile>
<userProfile>
<userId>43eb7146-6280-11e9-b274-a6210366ac33</userId>
<role>string</role>
<departmentId>e95b4ad0-5f50-11e9-80c4-0a580af406eb</departmentId>
<status>1</status>
<fields>
<field>
<name>LOGIN</name>
<value>denis@ispring.ru</value>
</field>
<field>
<name>EMAIL</name>
<value>denis@ispring.ru</value>
</field>
<field>
<name>FIRST_NAME</name>
<value>Денис</value>
</field>
<field>
<name>LAST_NAME</name>
<value>Петров</value>
</field>
<field>
<name>JOB_TITLE</name>
<value>Менеджер</value>
</field>
<field>
<name>COUNTRY</name>
<value>643</value>
</field>
</fields>
<groups>
<id>e0b394fc-44b9-11e9-92c8-0a580af401f6</id>
</groups>
<manageableDepartmentIds>
<id>3fa85f64-5717-4562-b3fc-2c963f66afa6</id>
</manageableDepartmentIds>
<userRoles>
<userRole>
<roleId>eaf01e14-2ae1-11e9-89a5-0242ac13000a<0242ac13111b</roleId>
<roleType>department_administrator<<roleType>publisher</roleType>
<manageableDepartmentIds>
<id>f9de0c52-6f59-11ea-b88f-cee299842653</id>
<id>f9d9f306-6f59-11ea-ad9a-cee299842653</id>
</manageableDepartmentIds>
</userRole>
</userRoles>
<addedDate>2019-04-29</addedDate>
<lastLoginDate>2019-04-30</lastLoginDate>
</userProfile>
</GetUsersResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> |
...