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

Request: GET /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 get list of enrollments assigned to learners belonging to the departments they manage and their sub-departments.

You can get a list of enrollments of the entire account, certain learners, courses, or last two parameters together.

Request Headers

Header

Description

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

The IDs of the users whose enrollments you would like to get.

courseIds (optional)

The IDs of the courses which enrollments you would like to get.

Response Code

Code

Text

Description

200Successful operationThe request has been successfully processed. The response code will contain data with the enrollments.
400Bad RequestA request error.
401UnauthorizedAn authorization error.
403Permission DeniedThe user doesn't have enough permissions to get a list of enrollments.

Sample Request

GET /enrollment?courseIds[]=146ac240-d54f-11e9-9b88-0a580af40973&learnerIds[]=00de7a40-deb5-11e9-8afe-0a580af40764 HTTP/1.1
Host: api-learn.ispringlearn.com
X-Auth-Account-Url: http://my.ispringlearn.com
X-Auth-Password: password

Sample Response

HTTP/1.1 200 Successful operation
Connection: close

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<response>
		<enrollmentId>3fa85f64-5717-4562-b3fc-2c963f66afa6</enrollmentId>
		<courseId>3fa85f64-5717-4562-b3fc-2c963f66afa6</courseId>
		<learnerId>3fa85f64-5717-4562-b3fc-2c963f66afa6</learnerId>
		<accessDate>2019-09-26</accessDate>
		<dueDate>2019-09-26</dueDate>
		<expirationDate>2019-09-26</expirationDate>
		<shouldLockAfterDueDate>true</shouldLockAfterDueDate>
	</response>
</response>
  • No labels