Constructor
new School(client, response)
Instantiate a School object.
Name | Type | Description |
---|---|---|
client |
Client | The client that is instantiating the object. |
response |
Object | The data for the object. |
- Source:
Members
(private) _client :Client
The client that instantiated this object.
- Client
- Source:
active_directory_enabled :Boolean
- Boolean
- Source:
address :String
The address of the school.
- String
- Source:
announcement_category_ids :Array.<Number>
An array of announcement categories that the school belongs to.
- Array.<Number>
- Source:
assessment :Boolean
Whether or not the school is subscribed to SatchelOne's assessment product.
- Boolean
- Source:
attendance :Boolean
Whether or not the school is subscribed to SatchelOne's attendance product.
- Boolean
- Source:
attendance_settings_id :Number
The ID for the school's settings on SatchelOne's attendance.
- Number
- Source:
banner_name :String
The name of the school's banner.
- String
- Source:
banner_url :String
The URL of the school's banner.
- String
- Source:
book_store :Boolean
Whether or not the school has a book store.
- Boolean
- Source:
brand_color :String
The brand colour of the school.
- String
- Source:
brand_colour :String
The brand colour of the school.
- String
- Source:
collins_settings :Object
Whether or not the school has certain collins settings enabled.
- Object
- Source:
core :Boolean
- Boolean
- Source:
country :String
The country of the school.
- String
- Source:
created_at :Number
The timestamp of when the school signed up to SMHW.
- Number
- Source:
description :String
The description of the school.
- String
- Source:
detentions :Boolean
Whether or not the school is subscribed to SatchelOne's detentions product.
- Boolean
- Source:
dropbox_uploads_disabled :Boolean
Whether or not the school has dropbox uploads disabled.
- Boolean
- Source:
email :String
The email of the school.
- String
- Source:
facebook :String
The facebook account of the school.
- String
- Source:
google_drive_uploads_disabled :Boolean
Whether or not the school has Google Drive Uploads disabled.
- Boolean
- Source:
google_enabled :Boolean
- Boolean
- Source:
google_tts :Boolean
Whether or not the school uses google's text-to-speech.
- Boolean
- Source:
has_o365_integration :Boolean
Whether or not the school has Office 365 integration.
- Boolean
- Source:
homepage_active :Boolean
Whether or not the school's home page is active.
- Boolean
- Source:
homepage_background :string
The background for the school's home page.
- string
- Source:
homepage_zones :Boolean
Whether or not the school has zones it's home page.
- Boolean
- Source:
id :Number
The ID of the school.
- Number
- Source:
import_external_type :String
- String
- Source:
instagram :String
The instagram account of the school.
- String
- Source:
is_active :Boolean
Whether or not the school is active.
- Boolean
- Source:
is_discussion_enabled :Booolean
Whether or not the school has discussion enabled.
- Booolean
- Source:
kudos :Boolean
Whether or not the school has kudos enabled.
- Boolean
- Source:
kudos_import :Boolean
- Boolean
- Source:
kudos_writeback :Boolean
- Boolean
- Source:
latitude :Number
The latitude location of the school.
- Number
- Source:
links :Object
Links for API resources for the school.
- Object
- Source:
logo_name :String
The name of the school's logo.
- String
- Source:
logo_url :String
The URL of the school's logo.
- String
- Source:
longitude :Number
The longitude location of the school.
- Number
- Source:
name :String
The name of the school.
- String
- Source:
native_apps_task_advert :Boolean
- Boolean
- Source:
new_classwork_enabled :Boolean
- Boolean
- Source:
new_students_list_enabled :Boolean
- Boolean
- Source:
one_drive_uploads_disabled :Boolean
Whether or not the school has Only Drive uploads disabled.
- Boolean
- Source:
only_positive_kudos_enabled :Boolean
- Boolean
- Source:
parent_zone_root_id :Number
The ID of the school's parent zone.
- Number
- Source:
phone_number :String
The phone number of the school.
- String
- Source:
post_code :String
The post code of the school.
- String
- Source:
praise_points :Boolean
- Boolean
- Source:
premium_features :Object
Whether or not the school has certain premium features.
- Object
- Source:
prospectus_name :String
The name of the school's prospectus.
- String
- Source:
prospectus_url :String
The URL of the school's prospectus.
- String
- Source:
registration_group_ids :Array.<Number>
An array of IDs of registration groups in the school.
- Array.<Number>
- Source:
root_directory_id :Number
- Number
- Source:
school_praise_info_id :Number
- Number
- Source:
school_private_info_id :Number
The ID of the school's private information.
- Number
- Source:
school_type :String
The type of school.
- String
- Source:
school_zone_root_id :Number
The ID for the school's root zone.
- Number
- Source:
serious_incidents_enabled :Boolean
- Boolean
- Source:
share_kudos_comments_enabled :Boolean
- Boolean
- Source:
show_staff_codes_for_public :Boolean
- Boolean
- Source:
sims_enabled :Boolean
Whether or not the school has sims enabled/
- Boolean
- Source:
smart_seating :Boolean
Whether or not the school is subscribed to SatchelOne's smart seating product.
- Boolean
- Source:
student_zone_root_id :Number
The ID for the school's student zone.
- Number
- Source:
subdomain :String
The subdomain of the school.
- String
- Source:
teacher_signup_enabled :Boolean
Whether or not the school has teacher signup enabled.
- Boolean
- Source:
time_zone :String
The city of timezone of the school.
- String
- Source:
timetables :Boolean
Whether or not the school is subscribed to SatchelOne's timetables product.
- Boolean
- Source:
town :String
The town of the school.
- String
- Source:
trial :Boolean
Whether or not the school is using a trial of SMHW.
- Boolean
- Source:
twitter :String
The twitter account of the school.
- String
- Source:
updated_at :Number
The timestamp of when the school was last updated.
- Number
- Source:
website :String
The website of the school.
- String
- Source:
xod_ready :Boolean
- Boolean
- Source:
Methods
getClassGroups(idsopt) → {Promise.<Array.<ClassGroup>>}
Get class groups in the school.
Name | Type | Attributes | Description |
---|---|---|---|
ids |
Array.<Number> |
<optional> |
An array of class group IDs to retrieve. |
- Source:
- Type
- Promise.<Array.<ClassGroup>>
getClassYears(idsopt) → {Promise.<Array.<ClassYear>>}
Get class years in the school.
Name | Type | Attributes | Description |
---|---|---|---|
ids |
Array.<Number> |
<optional> |
An array of class year IDs to retrieve. |
- Source:
- Type
- Promise.<Array.<ClassYear>>
getDetentionTemplates(idsopt) → {Promise.<Array.<DetentionTemplate>>}
Get detention templates in the school.
Name | Type | Attributes | Description |
---|---|---|---|
ids |
Array.<Number> |
<optional> |
An array of detention template IDs to retrieve. |
- Source:
- Type
- Promise.<Array.<DetentionTemplate>>
getEmployees(idsopt) → {Promise.<Array.<Employee>>}
Get employees in the school.
Name | Type | Attributes | Description |
---|---|---|---|
ids |
Array.<Number> |
<optional> |
An array of employee IDs to retrieve. |
- Source:
- Type
- Promise.<Array.<Employee>>
getPrivateInformation() → {Promise.<SchoolPrivateInformation>}
Get private information about the school.
- Source:
- Type
- Promise.<SchoolPrivateInformation>