Methods
makeRequest(method, path, options)
Name | Type | Description |
---|---|---|
method |
String | The method for the request. |
path |
String | The path of the request. |
options |
RequestOptions | The options for the request. |
- Source:
Type Definitions
AssignmentInformation
Properties
Name | Type | Description |
---|---|---|
type |
String | The type of assignment. |
id |
Number | the ID of the assignment. |
- Source:
RequestOptions
Properties
Name | Type | Attributes | Description |
---|---|---|---|
host |
String |
<optional> |
The base hostname for the request. |
port |
Number |
<optional> |
The port of the request. |
query |
Object |
<optional> |
The querystring options for the request. |
body |
Object |
<optional> |
The post data body of the request. |
headers |
Object |
<optional> |
The headers for the request. |
referer |
String |
<optional> |
The referer path for the request. |
payload |
Object |
<optional> |
The JSON payload for the request. |
RequestOptions
Properties
Name | Type | Attributes | Description |
---|---|---|---|
host |
String |
<optional> |
The base hostname for the request. |
port |
Number |
<optional> |
The port of the request. |
query |
Object |
<optional> |
The querystring options for the request. |
body |
Object |
<optional> |
The post data body of the request. |
headers |
Object |
<optional> |
The headers for the request. |
referer |
String |
<optional> |
The referer path for the request. |
payload |
Object |
<optional> |
The JSON payload for the request. |
- Source:
SchoolPremiumFeatures
Properties
Name | Type | Description |
---|---|---|
custom_theme_enabled |
Boolean | Whether or not the school has a custom theme enabled. |
extended_notice_board |
Boolean | Whether or not the school has an extended notice board. |
welfare_notes |
Boolean | Whether or not the school has welfare notes. |
white_label_enabled |
Boolean |
- Source:
SchoolPrivateFeatures
Properties
Name | Type | Description |
---|---|---|
assessment_app_enabled |
Boolean | Whether or not the school has the assessment app feature enabled. |
assessment_enabled_for_teachers |
Boolean | Whether or not the school's assessments feature is enabled for teachers. |
detentions_enabled |
Boolean | Whether or not the school has the detentions app feature enabled. |
sso_enabled_for_employees |
Boolean | |
sso_enabled_for_students |
Boolean | |
timetable_promo_disabled |
Boolean | |
xod_enabled |
Boolean | |
xod_scope_enabled_photos |
Boolean | |
xod_scope_enabled_students |
Boolean |
SchoolPrivateLinks
Properties
Name | Type | Description |
---|---|---|
marking_schemes |
String | A link to marking schemes that the school uses. |
SchoolResourceLinks
Properties
Name | Type | Description |
---|---|---|
class_groups |
String | A link to an array of school class groups. |
class_years |
String | A link to an array of school class years. |
detention_templates |
String | A link to an array of school detention templates. |
employees |
String | A link to an array of school employees. |
kudos_reasons |
String | |
parents |
String | A link to an array of school parents. |
school_kudos_info |
String | |
students |
String | A link to an array of school students. |
subjects |
String | A link to an array of school subjects; |
- Source:
SubmissionInformation
Properties
Name | Type | Description |
---|---|---|
type |
String | The type of submission. |
id |
String | The ID of the submission. |
- Source:
SubmissionInformation
Properties
Name | Type | Description |
---|---|---|
type |
String | The type of submission. |
id |
String | The ID of the submission. |
- Source: