For Developers
Enrollments
List Enrollments
enrollments.list(options);
Retrieve a list of Enrollments.
Arguments
Parameter | Type | Description |
---|---|---|
options | object | This function supports standard paging options. |
Example Usage
for await (const enrollment of edlink.enrollments.list()) {
console.log(enrollment.person_id, enrollment.role, enrollment.state);
}
Fetch Enrollment
enrollments.fetch(enrollment_id, options);
Retrieve an individual Enrollment.
Arguments
Parameter | Type | Description |
---|---|---|
enrollment_id | string | The UUID of the enrollment. |
options | object | This function supports standard paging options. |
Example Usage
const enrollment = await edlink.enrollments.fetch(enrollment_id);
console.log(enrollment.person_id, enrollment.role, enrollment.state);