Документация по iSpring Learn

Дерево страниц

ДОСТУПНО В BUSINESS ПОДПИСКЕ

Запрос: POST /enrollment

Важно:

  1. Метод позволяет назначать только курсы, траектории обучения и учебные материалы. Записать пользователя на мероприятие, используя этот метод, нельзя.

  2. С помощью метода вы можете назначить пользователю курс с мероприятием, но без выбора сессии для посещения. Пользователь сможет самостоятельно выбрать сессию в своем портале. 


Права для выполнения запроса

Владелец аккаунта, Администратор аккаунта, Администратор подразделения или роль с индивидуальными настройками, которые позволяют создавать назначения.

Администратор подразделения и пользователь с ролью с индивидуальными настройками могут назначать курсы только пользователям подразделений, которыми управляют, и вложенных в них подразделений.

Заголовки и параметры запроса

Authorization (обязательный)Токен доступа. Вы можете получить токен с помощью запроса
ПараметрОписание
courseIds (обязательный)ID курсов, которые вы хотите назначить

learnerIds (обязательный)

ID учащихся, которым вы хотите назначить курсы
accessDate (необязательный)

Дата и время начала обучения. Если дата и время не указаны, будут автоматически подставлена текущие дата и время

dueDateType (обязательный)Параметр показывает, есть ли у курса срок выполнения или же он неограничен по времени. Возможные значения параметра:  unlimited, default, due_date, due_period
dueDate (обязательный)Параметр обязателен, если dueDateType равен due_date
duePeriod (обязательный)Параметр обязателен, если dueDateType равен due_period. Указывается в часах
lockAfterDueDate (необязательный)Параметр показывает, будет ли курс заблокирован после окончания срока выполнения. Возможные значения: false или true

Заголовок

Описание

Коды ответов

201CreatedНовые назначения созданы
400Bad RequestОшибка в запросе
401UnauthorizedОшибка авторизации
403Permission DeniedУ пользователя недостаточно прав для создания назначений

Код

Текст

Описание

Пример запроса

POST /enrollment https/1.1
Host: api-learn.ispringlearn.ru
Authorization: p-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>

Пример ответа

https/1.1 201 Created