Метод: changeUserStatus
Параметры запроса
Параметр | Тип | Описание |
---|---|---|
credentials (обязательный) | credentials | Смотрите описание объекта Credentials. |
userId (обязательный) | string | ID пользователя, профиль которого вы хотите изменить. |
status (обязательный) | string | 1 — чтобы активировать пользователя, 3 — чтобы заблокировать пользователя. |
deactivationDate (необязательный) | dateTime | Дата автоматической блокировки в формате yyyy-mm-dd, например, 2020-12-27. |
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения или роль с индивидуальными настройками.
Администратор подразделения или пользователь с ролью с индивидуальными настройками могут активировать и деактивировать пользователей подразделений, которыми управляют, и их дочерние подразделений.
Возвращаемые значения
После того, как запрос успешно обработан, система отправляет объект со следующими свойствами:
Параметр | Тип | Описание |
---|---|---|
success | bool | True, если пользователь активирован/деактивирован. |
Возможные ошибки
Текст | Описание |
---|---|
Unknown user | Пользователь не найден. |
Permission denied | Недостаточно прав для активации или деактивации пользователя. |
User status must be 1 or 3, <status> given | Недопустимый статус. |
Пример запроса
Блок кода | ||
---|---|---|
| ||
<?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> <ChangeUserStatusRequest> <credentials> <accountUrl>http://myaccount.ispringlearn.ru</accountUrl> <email>email@email.com</email> <password>password</password> </credentials> <userId>string</userId> <status>1</status> <deactivationDate>2020-12-27</deactivationDate> </changeUserStatusRequest> </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:ns1="http://ispringlearn.com/go/services/api/soap"> <SOAP-ENV:Body> <ns1:successResult> <ns1:success>true</ns1:success> </ns1:successResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |