School

School

Represents a school on SMHW.


Constructor

new School(client, response)

Instantiate a School object.

Parameters:
Name Type Description
client Client

The client that is instantiating the object.

response Object

The data for the object.

Members

(private) _client :Client

The client that instantiated this object.

Type:
  • Client

active_directory_enabled :Boolean

Type:
  • Boolean

address :String

The address of the school.

Type:
  • String

announcement_category_ids :Array.<Number>

An array of announcement categories that the school belongs to.

Type:
  • Array.<Number>

assessment :Boolean

Whether or not the school is subscribed to SatchelOne's assessment product.

Type:
  • Boolean

attendance :Boolean

Whether or not the school is subscribed to SatchelOne's attendance product.

Type:
  • Boolean

attendance_settings_id :Number

The ID for the school's settings on SatchelOne's attendance.

Type:
  • Number

The name of the school's banner.

Type:
  • String

The URL of the school's banner.

Type:
  • String

book_store :Boolean

Whether or not the school has a book store.

Type:
  • Boolean

brand_color :String

The brand colour of the school.

Type:
  • String

brand_colour :String

The brand colour of the school.

Type:
  • String

collins_settings :Object

Whether or not the school has certain collins settings enabled.

Type:
  • Object

core :Boolean

Type:
  • Boolean

country :String

The country of the school.

Type:
  • String

created_at :Number

The timestamp of when the school signed up to SMHW.

Type:
  • Number

description :String

The description of the school.

Type:
  • String

detentions :Boolean

Whether or not the school is subscribed to SatchelOne's detentions product.

Type:
  • Boolean

dropbox_uploads_disabled :Boolean

Whether or not the school has dropbox uploads disabled.

Type:
  • Boolean

email :String

The email of the school.

Type:
  • String

facebook :String

The facebook account of the school.

Type:
  • String

google_drive_uploads_disabled :Boolean

Whether or not the school has Google Drive Uploads disabled.

Type:
  • Boolean

google_enabled :Boolean

Type:
  • Boolean

google_tts :Boolean

Whether or not the school uses google's text-to-speech.

Type:
  • Boolean

has_o365_integration :Boolean

Whether or not the school has Office 365 integration.

Type:
  • Boolean

homepage_active :Boolean

Whether or not the school's home page is active.

Type:
  • Boolean

homepage_background :string

The background for the school's home page.

Type:
  • string

homepage_zones :Boolean

Whether or not the school has zones it's home page.

Type:
  • Boolean

id :Number

The ID of the school.

Type:
  • Number

import_external_type :String

Type:
  • String

instagram :String

The instagram account of the school.

Type:
  • String

is_active :Boolean

Whether or not the school is active.

Type:
  • Boolean

is_discussion_enabled :Booolean

Whether or not the school has discussion enabled.

Type:
  • Booolean

kudos :Boolean

Whether or not the school has kudos enabled.

Type:
  • Boolean

kudos_import :Boolean

Type:
  • Boolean

kudos_writeback :Boolean

Type:
  • Boolean

latitude :Number

The latitude location of the school.

Type:
  • Number

Links for API resources for the school.

Type:
  • Object

logo_name :String

The name of the school's logo.

Type:
  • String

logo_url :String

The URL of the school's logo.

Type:
  • String

longitude :Number

The longitude location of the school.

Type:
  • Number

name :String

The name of the school.

Type:
  • String

native_apps_task_advert :Boolean

Type:
  • Boolean

new_classwork_enabled :Boolean

Type:
  • Boolean

new_students_list_enabled :Boolean

Type:
  • Boolean

one_drive_uploads_disabled :Boolean

Whether or not the school has Only Drive uploads disabled.

Type:
  • Boolean

only_positive_kudos_enabled :Boolean

Type:
  • Boolean

parent_zone_root_id :Number

The ID of the school's parent zone.

Type:
  • Number

phone_number :String

The phone number of the school.

Type:
  • String

post_code :String

The post code of the school.

Type:
  • String

praise_points :Boolean

Type:
  • Boolean

premium_features :Object

Whether or not the school has certain premium features.

Type:
  • Object

prospectus_name :String

The name of the school's prospectus.

Type:
  • String

prospectus_url :String

The URL of the school's prospectus.

Type:
  • String

registration_group_ids :Array.<Number>

An array of IDs of registration groups in the school.

Type:
  • Array.<Number>

root_directory_id :Number

Type:
  • Number

school_praise_info_id :Number

Type:
  • Number

school_private_info_id :Number

The ID of the school's private information.

Type:
  • Number

school_type :String

The type of school.

Type:
  • String

school_zone_root_id :Number

The ID for the school's root zone.

Type:
  • Number

serious_incidents_enabled :Boolean

Type:
  • Boolean

share_kudos_comments_enabled :Boolean

Type:
  • Boolean

show_staff_codes_for_public :Boolean

Type:
  • Boolean

sims_enabled :Boolean

Whether or not the school has sims enabled/

Type:
  • Boolean

smart_seating :Boolean

Whether or not the school is subscribed to SatchelOne's smart seating product.

Type:
  • Boolean

student_zone_root_id :Number

The ID for the school's student zone.

Type:
  • Number

subdomain :String

The subdomain of the school.

Type:
  • String

teacher_signup_enabled :Boolean

Whether or not the school has teacher signup enabled.

Type:
  • Boolean

time_zone :String

The city of timezone of the school.

Type:
  • String

timetables :Boolean

Whether or not the school is subscribed to SatchelOne's timetables product.

Type:
  • Boolean

town :String

The town of the school.

Type:
  • String

trial :Boolean

Whether or not the school is using a trial of SMHW.

Type:
  • Boolean

twitter :String

The twitter account of the school.

Type:
  • String

updated_at :Number

The timestamp of when the school was last updated.

Type:
  • Number

website :String

The website of the school.

Type:
  • String

xod_ready :Boolean

Type:
  • Boolean

Methods

getClassGroups(idsopt) → {Promise.<Array.<ClassGroup>>}

Get class groups in the school.

Parameters:
Name Type Attributes Description
ids Array.<Number> <optional>

An array of class group IDs to retrieve.

Returns:
Type
Promise.<Array.<ClassGroup>>

getClassYears(idsopt) → {Promise.<Array.<ClassYear>>}

Get class years in the school.

Parameters:
Name Type Attributes Description
ids Array.<Number> <optional>

An array of class year IDs to retrieve.

Returns:
Type
Promise.<Array.<ClassYear>>

getDetentionTemplates(idsopt) → {Promise.<Array.<DetentionTemplate>>}

Get detention templates in the school.

Parameters:
Name Type Attributes Description
ids Array.<Number> <optional>

An array of detention template IDs to retrieve.

Returns:
Type
Promise.<Array.<DetentionTemplate>>

getEmployees(idsopt) → {Promise.<Array.<Employee>>}

Get employees in the school.

Parameters:
Name Type Attributes Description
ids Array.<Number> <optional>

An array of employee IDs to retrieve.

Returns:
Type
Promise.<Array.<Employee>>

getPrivateInformation() → {Promise.<SchoolPrivateInformation>}

Get private information about the school.

Returns:
Type
Promise.<SchoolPrivateInformation>