Вы можете получить список пользователей с помощью метода getUsers.
Права пользователя для выполнения запроса: владелец аккаунта, администратор, администратор организации.
Параметры
Параметр | Тип | Описание |
---|---|---|
credentials (обязательный) | credentials | Смотрите описание объекта Credentials. |
groupId (необязательный) | string | Если этот параметр указан, будут выбраны пользователи, которые относятся к указанной группе. |
organizationId (необязательный) | int | Если этот параметр указан, будут выбраны пользователи указанной организации. |
Возвращаемые значения
После того, как запрос успешно обработан, система возвращает объект со следующими свойствами:
Параметр | Тип | Описание |
---|---|---|
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.ispringonline.ru</accountUrl> <email>email@email.com</email> <password>password</password> </credentials> </GetUsersRequest> <groupId>1</groupId> <organizationId>2</organizationId> </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>