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

To get information on an enrollment, send the GET request to the following URL: /enrollment/{enrollment_id}.

Permissions to run the request: Account OwnerAdministratorsDepartment Administrators, Publishers, or users with a role with custom settings.

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 role with custom settings.

X-Auth-Password (required)The password of Account OwnerAdministratorDepartment Administrator, Publisher or a user with a role with custom settings.

enrollment_id (required)

The ID of an enrollment you want to get information on.

After the request has been completed, the system returns the response with the 200 code. The response code will contain XML data with the information on the enrollment.

Response Codes

Code

Text

Description

200Successful operationThe request has been successfully processed. 
400Bad RequestA request error.
401UnauthorizedAn authorization error.
403Permission DeniedThe user doesn't have enough permissions to get information on an enrollment.

Sample Request

GET /enrollment/3fa85f64-5717-4562-b3fc-2c963f66afa6 HTTP/1.1
Host: api-learn.ispringlearn.com
X-Auth-Account-Url: http://my.ispringlearn.com
X-Auth-Email: email@email.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