Вы можете отредактировать назначение с помощью метода ChangeEnrollment.
Права пользователя для выполнения запроса: Владелец аккаунта, Администратор, Администратор аккаунта и Автор.
Параметры запроса
Параметр | Тип | Описание |
---|---|---|
credentials (обязательный) | credentials | Смотрите описание объекта Credentials. |
enrollmentId (обязательный) | string | ID назначения, которое вы хотите изменить. |
accessDate | date | Дата начала обучения. |
dueDateType | string | Параметр показывает, есть ли у курса срок выполнения или же он неограничен по времени. |
dueDate | date | Параметр обязателен, если курс должен быть выполнен к определенной дате. |
duePeriod | int | Параметр обязателен, если курс надо пройти в течение определенного времени с момента начала обучения. Указывается в часах. |
lockAfterDueDate | bool | Параметр обязателен, если курс должен быть выполнен к определенной дате. Указывает, сохранится ли доступ к курсу, когда дата выполнения пройдет. |
Возвращаемые значения
После того, как запрос был успешно обработан, система отправляет объект со следующими свойствами:
Параметр | Тип | Описание |
---|---|---|
success | bool | True, если назначение было успешно отредактировано. |
Возможные ошибки
Тип | Описание |
---|---|
Unknown Enrollment | Назначение не найдено. |
Permission denied | У пользователя недостаточно прав для редактирования назначения. |
Wrong Parameters | Один из указанных параметров задан неверно. |
Пример запроса
POST /api/v2/soap/2.0 HTTP/1.1 SOAPAction: "ChangeEnrollment" <?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> <ChangeEnrollmentRequest> <credentials> <accountUrl>http://myaccount.ispringlearn.ru</accountUrl> <email>email@mail.ru</email> <password>password</password> </credentials> <enrollmentId>2bbc2ed0-8841-11e9-93c1-0242c0a85016</enrollmentId> <accessDate>date</accessDate> <dueDateType>string</dueDateType> <duePeriod>int</duePeriod> <lockAfterDueDate>true</lockAfterDueDate> </ChangeEnrollmentRequest> </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://new.webservice.namespace"> <SOAP-ENV:Body> <ChangeEnrollmentResult> <success>true</success> </ChangeEnrollmentResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope>