Вы можете удалить назначение с помощью метода 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="http://schemas.xmlsoap.org/soap/envelope/"
xmlns="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<UnenrollRequest>
<credentials>
<accountUrl>http://myaccount.ispringlearn.ru</accountUrl>
<email>email@email.com</email>
<password>password</password>
</credentials>
<enrollmentId>string</enrollmentId>
</UnenrollRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> |
...