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