For Developers

Schools

List Schools

schools.list();

Retrieve a list of Schools.

Function Arguments

This query allows for standard paging options.

Fetch School

schools.fetch(school_id, options);

Retrieve a single School.

Function Arguments

This query allows for standard paging options.

ParameterTypeDescription
school_idstringThe UUID of the school.

List School Classes

schools.listClasses(school_id, options);

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

Function Arguments

This query allows for standard paging options.

ParameterTypeDescription
school_idstringThe UUID of the school.

List School Courses

schools.listCourses(school_id, options);

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

Function Arguments

This query allows for standard paging options.

ParameterTypeDescription
school_idstringThe UUID of the school.

List School Sessions

schools.listSessions(school_id, options);

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

Function Arguments

This query allows for standard paging options.

ParameterTypeDescription
school_idstringThe UUID of the school.

List School People

schools.listPeople(school_id, options);

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

Function Arguments

This query allows for standard paging options.

ParameterTypeDescription
school_idstringThe UUID of the school.

List School Administrators

schools.listAdministrators(school_id, options);

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

Function Arguments

This query allows for standard paging options.

ParameterTypeDescription
school_idstringThe UUID of the school.

List School Teachers

schools.listTeachers(school_id, options);

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

Function Arguments

This query allows for standard paging options.

ParameterTypeDescription
school_idstringThe UUID of the school.

List School Students

schools.listStudents(school_id, options);

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

Function Arguments

This query allows for standard paging options.

ParameterTypeDescription
school_idstringThe UUID of the school.