Метод: getUsers
Параметры запроса
Параметр | Тип | Описание |
---|
credentials (обязательный) | credentials | Смотрите описание объекта Credentials. |
groupId (необязательный) | string | Если этот параметр указан, будут выбраны пользователи, которые относятся к указанной группе. |
departmentId (необязательный) | string | Если этот параметр указан, будут выбраны пользователи указанного подразделения. |
Права пользователя для выполнения запроса
Возвращаемые значения
После того, как запрос успешно обработан, система возвращает объект со следующими свойствами:
Параметр | Тип | Описание |
---|
users | UserProfile[] | Массив с профилями пользователей. Объект UserProfile имеет такие же свойства, как метод getUserProfile. |
Возможные ошибки
Ошибка | Описание |
---|
Permission denied | У пользователя недостаточно прав для выполнения запроса. Например, администратор подразделения не может получить список пользователей другого подразделения. |
Пример запроса
Блок кода |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<GetUsersRequest>
<credentials>
<accountUrl>http://myaccount.ispringlearn.ru</accountUrl>
<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="http://schemas.xmlsoap.org/soap/envelope/"
xmlns="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<GetUsersResult>
<userProfile>
<userId>string</userId>
...
</userProfile>
<userProfile>
<userId>string</userId>
...
</userProfile>
</GetUsersResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> |