get_roster
Fetch students, teachers, classes, classrooms, or subjects from an EduPage school. Provide the roster type to return the matching list.
Instructions
Get a school roster: students, teachers, classes, classrooms or subjects. Read-only.
Args:
roster_type: Which roster to return:
- 'students' — students in the logged-in user's class
(formerly get_students).
- 'all_students' — a short list of all students in the school
(formerly get_all_students).
- 'teachers' — all teachers (formerly get_teachers).
- 'classes' — all classes (formerly get_classes).
- 'classrooms' — all classrooms (formerly get_classrooms).
- 'subjects' — all subjects (formerly get_subjects).
subdomain: School to query (defaults to the active subdomain).
Returns: dict keyed by the roster name, e.g. {'subdomain': ..., 'teachers': [...], ...}.
Notes:
- For the students visible to the logged-in account (parents: their
linked children; students: classmates) prefer get_my_students.
- To look one student up by name use find_student.
- Returned person/class ids feed get_timetable (target_type/target_id)
and switch_to_student.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| subdomain | No | ||
| roster_type | Yes |