To get information on an enrollment, use the getEnrollment method.
Permissions to run the request: Account Owner, Administrators, Department Administrators, Publishers, or users with a role with custom settings.
Parameters
| Parameter | Type | Description |
|---|---|---|
| credentials (required) | credentials | Read the description of the Credentials object. |
| enrollmentId (required) | string | The ID of the enrollment you want to get info on. |
Return Value
After the request has been successfully processed, the system returns an object with the following properties:
| Parameter | Type | Description |
|---|---|---|
| enrollment | array | An array containing the ’courseIds’, ’learnerIds' values. |
Sample Request
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<GetEnrollmentRequest>
<credentials>
<accountUrl>http://myaccount.ispringlearn.com</accountUrl>
<email>email@email.com</email>
<password>password</password>
</credentials>
<enrollmentId>string</enrollmentId>
</GetEnrollmentRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<GetEnrollmentResult>
<enrollment>
<enrollmentId>b98b8a30-df67-11e9-ac75-0a580af40cd4</enrollmentId>
<courseId>146ac240-d54f-11e9-9b88-0a580af40973</courseId>
<learnerId>00de7a40-deb5-11e9-8afe-0a580af40764</learnerId>
<accessDate>2019-09-25</accessDate>
<shouldLockAfterDueDate>false</shouldLockAfterDueDate>
</enrollment>
</GetEnrollmentResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>