Чтобы назначить материалы пользователям, отправьте POST запрос на URL: /enrollment.
Роль пользователя для выполнения запроса: Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками, которые позволяют создавать назначения.
Запрос
| X-Auth-Account-Url (обязательный) | Базовый URL аккаунта, например, http://myaccount.ispringlearn.ru |
| X-Auth-Email (обязательный) | Логин Владельца аккаунта, Администратора аккаунта, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками, которые позволяют создавать назначения. |
| X-Auth-Password (обязательный) | Пароль Владельца аккаунта, Администратора аккаунта, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками, которые позволяют создавать назначения. |
| Параметры | Описание |
|---|---|
| courseIds (обязательный) | ID курсов, которые вы хотите назначить. |
learnerIds (обязательный) | ID учащихся, которым вы хотите назначить курсы. |
| accessDate (необязательный) | Дата начала обучения. Если дата начала обучения не указана, будет автоматически подставлена текущая дата. |
| dueDateType (обязательный) | Параметр показывает, есть ли у курса срок выполнения или же он неограничен по времени. Возможные значения параметра: unlimited, default, due_date, due_period. |
| dueDate (обязательный) | Параметр обязателен, если dueDateType = due_date. |
| duePeriod (обязательный) | Параметр обязателен, если dueDateType = due_period. Указывается в часах. |
Заголовки | Описание |
Если запрос выполнен и обработан корректно, отправляется код ответа 201. Тело ответа будет содержать ID добавленного назначения.
Коды ответов
| 201 | Successful operation | Новые назначения созданы. |
| 400 | Bad Request | Ошибка в запросе. |
| 401 | Unauthorized | Ошибка авторизации. |
| 403 | Permission Denied | У пользователя недостаточно прав для создания назначений. |
Код | Текст | Описание |
|---|
Пример запроса
| Блок кода | ||
|---|---|---|
| ||
POST /enrollment HTTP/1.1 Host: api-learn.ispringlearn.ru X-Auth-Account-Url: http://myaccount.ispringlearn.ru X-Auth-Email: email@email.com X-Auth-Password: 12345Q Content-Type:application/xml <?xml version="1.0" encoding="UTF-8"?> <request> <courseIds> <id>3fa85f64-5717-4562-b3fc-2c963f66afa6</id> </courseIds> <learnerIds> <id>3fa85f64-5717-4562-b3fc-2c963f66afa6</id> </learnerIds> <accessDate>2019-09-26</accessDate> <dueDateType>unlimited</dueDateType> <dueDate>2019-09-26</dueDate> <duePeriod>0</duePeriod> </request> |
Пример ответа
| Блок кода | ||
|---|---|---|
| ||
HTTP/1.1 201 Successful operation Connection: close |