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