Метод: unenroll
Параметры запроса
Параметр | Тип | Описание |
---|---|---|
credentials (обязательный) | credentials | Смотрите описание объекта Credentials. |
enrollmentId (обязательный) | string | ID назначения, которое нужно удалить. |
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения или роль с индивидуальными настройками, которые позволяют удалять назначения.
Администратор подразделения, Автор или пользователь с ролью с индивидуальными настройками могут удалять назначения пользователей из подразделений, которыми управляют, и их дочерних подразделений.
Возвращаемые значения
После того, как запрос успешно обработан, система отправляет объект со следующими свойствами:
Параметр | Тип | Описание |
---|---|---|
success | bool | True, если назначение было удалено. |
Возможные ошибки
Ошибка | Описание |
---|---|
Permission denied | У пользователя недостаточно прав для удаления назначения. |
Wrong parameters | Назначение с указанным ID не найдено. |
Пример запроса
<?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> <UnenrollRequest> <credentials> <accountUrl>https://myaccount.ispringlearn.ru</accountUrl> <email>email@email.com</email> <password>password</password> </credentials> <enrollmentId>string</enrollmentId> </UnenrollRequest> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Пример ответа
<?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> <successResult> <success>true</success> </successResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope>