Method: getEnrollment
Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators, or custom roles.
Department Administrators and users with a custom role can get enrollments assigned to users from the departments they manage and their sub-departments.
Parameters
| Parameter | Type | Description |
| token (required) | string | Access token. You can obtain a token by making a request |
| enrollmentId (optional) | 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 |
| enrollmentId | string | The ID of the enrollment |
| courseId | string | The ID of the course |
| learnerId | string | The ID of the user enrolled to the course |
| accessDate | string | The date when the learner is supposed to start studying the course |
| shouldLockAfterDueDate | string | Possible values: 0 means that access is granted 1 means that access is denied |
| enrollmentTypeGroup | int32 | Possible values: 0 — assigned by an administrator 1 — added from the catalog |
| сertificate | array | Certificate info |
| issuedCertificateId | string | The certificate ID (token) from the list of enrollments |
| issueDate | string | The date the certificate was issued |
| expiryDate | string | The certificate’s expiration date |
Sample Request
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
xmlns="https://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<GetEnrollmentRequest>
<credentials>
<token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
</credentials>
<enrollmentId>string</enrollmentId>
</GetEnrollmentRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="https://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>