SchoolIncomplete

SchoolIncomplete

Represents an incomplete school.

Properties

.client (Client) The client that initiated the object.

.location (Location) The location information for the school.

.id (Number) The ID of the school.

.name (String) The name of the school.

.subdomain (String) The subdomain of the school.

.active (Boolean) Whether or not the school is active.

.colour (String) The primary colour of the school.

.incomplete (Boolean) Whether or not the school object is incomplete.

Methods

.complete()

Complete the school object. Returns Promise<School>

.getTeachers()

Get a list of teachers employed at the school. Returns Promise<Array<Teacher>>

.getClassYears()

Get a list of class years at the school. Returns Promise<Array<ClassYear>>

.getSubjects()

Get a list of subjects at the school. Returns Promise<Array<Subject>>

.getClassGroups()

Get a list of class groups at the school. Returns Promise<Array<ClassGroup>>

.getRegistrationGroups()

Get a list of registration groups at the school. Returns Promise<Array<ClassGroup>>

.getPrivateInfo()

Get private information about the school. Returns Promise<SchoolPrivateInfo>