Versions Compared

Old Version 1

changes.mady.by.user Alina Levitskaya

Saved on

compared with

New Version Current

changes.mady.by.user Alina Levitskaya

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Method: enrollLearnersInCourses

info
Panel
bgColor#eaf4fd

Notes:

  1. This method only allows you to enroll users in courses and learning tracks. You can't enroll a user in a training using this method.

  2. With this method, you can enroll a user in a course containing a training, but without selecting a session to attend. The user will be able to choose a session in their portal.

...

Parameter

Type

Description

token (required)stringAccess token. You can obtain a token by making a request.
courseIds (required)string[]

The IDs of the courses you want to assign.

learnerIds (required)string[]The IDs of the learners you want to enroll in the courses.
accessDate (optional)dateTimeThe date and time when learners are supposed to start studying the course. If the start date and time aren't indicated, the current date and time will be auto-populated.
dueDateType (required)stringThis parameter indicates if the course has a due date or it isn't time-limited. Possible values of the parameter are unlimited, default, due_date, due_period.
dueDate (required)dateThis parameter is required if dueDateType is equal to due_date. 
duePeriod (required)int

This parameter is required if dueDateType is equal to due_period. It is measured in hours.

lockAfterDueDate (optional)boolThis parameter indicates whether the course will be blocked after the due date. Possible values of the parameter are true or false.

...