Дерево страниц

Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

Метод: getUsers

Информация

При запросе getUser вы получите одинаковый статус для уволенных и заблокированных — 3. Чтобы различать статусы сотрудников, используйте запрос getUserV2. Так, в параметре status заблокированные сотрудники будут обозначаться статусом 3, уволенные — 5.

Если в вашем аккаунте СДО LMS более 1000 пользователей, используйте запрос Получение постраничного списка пользователей.

Параметры запроса

ПараметрТипОписание
credentials token (обязательный)credentialsstringТокен доступа. Вы можете получить токен с помощью запросаСмотрите описание объекта Credentials.
groupId (необязательный)stringЕсли этот параметр указан, будут выбраны пользователи, которые относятся к указанной группе.
departmentId (необязательный)stringЕсли этот параметр указан, будут выбраны пользователи указанного подразделения.

Права пользователя для выполнения запроса

...

После того, как запрос успешно обработан, система возвращает объект со следующими свойствами:

ПараметрТипОписание
usersUserProfile[]Массив с профилями пользователей. Объект UserProfile имеет такие же свойства, как метод getUserProfile
workLeaveStatus (необязательный)string

Рабочий статус отсутствия. Массив с параметрами:

  • workLeaveReason — причины отсутствия,
  • startDate — дата начала отсутствия. Указывается в формате yyyy-mm-dd,
  • endDate — дата завершения отсутствия. Указывается в формате yyyy-mm-dd

Возможные ошибки

ОшибкаОписание
Permission denied

У пользователя недостаточно прав для выполнения запроса.

Например, Администратор подразделения не может получить список пользователей другого подразделения.

Пример запроса

Блок кода
languagexml
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="https://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <GetUsersRequest>
      <credentials>
           <accountUrl>https://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>

...