For Developers

Classes

List Classes

classes.list(options);

Retrieve a list of Classes.

Function Arguments

This query allows for standard paging options.

Fetch Class

classes.fetch(class_id);

Retrieve a single Class.

Function Arguments

This query allows for standard paging options.

ParameterTypeDescription
class_idstringThe UUID of the class.

List Class Sections

classes.listSections(class_id, options);

Retrieve a list of Sections in a Class.

Function Arguments

This query allows for standard paging options.

ParameterTypeDescription
class_idstringThe UUID of the class.

List Class Enrollments

classes.listEnrollments(class_id, options);

Retrieve a list of Enrollments in a Class.

Function Arguments

This query allows for standard paging options.

ParameterTypeDescription
class_idstringThe UUID of the class.

List Class People

classes.listPeople(class_id, options);

Retrieve a list of People in a Class.

Function Arguments

This query allows for standard paging options.

ParameterTypeDescription
class_idstringThe UUID of the class.

List Class Teachers

classes.listTeachers(class_id, options);

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

Function Arguments

This query allows for standard paging options.

ParameterTypeDescription
class_idstringThe UUID of the class.

List Class Students

classes.listTeachers(class_id, options);

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

Function Arguments

This query allows for standard paging options.

ParameterTypeDescription
class_idstringThe UUID of the class.