Request: GET /enrollments
| Panel | ||
|---|---|---|
| ||
You can get all the account enrollments, enrollments related to certain learners or to certain courses, or both. |
...
| 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 in the course |
| accessDate | The date the learner is supposed to start studying the course |
| dueDate (optional) | Course completion date. This parameter appears in the response if a due date is specified |
| expirationDate (optional) | Course completion date. This parameter appears in the response if a due date is specified and shouldLockAfterDueDate is equal to 1 |
| shouldLockAfterDueDate | Possible values: 0 — access is granted. 1 — access is denied. |
| сertificate | Certificate info |
| issuedCertificateId | The certificate ID (token) from the list of enrollments |
| issueDate | The date the certificate was issued |
| expiryDate | The certificate’s expiration date |
| enrollmentTypeGroup | Possible values: 0 — assigned by an administrator 1 — added from the catalog |
| Panel | |
|---|---|
| |
| |
The date of issue and expiration of the certificate can only be received for active enrollments. When using this method, you cannot get the data for archived or deleted enrollments. |
...