Sections

List Sections

sections.list(options);

Retrieve a list of Sections.

Arguments

Example Usage

for await (const section of edlink.sections.list()) {
    console.log(section.name);
}

Fetch Section

sections.fetch(section_id, options);

Retrieve an individual Section.

Arguments

Example Usage

const section = await edlink.sections.fetch(section_id);
console.log(section.name);

List Section Enrollments

sections.listEnrollments(section_id, options);

Retrieve a list of Enrollments in a Section.

Arguments

Example Usage

for await (const enrollment of edlink.sections.listEnrollments(section_id)) {
    console.log(enrollment.role, enrollment.status);
}

List Section People

sections.listPeople(section_id, options);

Retrieve a list of People in a Section.

Arguments

Example Usage

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

List Section Teachers

sections.listTeachers(section_id, options);

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

Arguments

Example Usage

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

List Section Students

sections.listStudents(section_id, options);

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

Arguments

Example Usage

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