Classes

List Classes

classes.list(options);

Retrieve a list of Classes.

Arguments

Example Usage

for await (const clazz of edlink.classes.list()) {
    console.log(clazz.name);
}

Fetch Class

classes.fetch(class_id);

Retrieve a single Class.

Arguments

Example Usage

const clazz = await edlink.classes.fetch(class_id);
console.log(clazz.name);

List Class Sections

classes.listSections(class_id, options);

Retrieve a list of Sections in a Class.

Arguments

Example Usage

for await (const section of edlink.classes.listSections(class_id)) {
    console.log(section.name);
}

List Class Enrollments

classes.listEnrollments(class_id, options);

Retrieve a list of Enrollments in a Class.

Arguments

Example Usage

for await (const enrollment of edlink.classes.listEnrollments(class_id)) {
    console.log(enrollment.role, enrollment.state);
}

List Class People

classes.listPeople(class_id, options);

Retrieve a list of People in a Class.

Arguments

Example Usage

for await (const person of edlink.classes.listPeople(class_id)) {
    console.log(person.first_name, person.last_name);
}

List Class Teachers

classes.listTeachers(class_id, options);

Retrieve a list of teachers in a Class. Responds with an array of Person objects.

Arguments

Example Usage

for await (const teacher of edlink.classes.listTeachers(class_id)) {
    console.log(teacher.display_name);
}

List Class Students

classes.listStudents(class_id, options);

Retrieve a list of students in a Class. Responds with an array of Person objects.

Arguments

Example Usage

for await (const student of edlink.classes.listStudents(class_id)) {
    console.log(student.display_name);
}