For Developers

Courses

List Courses

courses.list(options);

Retrieve a list of Courses.

Arguments

ParameterTypeDescription
optionsobjectThis function supports standard paging options.

Example Usage

for await (const course of edlink.courses.list()) {
    console.log(course.name);
}

Fetch Course

courses.fetch(course_id, options);

Retrieve an individual Course.

Arguments

ParameterTypeDescription
course_idstringThe UUID of the course.
optionsobjectThis function supports standard paging options.

Example Usage

const course = await edlink.courses.fetch(course_id);
console.log(course.name);

List Course Classes

courses.listClasses(course_id, options);

Retrieve a list of Classes for a Course.

Arguments

ParameterTypeDescription
course_idstringThe UUID of the course.
optionsobjectThis function supports standard paging options.

Example Usage

for await (const clazz of edlink.courses.listClasses(course_id)) {
    console.log(clazz.name);
}