Request: GET /enrollment/{enrollment_id}

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 information about enrollments assigned to learners from the departments they manage or their sub-departments.

Request Headers

Header	Description
X-Auth-Account-Url (required)	The base URL of the account, e.g. https://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.
X-Auth-Password (required)	The password of Account Owner, Administrator, Department Administrator, Publisher or a user with a role with custom settings.
Parameter	Description
enrollment_id (required)	The ID of an enrollment you want to get information on.

Response Parameters

Parameter	Description
response	An array with enrollment data.
enrollmentId	The ID of the enrollment.
courseId	The ID of the course.
learnerId	The ID of the user enrolled to the course
accessDate	The date when the learner is supposed to start studying the course.
dueDate (optional)	Course completion date. The parameter appears in the response if a due date is specified.
expirationDate (optional)	Course completion date. The parameter appears in the response if a due date is specified and shouldLockAfterDueDate is equal to 1.
shouldLockAfterDueDate	Possible values: 0 means that access is granted. 1 means that access is denied.
enrollmentTypeGroup	Possible values: 0 — assigned by an administrator 1 — added from the catalog

Response Codes

Code	Text	Description
200	OK	The request has been successfully processed. The response body will contain XML data with the information on the enrollment.
400	Bad Request	A request error.
401	Unauthorized	An authorization error.
403	Permission Denied	The user doesn't have enough permissions to get information on an enrollment.

Sample Request

GET /enrollment/3fa85f64-5717-4562-b3fc-2c963f66afa6 https/1.1
Host: api-learn.ispringlearn.com
X-Auth-Account-Url: https://my.ispringlearn.com
X-Auth-Email: email@email.com
X-Auth-Password: password

XML

Sample Response

https/1.1 200 OK

<?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>

XML