Schools

List Schools

schools.list(options);

Retrieve a list of Schools.

Arguments

Example Usage

for await (const school of edlink.schools.list()) {
    console.log(school.name);
}

Fetch School

schools.fetch(school_id, options);

Retrieve a single School.

Arguments

Example Usage

const school = await edlink.schools.fetch(school_id);
console.log(school.name);

List School Classes

schools.listClasses(school_id, options);

Retrieve a list of classes in a School. Responds with an array of Class objects.

Arguments

Example Usage

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

List School Courses

schools.listCourses(school_id, options);

Retrieve a list of courses in a School. Responds with an array of Course objects.

Arguments

Example Usage

for await (const course of edlink.schools.listCourses(school_id)) {
    console.log(course.name);
}

List School Sessions

schools.listSessions(school_id, options);

Retrieve a list of sessions in a School. Responds with an array of Session objects.

Arguments

Example Usage

for await (const session of edlink.schools.listSessions(school_id)) {
    console.log(session.name);
}

List School People

schools.listPeople(school_id, options);

Retrieve a list of people in a School. Responds with an array of Person objects.

Arguments

Example Usage

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

List School Administrators

schools.listAdministrators(school_id, options);

Retrieve a list of administrators in a School. Responds with an array of Person objects.

Arguments

Example Usage

for await (const admin of edlink.schools.listAdministrators(school_id)) {
    console.log(admin.display_name);
}

List School Teachers

schools.listTeachers(school_id, options);

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

Arguments

Example Usage

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

List School Students

schools.listStudents(school_id, options);

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

Arguments

Example Usage

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