Method: getEnrollments
| Panel | ||
|---|---|---|
| ||
You can get a list of enrollments for the entire account, for certain learners, for certain courses, or for both latter parameters. |
...
| Parameter | Type | Description |
|---|---|---|
| token (required) | string | Access token. You can obtain a token by making a request |
| courseIds (optional) | array | The IDs of the courses which enrollments you would like to get |
| learnerIds (optional) | array | The IDs of the users whose enrollments you would like to get |
...
| Parameter | Type | Description |
|---|---|---|
| enrollment | array | An array containing the xml data with the following values: enrollmentId, courseId, accessDate, dueDate, expirationDate, shouldLockAfterDueDate |
| 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 | Course completion date. This parameter appears in the response if a due date is specified | |
| expirationDate | 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 means that access is granted 1 means that access is denied | |
| issuedCertificateId | The certificate ID (token) from the list of enrollments | |
| certIssueDate | date | The date the certificate was issued |
| certExpiryDate | date | The certificate’s expiration date |
| enrollmentTypeGroup | int32 | 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. |
...