To enroll users into courses, send the GET request to the following URL: /enrollment.
Permissions to run the request: Account Owner, Account Administrators, Department Administrators, Publishers, or users with a role with custom settings allowing to create enrollments.
|X-Auth-Account-Url (required)||The base URL of the account, e.g. http://myaccount.ispringlearn.com|
|X-Auth-Email (required)||The login of Account Owner, Administrator, Department Administrator, Publisher or a user with a role with custom settings allowing to create enrollments.|
|X-Auth-Password (required)||The password of Account Owner, Administrator, Department Administrator, Publisher or a user with a role with custom settings allowing to create enrollments.|
The IDs of the courses you want to assign.
The IDs of the learners you want to enroll in the courses.
The 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.
This parameter indicates whether the course has a due date or it isn't time-limited. Possible values of the parameter are unlimited, default, due_date, due_period.
This parameter is required if dueDateType = due_date.
This parameter is required if dueDateType = due_period. It is measured in hours.
After the request has been completed, the system returns the response with the 201 code. The response code contains the ID of the created enrollment.
|201||Successful operation||New enrollments have been created.|
|400||Bad Request||A request error.|
|401||Unauthorized||An authorization error.|
|403||Permission Denied||The user doesn't have enough permissions to create enrollments.|