Получение постраничного списка пользователей

Метод: ListUsers

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

Параметр	Тип	Описание
credentials (обязательный)	credentials	Смотрите описание объекта Credentials.
groupId (необязательный)	string	Если этот параметр указан, будут выбраны пользователи, которые относятся к указанной группе.
departmentId (необязательный)	string	Если этот параметр указан, будут выбраны пользователи указанного подразделения.
pageSize (необязательный)	string	Количество записей на 1 страницу. Если не указан, то 1000.
pageToken (необязательный)	string	Токен для перехода на следующую страницу.

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

Владелец аккаунта, Администратор, Администратор подразделения.

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

Возвращаемые значения

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

Параметр	Тип	Описание
users	UserProfile[]	Массив с профилями пользователей. Объект UserProfile имеет такие же свойства, как метод getUserProfile.
nextPageToken	string	Токен для перехода на следующую страницу.

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

Ошибка

Описание

Permission denied

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

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

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

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://ispringlearn.com/go/services/api/soap">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:ListUsersRequest>
         <soap:credentials>
            <soap:accountUrl>http://myaccount.ispringlearn.ru</soap:accountUrl>
            <soap:email>email@email.com</soap:email>
            <soap:password>password</soap:password>
         </soap:credentials>
           <soap:groupIds>
                <soap:id>string</soap:id>
          </soap:groupIds>
         <soap:departmentIds>
            <soap:id>string</soap:id>
         </soap:departmentIds>
         <soap:pageToken>string</soap:pageToken>
         <soap:pageSize>1000</soap:pageSize>
      </soap:ListUsersRequest>
   </soapenv:Body>
</soapenv:Envelope>

Пример ответа

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://ispringlearn.com/go/services/api/soap">
   <SOAP-ENV:Body>
      <ns1:ListUsersResult>
         <ns1:userProfiles>
            <ns1:userProfile>
               <ns1:userId>string</ns1:userId>
               ...
            </ns1:userProfile>
            <ns1:userProfile>
               <ns1:userId>string</ns1:userId>
               ...
            </ns1:userProfile>
            <ns1:userProfile>
               <ns1:userId>string</ns1:userId>
               ...
            </ns1:userProfile>
         </ns1:userProfiles>
         <ns1:nextPageToken>string</ns1:nextPageToken>
      </ns1:ListUsersResult>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

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