Метод: updateCourseStatus
Параметры
Параметр | Тип | Описание |
---|
credentials (обязательный) | credentials | Смотрите описание объекта Credentials. |
courseId (обязательный) | string | ID курса, статус которого вы хотите изменить. |
enrollmentIds (обязательный) | string | Назначение или несколько назначений курса, статусы которых вы хотите изменить. |
date (обязательный, если статус курса меняется на Завершён) | string | Дата завершения курса. |
reason (необязательный) | string | Причина, по которой вы хотите изменить статус курса. |
status (обязательный) | string | Статус, который вы хотите присвоить курсу.
Возможные значения:
complete — статус изменится на Завершён automatic — статус автоматически пересчитается в зависимости от того, сколько материалов курса прошел пользователь |
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
Администратор подразделения, Автор или пользователь с ролью с индивидуальными настройками могут изменять статус курсов, назначенных на пользователей подразделений, которыми управляют, и вложенных в них подразделений.
Возвращаемые значения
Заголовок | Тип | Описание |
---|
taskId | string | ID запроса на изменение статуса курса. |
Возможные ошибки
Ошибка | Описание |
---|
Unknown content item | Не найден курс или назначение с указанным ID. |
Permission denied | У пользователя недостаточно прав для выполнения запроса |
Пример запроса
Блок кода |
---|
|
<?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>
<updateCourseStatusRequest>
<credentials>
<accountUrl>http://myaccount.ispringlearn.ru</accountUrl>
<email>email@email.com</email>
<password>password</password>
</credentials>
<enrollmentIds>
<id>e1f2c50e-c1ae-11ea-8592-a6eabe1809b2</id>
</enrollmentIds>
<courseId>14b847e8-c10f-11ea-b4e1-ae33e75597e9</courseId>
<date>2020-07-22</date>
<reason>Прошел очно</reason>
<status>complete</status>
</updateCourseStatusRequest>
</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:ns1="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<ns1:updateCourseStatusResult>
<ns1:taskId>100027</ns1:taskId>
</ns1:updateCourseStatusResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> |