Page tree
Skip to end of metadata
Go to start of metadata

Request: POST /enrollment

Permissions to Run the Request

 Account Owner, Account Administrators, Department Administrators, Publishers, or custom roles

Department Administrators, Publishers, and users with a custom role can enroll in courses only learners belonging to the departments they manage and their sub-departments.

Request Headers

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 OwnerAccount AdministratorDepartment Administrator, Publisher, or a user with a custom role. 
X-Auth-Password (required)The password of Account OwnerAccount AdministratorDepartment Administrator, Publisher or a user with a custom role. 
ParameterDescription
courseIds (required)

The IDs of the courses you want to assign.

learnerIds (required)

The IDs of the learners you want to enroll in the courses.

accessDate (optional)

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.

dueDateType (required)

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.

dueDate (required)

This parameter is required if dueDateType = due_date. 

duePeriod (required)

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

Header

Description

Response Codes

201Successful operationNew enrollments have been created. The response code contains the IDs of the created enrollments.
400Bad RequestA request error.
401UnauthorizedAn authorization error.
403Permission DeniedThe user doesn't have enough permissions to create enrollments.

Code

Text

Description

Sample Request

POST /enrollment HTTP/1.1
Host: api-learn.ispringlearn.com
X-Auth-Account-Url: http://myaccount.ispringlearn.com
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 10:30:00</accessDate>
	<dueDateType>unlimited</dueDateType>
	<dueDate>2019-09-26</dueDate>
	<duePeriod>0</duePeriod>
</request>

Sample Response

HTTP/1.1 201 Successful operation
Connection: close
  • No labels