Включить страницу | ||||
---|---|---|---|---|
|
Запрос: POST /enrollment
Информация |
---|
Важно:
|
...
Заголовки и параметры запроса
Authorization (обязательный) | Базовый URL аккаунта, например, https://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. Указывается в часах | |
lockAfterDueDate (необязательный) | Параметр показывает, будет ли курс заблокирован после окончания срока выполнения. Возможные значения: false или true | |
Заголовок | Описание |
Коды ответов
201 | Created | Новые назначения созданы. |
400 | Bad Request | Ошибка в запросе. |
401 | Unauthorized | Ошибка авторизации. |
403 | Permission Denied | У пользователя недостаточно пользователя недостаточно прав для создания назначений. |
Код | Текст | Описание |
---|
Пример запроса
Блок кода | ||
---|---|---|
| ||
POST /enrollment https/1.1 Host: api-learn.ispringlearn.com X-Auth-Account-Url: https://myaccount.ispringlearn.ru X-Auth-EmailAuthorization: email@email.com X-Auth-Password: passwordp-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE 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 10:30:00</accessDate> <dueDateType>unlimited</dueDateType> <dueDate>2019-10-26 10:30:00</dueDate> <duePeriod>0</duePeriod> </request> |
...