WCBS HUBmis (1.2.0)

Download OpenAPI specification:Download

HUBmis development team: support@wcbs.co.uk URL: https://www.wcbs.co.uk/support

Download OpenAPI Specification In YAML Format

Introduction

The HUBmis JSON API provides an easy-to-use and functionality-rich RESTful interface for developers to build their own solutions. Requests/responses are provided in JSON format.

Once authenticated (see 'Authentication' for more details), requests are made for a selected 'Realm' ID, which corresponds to the school you wish to access the API on behalf of.

Production Base URLs:

If you would like to register to use the HUBmis API, please go to https://www.wcbs.co.uk/contact-us

Authentication

After you have registered to use the HUBmis API, you will be sent an email to your registered email address with information about how to obtain your client credentials in order to generate an access token. Your client secret must be kept confidential and stored securely. Upon obtaining your client credentials, you can authenticate to the API as follows:

Make a request to the OAuth > Token endpoint with the client_credentials OAuth grant and your client_id and client_secret:

Request
```
POST /api/v1/token HTTP/1.1
Host: api.hubmis.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 73

grant_type=client_credentials&client_id=client123&client_secret=secret123
```

Response
```
{
    "token_type": "Bearer",
    "expires_in": 86400,
    "access_token": "123.abc.xyz"
}
```

The access_token in the response can then be sent in the Authorization header (alongside Realm) for all other API requests:

  Authorization: Bearer xyz123.abc
  Realm: xyz123

Access tokens expire after 15 minutes. When expired, the API will respond with a HTTP status code of 401 (Unauthorized), after which you will need to obtain a new token.

Usage Limits

The HUBmis API is rate-limited to 12 requests per minute per IP address and 500 requests per client, with a rate of one new request every 5 seconds. For example, if you make one request from the 500 available and after 5 seconds make no other requests, the available number will increase back to 500.

When the limit has been reached, the API will respond with a HTTP status code of 429 Too Many Requests and you will need to wait at least 5 seconds to make a new request.

The following 3 headers in the response provide information of the limit, how many requests are remaining and the date-time (as a Unix timestamp) after which the request can be retried:

X-RateLimit-Limit: 500
X-RateLimit-Remaining: 495
X-RateLimit-Retry-After: 1615203774

Token

Token acquisition

Get access token

Get an access token with the client_credentials grant

Request Body schema: application/json

grant_type	string Value: "client_credentials"
client_id	string
client_secret	string

Responses

Request samples

Payload

Content type

application/json

{"grant_type": "client_credentials",
"client_id": "abc123XYZ",
"client_secret": "Secret123"
}

Response samples

Content type

application/json

{"token_type": "Bearer",
"expires_in": 900,
"access_token": "abc123.xyz"
}

Students

Students module - Contains services that pertain to Student Profile data.

Email Addresses: Get List of Email Addresses by student Id

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 9,
"email": "contact@wcbs.co.uk",
"communication": {"id": 15,
"type": "Email",
"category": "email",
"deleted_at": null,
"system_value": true
},
"position": 2
}
]

Get List of Progress Reports by student Id

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 0,
"academic_year": {"id": 1,
"name": "A string value"
},
"i": 0,
"html_path": "string",
"lesson_id": 0,
"pdf_path": "string",
"title": "string",
"reportarchive_id": 0,
"v3_year": "string",
"year_group": {"id": 1,
"name": "A non-null lookup value"
}
}
]

Student: Get list of Wellbeing Plans for a specific Student

Get Student Wellbeing Plan

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

query Parameters

filter[assignedTo]	integer Filter results by assigned Staff ID
page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset
filter[category]	integer Filter the table results by Category ID
filter[status]	string Enum: "active" "inactive" Filter the table results by Status
filter[severity]	integer Filter the table results by Severity ID
	object Range filter for date/time
search	string API Query Search

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 44,
"title": "Initial plan",
"status": "active",
"severity": {"id": 1,
"name": "Minor"
},
"category": {"id": 1,
"name": "Initial Plan - lower school",
"color": 8
},
"last_updated_at": "2019-08-24T14:15:22Z",
"assignees": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
]
}
]

Student: Get list of Wellbeing Events for a specific Student

Get Student Wellbeing Events

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

query Parameters

filter[assignedTo]	integer Filter results by assigned Staff ID
page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset
filter[category]	integer Filter the table results by Category ID
filter[status]	string Enum: "active" "inactive" Filter the table results by Status
filter[severity]	integer Filter the table results by Severity ID
	object Range filter for date/time
search	string API Query Search

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 44,
"title": "Initial plan",
"status": "active",
"severity": {"id": 1,
"name": "Minor"
},
"category": {"id": 1,
"name": "Initial Plan - lower school",
"color": 8
},
"last_updated_at": "2019-08-24T14:15:22Z",
"assignees": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
]
}
]

Contacts: Get List

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset
search	string API Query Search
filter[status]	integer Filter the table results by Status ID

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"access_status": "no_access",
"students_access": [{"relation_id": 34,
"access_to_student": true,
"student": {"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "Green House"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
}
],
"deleted_at": "2019-08-24T14:15:22Z",
"external_id": null,
"first_name": "Sarah",
"gender": {"id": 2,
"name": "Female"
},
"id": 37,
"last_name": "Shmyth",
"middle_name": null,
"primary_email": "user@example.com",
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.jpg",
"size": 306691,
"mime_type": "image/jpg",
"purpose": "contact_profile_image",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"status": "active",
"students": [{"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
],
"title": {"id": 5,
"name": "Miss"
},
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/contact_profile_image/36/123123.jpg"
}
]
}
]

Contact Students Relations: Get List

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 62,
"contact_student_relationship_type": {"id": 1,
"name": "Mother"
},
"student_contact_relationship_type": {"id": 41,
"name": "Son"
},
"relationship_group": {"id": 1,
"name": "Primary",
"rank": 1
},
"student": {"id": 14,
"access_status": "no_access",
"academic_house": {"id": 1,
"name": "Green House"
},
"boarding_type": {"id": 1,
"name": "Full Time Boarder"
},
"boarding_house": {"id": 1,
"name": "Green House"
},
"country_of_birth": {"id": 1,
"name": "Azerbaijan"
},
"date_of_birth": "2019-08-24",
"deleted_at": null,
"ethnicity": {"id": 15,
"name": "Other"
},
"enrolment_status": "current",
"external_id": null,
"faith": {"id": 1,
"name": "Atheist"
},
"first_name": "Richard",
"gender": {"id": 1,
"name": "Male"
},
"has_global_note": true,
"form": null,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/student_profile_image/16/123123.jpg"
}
],
"language_first": {"id": 1,
"name": "English"
},
"language_second": null,
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Pritchard",
"learning_support_record_summary": [ ],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"middle_name": null,
"name_in_local_language": null,
"national_identity": null,
"nationalities": [{"id": 1,
"name": "Azerbaijani"
}
],
"person_type": "student",
"preferred_name": null,
"primary_email": "user@example.com",
"profile_image": null,
"tags": [ ]
},
"access_to_student": true
}
]

Email Addresses: Get List of Email Addresses by contact Id

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 9,
"email": "contact@wcbs.co.uk",
"communication": {"id": 15,
"type": "Email",
"category": "email",
"deleted_at": null,
"system_value": true
},
"position": 2
}
]

Phones: Get List of Phones by contact Id

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 1,
"phone": "01782 555 555",
"communication": {"id": 11,
"type": "Home phone",
"category": "phone",
"deleted_at": null,
"system_value": true
},
"position": 1
}
]

Communication Preferences: Get List of Communication Preferences by contact Id

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"access_to_student": true,
"student": {"id": 15,
"first_name": "Harry",
"last_name": "DeCarre",
"middle_name": "Barry",
"name_in_local_language": null,
"preferred_name": "Barry",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": false,
"person_type": "student",
"status_indicator": "current"
},
"preference_emergency": true,
"preference_medical": true,
"preference_billing": false,
"court_order": false
}
]

Houses: Get Houses

Authorizations:

OAuth

query Parameters

filter[houseType]	string Enum: "academic" "boarding" Filter the results by the type of House
filter[isActive]	boolean Filter the Houses list by the Active status

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 8,
"code": "BHR",
"genders": [{"id": 2,
"name": "Female"
}
],
"house_parents": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"house_type": "boarding",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/boarding_house/36/123123.jpg"
}
],
"max_students": 20,
"name": "Red House",
"phone": "0117 422 2003",
"student_count": 4,
"system_profile_image": "red",
"is_active": true
}
]

Houses: Get House

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

academic-year-id	integer By default, the active year is used. Use this optional header to override
realm required	string Example: S999 Realm ID

Responses

Response samples

Content type

application/json

{"id": 9,
"address": null,
"code": "GH",
"genders": [{"id": 1,
"name": "Male"
}
],
"house_parents": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"house_type": "boarding",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/house_image/36/123123.jpg"
}
],
"max_students": 100,
"name": "Green House",
"note": null,
"phone": null,
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.jpg",
"size": 306691,
"mime_type": "image/jpg",
"purpose": "house_profile_image",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"staff": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"system_profile_image": "aqua",
"is_active": true
}

House: Get Students

This call will provide currently enrolled students (enrolment status 'current')

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

query Parameters

search	string API Query Search
filter[gender]	integer Filter the results by gender ID
filter[boardingType]	integer Filter the table results by Boarding Type of the Student
filter[form]	integer Filter the results by Form ID
filter[yearGroup]	integer Filter the results by YearGroup ID
	object or object or object or object or object or object or object or object Sort records by given sort field, e.g. sort[field]=asc

header Parameters

realm required	string Example: S999 Realm ID
academic-year-id	integer By default, the active year is used. Use this optional header to override

Responses

Response samples

Content type

application/json

[{"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
},
"current_admission": {"admission_year": {"id": 12,
"name": "2020/2021 Academic Year"
},
"admission_year_group": {"id": 51,
"name": "Year 2"
}
}
},
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
}
}
]

Houses: Get Houses Summary

Authorizations:

OAuth

query Parameters

filter[houseType]	string Enum: "academic" "boarding" Filter the results by the type of House
academicYearId	integer Integer ID of Academic Year

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 1,
"code": "GH",
"house_type": "both",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/house_image/36/123123.jpg"
}
],
"name": "Green House",
"summary": [{"year_group": {"id": 1,
"name": "Year 4",
"position": 1
},
"genders_count": [{"count": 4,
"gender": {"id": 1,
"name": "Male",
"position": 1,
"system_value": true
}
},
{"count": 6,
"gender": {"id": 2,
"name": "Female",
"position": 2,
"system_value": true
}
}
]
}
],
"system_profile_image": "red",
"is_active": true
}
]

Boarding Types: List

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

Education Types: List

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

School & College Categories: List

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

Schools & Colleges: List

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"destination": "St Hubbins Grammar School",
"education_type": {"id": 2,
"name": "International School",
"position": 1,
"deleted_at": null,
"system_value": true
},
"category": {"id": 2,
"name": "Feeder",
"position": 1,
"deleted_at": null,
"system_value": true
},
"address": null,
"position": 3,
"deleted_at": null
}
]

Relationship Groups: List

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 1,
"name": "Primary",
"rank": 1,
"position": 1,
"deleted_at": null
}
]

Relationship Types: List

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 5,
"name": "Guardian",
"position": 5,
"system_value": false,
"deleted_at": null,
"relationship_group": {"id": 1,
"name": "Primary",
"rank": 1,
"position": 1,
"deleted_at": null
}
}
]

Students: Get Students Past List

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset
search	string API Query Search
filter[gender]	integer Filter the results by gender ID
filter[destinationSchool]	integer Filter the table results by DestinationSchool ID

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 54,
"first_name": "Crystal",
"gender": {"id": 2,
"name": "Female"
},
"last_name": "McWhirter",
"middle_name": null,
"name_in_local_language": null,
"preferred_name": null,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/student_profile_image/36/123123.jpg"
}
],
"destination_details": {"leaving_status": "Leaver",
"leaving_date": "2019-08-24",
"term": {"id": 4,
"description": "Winter Term",
"date_start": "2019-11-15",
"date_end": "2019-12-28"
},
"academic_year": {"id": 6,
"date_start": "2020-09-01",
"date_end": "2021-08-31",
"description": "2020-21 Academic Year",
"terms": [{"id": 1,
"description": "Term 1"
},
{"id": 4,
"description": "Winter Term"
}
]
},
"destination_start_date": null,
"destination": {"id": 2,
"name": "New School",
"position": 1,
"deleted_at": null,
"system_value": true
},
"key_stage": "KS3"
},
"tag_summary": [{"id": 1,
"name": "A tag"
}
],
"has_global_note": false,
"person_type": "student",
"enrolment_status": "past",
"is_birthday": false
}
]

Students: Get List

Get a collection of Student records. Requires students.current.overview.name-details.read, students.current.overview.personal.read, students.past.read and students.admissions.admissions.read scopes for basic call, students.current.overview.name-details.read & students.current.overview.personal.read if filtering enrolmentStatus by 'current', and students.past.read or students.admissions.admissions.read if filtering by 'past' or 'applicant' respectively

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset
search	string API Query Search
filter[gender]	integer Filter the results by gender ID
filter[academicYear]	string Filter the table results by academic year ID
filter[boardingType]	integer Filter the table results by Boarding Type of the Student
filter[form]	integer Filter the results by Form ID
filter[yearGroup]	integer Filter the results by YearGroup ID
filter[enrolmentStatus]	string Filter the results by enrolment status
filter[house]	string Filter the students being within academic house or boarding house via house ID
filter[tutorGroup]	integer Filter the results by Tutor Group ID
	object or object or object or object or object or object or object or object Sort records by given sort field, e.g. sort[field]=asc

header Parameters

realm required	string Example: S999 Realm ID
academic-year-id	integer By default, the active year is used. Use this optional header to override

Responses

Response samples

Content type

application/json

[{"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
},
"current_admission": {"admission_year": {"id": 12,
"name": "2020/2021 Academic Year"
},
"admission_year_group": {"id": 51,
"name": "Year 2"
}
}
},
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
}
}
]

Get list of Address Mappings for a Student

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"mapping": {"id": 147,
"address_types": [{"id": 2,
"name": "Billing",
"position": 1,
"deleted_at": null,
"system_value": true
}
],
"position": 1,
"address": {"id": 123,
"country": {"id": 257,
"name": "UK"
},
"organization": "BBC News",
"address_line_1": "123 Sesame Street",
"address_line_2": "",
"locality": "North End",
"administrative_area": "Avon",
"postal_code": "BS4 EV4"
},
"formatted_address": "BBC News, 123 Sesame Street, North End, Avon, BS4 EV4",
"resident_since": "2019-08-24"
},
"colocated-students": {"colocated-students": [{"mapping_id": 123,
"student": {"id": 1,
"boarding_type": {"id": 1,
"name": "Non-Boarder"
},
"date_of_birth": "2018-01-19",
"first_name": "Chana Leah",
"gender": {"id": 3,
"name": "Female"
},
"last_login": null,
"last_name": "Abergel",
"middle_name": null,
"name_in_local_language": null,
"preferred_name": null,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/student_profile_image/36/123123.jpg"
}
],
"learning_support_summary": [ ],
"tag_summary": [ ],
"has_global_note": true,
"form": {"id": 6,
"name": "10 A",
"year_group": {"id": 5,
"name": "Year 10"
}
}
}
}
]
},
"colocated-contacts": {"colocated-contacts": [{"mapping_id": 124,
"contact": {"access_to_app": true,
"country_of_birth": 2,
"deleted_at": null,
"email": "oriya.cohen@mail.com",
"employer": "BBC England",
"ethnicity": 2,
"faith": 3,
"first_name": "Ted",
"gender": 1,
"id": 6,
"last_name": "tester04",
"middle_name": null,
"nationalities": [1,
3
],
"sage_account_ref": "SAGE12345",
"status": true,
"students": [{"contacts": [ ],
"date_of_birth": "2010-02-11",
"deleted_at": null,
"first_name": "Oriya",
"gender": {"deleted_at": null,
"id": 5,
"name": "Female",
"position": 1,
"system_value": true
},
"id": 23,
"last_login": null,
"last_name": "Cohen",
"learning_support_categories": [ ],
"form": {"id": 6,
"name": "10 A",
"year_group": {"id": 5,
"name": "Year 10"
}
}
}
],
"title": {"id": 17,
"name": "Mr"
},
"vip": true
}
}
]
}
}
]

Students: Get Student

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm required	string Example: S999 Realm ID
academic-year-id	integer By default, the active year is used. Use this optional header to override

Responses

Response samples

Content type

application/json

{"id": 56,
"access_status": "invited",
"multi_realm": false,
"academic_house": {"id": 1,
"name": "Green House"
},
"boarding_type": {"id": 1,
"name": "Full Time Boarder"
},
"boarding_house": {"id": 1,
"name": "Green House"
},
"country_of_birth": {"id": 22,
"name": "Barbados"
},
"date_of_birth": "2010-08-24",
"deleted_at": null,
"ethnicity": {"id": 8,
"name": "Other"
},
"enrolment_status": "current",
"external_id": "MX99328",
"faith": {"id": 1,
"name": "Christian"
},
"first_name": "Miles",
"gender": {"id": 1,
"name": "Male"
},
"has_global_note": false,
"form": {"id": 8,
"name": "Form 4",
"staff": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"section": {"id": 1,
"name": "Lower School"
},
"year_group": {"id": 1,
"name": "Year 4"
}
},
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/student_profile_image/36/123123.jpg"
}
],
"language_first": {"id": 1,
"name": "English"
},
"language_second": {"id": 13,
"name": "Farsi"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Whyde",
"learning_support_record_summary": [ ],
"middle_name": null,
"name_in_local_language": null,
"national_identity": null,
"nationalities": [{"id": 22,
"name": "British"
}
],
"person_type": "stduent",
"preferred_name": null,
"primary_email": "user@example.com",
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.doc",
"size": 306691,
"mime_type": "application/msword",
"purpose": "learning_support_record",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"tags": [{"id": 5,
"type": {"id": 4,
"name": "Attendance Issues",
"type": "text",
"color_option": 8
},
"text": "Often missing from morning roll call",
"number": null,
"date": "2019-08-24"
}
],
"medical_condition_severity": [{"id": 1,
"name": "High",
"position": 1
}
]
}

Get a list of related records/addresses for a student

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"address": {"id": 123,
"country": {"id": 257,
"name": "UK"
},
"organization": "BBC News",
"address_line_1": "123 Sesame Street",
"address_line_2": "",
"locality": "North End",
"administrative_area": "Avon",
"postal_code": "BS4 EV4"
},
"colocated-students": [{"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
],
"colocated-contacts": [{"access_status": "no_access",
"students_access": [{"relation_id": 34,
"access_to_student": true,
"student": {"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "Green House"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
}
],
"deleted_at": "2019-08-24T14:15:22Z",
"external_id": null,
"first_name": "Sarah",
"gender": {"id": 2,
"name": "Female"
},
"id": 37,
"last_name": "Shmyth",
"middle_name": null,
"primary_email": "user@example.com",
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.jpg",
"size": 306691,
"mime_type": "image/jpg",
"purpose": "contact_profile_image",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"status": "active",
"students": [{"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
],
"title": {"id": 5,
"name": "Miss"
},
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/contact_profile_image/36/123123.jpg"
}
]
}
]
}
]

Students: Get consent data by student Id

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"photograph": true,
"publish_photograph": true,
"publish_video": true,
"share_photograph": true,
"share_video": true,
"share_data": true,
"school_trip": true
}

Students: Get destination data by student Id

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"leaving_status": "Leaver",
"leaving_date": "2019-08-24",
"term": {"id": 4,
"description": "Winter Term",
"date_start": "2019-11-15",
"date_end": "2019-12-28"
},
"academic_year": {"id": 6,
"date_start": "2020-09-01",
"date_end": "2021-08-31",
"description": "2020-21 Academic Year",
"terms": [{"id": 1,
"description": "Term 1"
},
{"id": 4,
"description": "Winter Term"
}
]
},
"destination_start_date": null,
"destination": {"id": 2,
"name": "New School",
"position": 1,
"deleted_at": null,
"system_value": true
},
"key_stage": "KS3"
}

Students: Get enrolment data by student Id

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"enrolment_status": "current",
"start_date": "2017-08-24",
"account_reference": "OU812",
"candidate_number": "AA23",
"unique_pupil_number": "90210",
"unique_pupil_number_status": "temporary"
}

Students: Get Learning Support fields by student Id

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"authority": {"id": 7,
"name": "Aldershot Council"
},
"authority_type": {"id": 65,
"name": "Parish council"
},
"disability": false,
"disability_description": null,
"placement_date": "2019-08-24"
}

Learning Support: Get List of Learning Support Reviews by student Id

Requires either one of the listed scopes

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

query Parameters

	object or object or object or object or object or object Sort records by given sort field, e.g. sort[field]=asc
page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset
search	string API Query Search
filter[status]	integer Filter the results based on Record's 'Status' ID value
filter[reviewType]	integer Filter the results based on Record's Review Type ID value
filter[isStudentAttending]	boolean Filter the results based on Review's 'Is Student Attending' value

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 18,
"agreed_actions": "It was decided to monitor the situation and for another meeting to be held in 6 months' time.",
"attending_contacts": [{"access_status": "no_access",
"students_access": [{"relation_id": 1,
"access_to_student": true,
"student": {"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
}
],
"deleted_at": "2019-08-24T14:15:22Z",
"external_id": null,
"first_name": "Sarah",
"gender": {"id": 1,
"name": "Female"
},
"id": 10,
"last_name": "Uumelmahay",
"middle_name": null,
"primary_email": "user@example.com",
"profile_image": null,
"status": "active",
"students": [{"id": 0,
"access_status": "no_access",
"academic_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"country_of_birth": {"id": 1,
"name": "A non-null lookup value"
},
"date_of_birth": "2019-08-24",
"deleted_at": "2019-08-24T14:15:22Z",
"ethnicity": {"id": 1,
"name": "A string value"
},
"enrolment_status": "string",
"external_id": "string",
"faith": {"id": 1,
"name": "A string value"
},
"first_name": "string",
"gender": {"id": 1,
"name": "A string value"
},
"has_global_note": true,
"form": {"id": 0,
"name": "string",
"staff": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"section": {"id": 1,
"name": "A string value"
},
"year_group": {"id": 1,
"name": "A string value"
}
},
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"language_first": {"id": 1,
"name": "A non-null lookup value"
},
"language_second": {"id": 1,
"name": "A non-null lookup value"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "string",
"learning_support_record_summary": [{"id": 1,
"name": "A string value"
}
],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"middle_name": "string",
"name_in_local_language": "string",
"national_identity": "string",
"nationalities": [{"id": 1,
"name": "A string value"
}
],
"person_type": "string",
"preferred_name": "string",
"primary_email": "user@example.com",
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.doc",
"size": 306691,
"mime_type": "application/msword",
"purpose": "learning_support_record",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"tags": [{"id": 5,
"type": {"id": 4,
"name": "Attendance Issues",
"type": "text",
"color_option": 8
},
"text": "Often missing from morning roll call",
"number": null,
"date": "2019-08-24"
}
]
}
],
"title": {"id": 4,
"name": "Miss"
},
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
]
}
],
"attending_contact_text": "Also attending was the student's doctor, Dr Malthouse",
"attending_staff": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"is_student_attending": true,
"description": "Review of the student's use of tinted glasses to attempt to address issues.",
"ehcp_notes": "None",
"files": [{"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.doc",
"size": 306691,
"mime_type": "application/msword",
"purpose": "learning_support_record",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
}
],
"meeting_aims": "Recording of any observations on whether there is any change in the student's behaviour & learning outcomes",
"next_review": "2019-08-24T14:15:22Z",
"review_type": {"id": 1,
"name": "School action"
},
"review_date_time": "2019-04-24T14:15:22Z",
"special_needs_coordinators": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"review_status": {"id": 1,
"name": "active"
}
}
]

Learning Support: Get List of Learning Support Records by student Id

Requires either one of the listed scopes

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

query Parameters

	object or object or object or object or object or object or object Sort records by given sort field, e.g. sort[field]=asc
page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset
search	string API Query Search
filter[status]	integer Filter the results based on Record's 'Status' ID value
filter[ehcp]	boolean Filter the results based on boolean 'EHCP' value
filter[severity]	integer Filter the results based on Record's Severity ID value
filter[learningSupportType]	integer Filter the results based on Record's Learning Support Type ID value

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 15,
"description": "Mild ADHD",
"ehcp": true,
"ehcp_date": "2019-08-24",
"files": [{"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.doc",
"size": 306691,
"mime_type": "application/msword",
"purpose": "learning_support_record",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
}
],
"learning_support_date": "2019-08-24",
"learning_support_type": {"id": 2,
"name": "Moderate Learning Difficulty (MLD)"
},
"severity": {"id": 2,
"name": "Mild"
},
"status": {"id": 2,
"name": "active"
},
"student": {"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "Green House"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
},
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
}
},
"inactive_date": null
}
]

Students: Get doctor information by student Id

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"title": {"id": 5,
"name": "Dr"
},
"first_name": "Nicolas",
"last_name": "Van Helsing",
"email": null,
"phone": "0117 555 5555",
"address": "1234 Pleasant Crescent"
}

Students to Students Relations: Get list by student id

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"related_student": {"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
},
"relationship_type": {"id": 1,
"name": "Sister"
},
"inverse_relationship_type": {"id": 2,
"name": "Brother"
}
}
]

Student Contacts Relations: Get List

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 0,
"contact_student_relationship_type": {"id": 43,
"name": "Aunt"
},
"court_order": false,
"preference_billing": false,
"preference_emergency": true,
"preference_medical": true,
"relationship_group": {"id": 1,
"name": "Primary",
"rank": 1
},
"contact": {"id": 65,
"title": {"id": 5,
"name": "Professor"
},
"first_name": "Jane",
"middle_name": null,
"last_name": "Goodall",
"gender": {"id": 2,
"name": "Female"
},
"primary_email": null,
"primary_phone": null,
"status": "active",
"deleted_at": null
},
"student_contact_relationship_type": {"id": 43,
"name": "Nephew"
},
"access_to_student": true,
"student": {"id": 92,
"first_name": "Harry",
"middle_name": null,
"last_name": "Cooper"
}
}
]

Get a list of related records/addresses for a contact

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"address": {"id": 123,
"country": {"id": 257,
"name": "UK"
},
"organization": "BBC News",
"address_line_1": "123 Sesame Street",
"address_line_2": "",
"locality": "North End",
"administrative_area": "Avon",
"postal_code": "BS4 EV4"
},
"colocated-students": [{"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "Green House"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
]
}
]

Academic Structure

Endpoints related to the academic structure: years, lessons etc

Departments: Get list Deprecated

Get list of school Departments

path Parameters

academicYearId

required

integer

Integer ID of Academic Year

query Parameters

string

API Query Search

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 3,
"academic_year": {"id": 1,
"name": "2020/21 Academic Year"
},
"code": "SCI",
"department_heads": [{"section": {"id": 1,
"name": "Lower School"
},
"section_heads": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
]
}
],
"name": "Science",
"subjects": [{"id": 1,
"name": "Physics"
}
]
}
]

Departments: Get list

Get list of school Departments

path Parameters

academicYearId

required

integer

Integer ID of Academic Year

query Parameters

string

API Query Search

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 0,
"academic_year": {"id": 24,
"description": "2020-2021",
"date_start": "2020-09-01",
"date_end": "2021-08-31"
},
"code": "string",
"name": "string",
"subjects": [{"id": 1,
"name": "A string value"
}
],
"department_heads": [{"id": 137,
"first_name": "Bob",
"middle_name": null,
"name_in_local_language": null,
"last_name": "Bobbington",
"preferred_name": null,
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff",
"status": "current"
}
],
"position": 0
}
]

Departments: Get one Deprecated

Get a Department

Authorizations:

OAuth

path Parameters

academicYearId required	integer Integer ID of Academic Year
id required	integer Example: 1 Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"id": 3,
"academic_year": {"id": 1,
"name": "2020/21 Academic Year"
},
"code": "SCI",
"department_heads": [{"section": {"id": 1,
"name": "Lower School"
},
"section_heads": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
]
}
],
"name": "Science",
"subjects": [{"id": 1,
"name": "Physics"
}
]
}

Departments: Get one

Get a Department

Authorizations:

OAuth

path Parameters

academicYearId required	integer Integer ID of Academic Year
id required	integer Example: 1 Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"id": 0,
"academic_year": {"id": 24,
"description": "2020-2021",
"date_start": "2020-09-01",
"date_end": "2021-08-31"
},
"code": "string",
"department_heads": [{"section": {"id": 1,
"name": "A string value"
},
"section_heads": [{"id": 137,
"first_name": "Bob",
"middle_name": null,
"name_in_local_language": null,
"last_name": "Bobbington",
"preferred_name": null,
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff",
"status": "current",
"job_title": "Teacher",
"sections": [{"id": 1,
"name": "A string value"
}
],
"departments": [{"id": 1,
"name": "A string value"
}
],
"subjects": [{"id": 1,
"name": "A string value"
}
],
"positions": [{"id": 1,
"name": "A string value"
}
],
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"gender": {"id": 1,
"name": "A non-null lookup value"
}
}
]
}
],
"name": "string",
"subjects": [{"id": 1,
"name": "A string value"
}
],
"can_copy": true
}

Extra Curricular Activity: Get list for an Academic Year

Get list of Extra Curricular Activities in an Academic Year

Authorizations:

OAuth

path Parameters

academicYearId

required

integer

Integer ID of Academic Year

query Parameters

filter[yearGroup]	integer Filter the results by YearGroup ID
search	string API Query Search

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"academic_year": {"id": 1,
"name": "2020-21 Academic Year"
},
"code": "ORCH",
"max_students": 40,
"name": "Orchestra",
"rooms": [{"id": 14,
"room_code": "Music Studio 2"
}
],
"short_description": "School Orchestra",
"staff": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"staff_report_writers": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"student_count": 30,
"timetable_code": "Orch",
"id": 54,
"date_start": "2019-01-24",
"date_end": "2019-11-24",
"year_groups": [ ]
}
]

Extra Curricular Activity: Get one in an Academic Year

Get an Extra Curricular Activity in an Academic Year

Authorizations:

OAuth

path Parameters

academicYearId required	integer Integer ID of Academic Year
id required	integer Example: 1 Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"academic_year": {"id": 1,
"name": "2020-21 Academic Year"
},
"code": "ORCH",
"max_students": 40,
"name": "Orchestra",
"rooms": [{"id": 14,
"room_code": "Music Studio 2"
}
],
"short_description": "School Orchestra",
"staff": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"staff_report_writers": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"student_count": 30,
"timetable_code": "Orch",
"id": 54,
"date_start": "2019-01-24",
"date_end": "2019-11-24",
"year_groups": [ ]
}

Form Group: Get list for Academic Year

Get list of School Forms in an Academic Year

Authorizations:

OAuth

path Parameters

academicYearId

required

integer

Integer ID of Academic Year

query Parameters

filter[yearGroup]	integer Filter the results by YearGroup ID
filter[section]	integer Filter the results by Section ID
	object or object Sort records by given sort field, e.g. sort[field]=asc
search	string API Query Search

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"academic_year": {"id": 1,
"name": "2020-21 Academic Year"
},
"code": "9A",
"max_students": 40,
"name": "Form 9A",
"rooms": [{"id": 12,
"room_code": "Upper 44"
}
],
"short_description": "Year 9 form group A",
"staff": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"staff_report_writers": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"student_count": 30,
"timetable_code": "9A",
"id": 93,
"section": {"id": 2,
"name": "Middle school"
},
"year_group": {"id": 6,
"name": "Year 9"
},
"student_representatives": [{"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
]
}
]

Form Group: Get one in an Academic Year

Get a School Form in an Academic Year

Authorizations:

OAuth

path Parameters

academicYearId required	integer Integer ID of Academic Year
id required	integer Example: 1 Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"academic_year": {"id": 1,
"name": "2020-21 Academic Year"
},
"code": "9A",
"max_students": 40,
"name": "Form 9A",
"rooms": [{"id": 12,
"room_code": "Upper 44"
}
],
"short_description": "Year 9 form group A",
"staff": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"staff_report_writers": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"student_count": 30,
"timetable_code": "9A",
"id": 93,
"section": {"id": 2,
"name": "Middle school"
},
"year_group": {"id": 6,
"name": "Year 9"
},
"student_representatives": [{"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
]
}

Form Group: Get list of Students

List Students for Form Group

Authorizations:

OAuth

path Parameters

academicYearId required	integer Integer ID of Academic Year
id required	integer Example: 1 Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
},
"current_admission": {"admission_year": {"id": 12,
"name": "2020/2021 Academic Year"
},
"admission_year_group": {"id": 51,
"name": "Year 2"
}
}
},
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
}
}
]

Sections: Get list Deprecated

Get list of School Sections

Authorizations:

OAuth

query Parameters

	object Sort records by given sort field, e.g. sort[field]=asc
filter[groupType]	string Enum: "form" "subject_set" "tutor_group" "year_group" Filter the results by group type, applied only for `owner/teacher` permissions
assessmentCreation	boolean Parameter used to enable in api v1 assessment creation functionality

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 5,
"code": "MS",
"name": "Middle School",
"section_heads": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"year_groups": [{"id": 1,
"name": "Year 10"
}
],
"position": 1
}
]

Sections: Get list

Get list of School Sections

Authorizations:

OAuth

query Parameters

	object Sort records by given sort field, e.g. sort[field]=asc
filter[groupType]	string Enum: "form" "subject_set" "tutor_group" "year_group" Filter the results by group type, applied only for `owner/teacher` permissions
assessmentCreation	boolean Parameter used to enable in api v1 assessment creation functionality

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 0,
"code": "string",
"name": "string",
"section_heads": [{"id": 137,
"first_name": "Bob",
"middle_name": null,
"name_in_local_language": null,
"last_name": "Bobbington",
"preferred_name": null,
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff",
"status": "current"
}
],
"position": 0
}
]

Sections: Get one Deprecated

Get a School Section

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"id": 5,
"code": "MS",
"name": "Middle School",
"section_heads": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"year_groups": [{"id": 1,
"name": "Year 10"
}
],
"position": 1
}

Subjects: Get list Deprecated

Get list of school Subjects

path Parameters

academicYearId

required

integer

Integer ID of Academic Year

query Parameters

filter[department]	integer Filter the results by Department ID
filter[section]	integer Filter the results by Section ID

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 7,
"code": "CH",
"department": {"id": 1,
"name": "Science"
},
"name": "Chemistry",
"color_option": 7,
"subject_heads": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
]
}
]

Subjects: Get list

Get list of school Subjects

path Parameters

academicYearId

required

integer

Integer ID of Academic Year

query Parameters

filter[department]	integer Filter the results by Department ID
filter[section]	integer Filter the results by Section ID

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 33,
"code": "MATH",
"color_option": 1,
"department": {"id": 1,
"name": "Maths Department"
},
"name": "Maths",
"subject_heads": [{"id": 137,
"first_name": "Bob",
"middle_name": null,
"name_in_local_language": null,
"last_name": "Bobbington",
"preferred_name": null,
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff",
"status": "current"
}
]
}
]

Subjects: Get one Deprecated

Get a Subject

Authorizations:

OAuth

path Parameters

academicYearId required	integer Integer ID of Academic Year
id required	integer Example: 1 Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"id": 88,
"academic_year": {"id": 1,
"name": "2020/21 Academic Year"
},
"alternative_name": "Life Science",
"code": "BY",
"color_option": 3,
"department": {"id": 1,
"name": "Science"
},
"name": "Biology",
"subject_heads": [{"section": {"id": 1,
"name": "Lower School"
},
"section_heads": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
]
}
]
}

Subjects: Get one

Get a Subject

Authorizations:

OAuth

path Parameters

academicYearId required	integer Integer ID of Academic Year
id required	integer Example: 1 Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"id": 33,
"academic_year": {"id": 1,
"description": "2021-22 Academic Year"
},
"alternative_name": null,
"code": "MATH",
"department": {"id": 1,
"name": "Maths Department"
},
"name": "Maths",
"can_copy": false,
"subject_heads": [{"section": {"id": 1,
"name": "Whole School"
},
"section_heads": [{"id": 137,
"first_name": "Bob",
"middle_name": null,
"name_in_local_language": null,
"last_name": "Bobbington",
"preferred_name": null,
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff",
"status": "current",
"job_title": "Teacher",
"sections": [{"id": 1,
"name": "Whole School"
}
],
"departments": [{"id": 1,
"name": "Maths Department"
}
],
"subjects": [{"id": 2,
"name": "History"
}
],
"positions": [{"id": 654,
"name": "Some name"
}
],
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"gender": {"id": 2,
"name": "Male"
}
}
]
}
]
}

Subject Sets: Get list for an Academic Year Deprecated

Get list of Subject Sets in an Academic Year

Authorizations:

OAuth

path Parameters

academicYearId

required

integer

Integer ID of Academic Year

query Parameters

filter[yearGroup]	integer Filter the results by YearGroup ID
filter[section]	integer Filter the results by Section ID
filter[subject]	integer Filter the results by Subject ID
	object or object Sort records by given sort field, e.g. sort[field]=asc
search	string API Query Search
assessmentCreation	boolean Parameter used to enable in api v1 assessment creation functionality

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"academic_year": {"id": 1,
"name": "2020-21 Academic Year"
},
"code": "ENG9A",
"max_students": 40,
"name": "English 9A",
"rooms": [{"id": 13,
"room_code": "L12"
}
],
"short_description": "English class year 9 group A",
"staff": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"staff_report_writers": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"student_count": 30,
"timetable_code": "9AEng",
"id": 25,
"credit_score": 12,
"date_start": "2019-04-24",
"date_end": "2019-09-24",
"qualification": {"id": 1,
"name": "GCSE"
},
"section": {"id": 2,
"name": "Middle school"
},
"subject": {"id": 21,
"name": "English"
},
"year_group": {"id": 6,
"name": "Year 9"
}
}
]

Get list of Subject Sets in an Academic Year

Requirements covered in HUB-10619

path Parameters

academicYearId

required

integer

Integer ID of Academic Year

query Parameters

assessmentCreation	boolean Parameter used to enable in api v1 assessment creation functionality
filter[section]	integer Filter the results by Section ID
filter[subject]	integer Filter the results by Subject ID
filter[yearGroup]	integer Filter the results by YearGroup ID
page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset
search	string API Query Search
	Code (object) or Credit Score (object) or Max Students (object) or Name (object) or Section (object) or StudentCount (object) or Subject (object) or Year Group (object) Sort records by given sort field, e.g. sort[field]=asc

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"type": "subject_set",
"code": "XYZ",
"max_students": 100,
"name": "Future FR",
"rooms": [{"id": 654,
"code": "YR7"
}
],
"staff": [{"id": 137,
"first_name": "Bob",
"middle_name": null,
"name_in_local_language": null,
"last_name": "Johnson",
"preferred_name": null,
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff",
"status": "current"
}
],
"student_count": 100,
"id": 1,
"credit_score": 25.75,
"section": {"id": 654,
"name": "Senior school"
},
"subject": {"id": 14,
"name": "Geography"
},
"year_group": {"id": 7,
"name": "Year 9"
}
}
]

Subject Sets: Get one in an Academic Year

Get a Subject Set in an Academic Year

Authorizations:

OAuth

path Parameters

academicYearId required	integer Integer ID of Academic Year
id required	integer Example: 1 Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"academic_year": {"id": 1,
"name": "2020-21 Academic Year"
},
"code": "ENG9A",
"max_students": 40,
"name": "English 9A",
"rooms": [{"id": 13,
"room_code": "L12"
}
],
"short_description": "English class year 9 group A",
"staff": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"staff_report_writers": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"student_count": 30,
"timetable_code": "9AEng",
"id": 25,
"credit_score": 12,
"date_start": "2019-04-24",
"date_end": "2019-09-24",
"qualification": {"id": 1,
"name": "GCSE"
},
"section": {"id": 2,
"name": "Middle school"
},
"subject": {"id": 21,
"name": "English"
},
"year_group": {"id": 6,
"name": "Year 9"
}
}

Subject Sets: Get list of Students for a Subject Set

List Students for Subject Set

Authorizations:

OAuth

path Parameters

academicYearId required	integer Integer ID of Academic Year
id required	integer Example: 1 Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
},
"current_admission": {"admission_year": {"id": 12,
"name": "2020/2021 Academic Year"
},
"admission_year_group": {"id": 51,
"name": "Year 2"
}
}
},
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"other_sets_within_subject": [{"id": 1,
"name": "A string value"
}
]
}
]

Tutor Groups: Get list for an Academic Year

Get list of Tutor Groups in an Academic Year

Authorizations:

OAuth

path Parameters

academicYearId

required

integer

Integer ID of Academic Year

query Parameters

filter[section]	integer Filter the results by Section ID
	object Sort records by given sort field, e.g. sort[field]=asc
search	string API Query Search

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"academic_year": {"id": 1,
"name": "2020-21 Academic Year"
},
"code": "TG09X",
"max_students": 40,
"name": "Year 9 Tutor Group X",
"rooms": [{"id": 4,
"room_code": "Lobby Lounge"
}
],
"short_description": "Year 9 Tutor Group X",
"staff": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"staff_report_writers": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"student_count": 10,
"timetable_code": "TG9X",
"id": 98,
"section": {"id": 2,
"name": "Middle school"
}
}
]

Tutor Groups: Get one in an Academic Year

Get a Tutor Group in an Academic Year

Authorizations:

OAuth

path Parameters

academicYearId required	integer Integer ID of Academic Year
id required	integer Example: 1 Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"academic_year": {"id": 1,
"name": "2020-21 Academic Year"
},
"code": "TG09X",
"max_students": 40,
"name": "Year 9 Tutor Group X",
"rooms": [{"id": 4,
"room_code": "Lobby Lounge"
}
],
"short_description": "Year 9 Tutor Group X",
"staff": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"staff_report_writers": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"student_count": 10,
"timetable_code": "TG9X",
"id": 98,
"section": {"id": 2,
"name": "Middle school"
}
}

Tutor Groups: Get list of Students in a Tutor Group

List Students for Tutor Group

Authorizations:

OAuth

path Parameters

academicYearId required	integer Integer ID of Academic Year
id required	integer Example: 1 Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
},
"current_admission": {"admission_year": {"id": 12,
"name": "2020/2021 Academic Year"
},
"admission_year_group": {"id": 51,
"name": "Year 2"
}
}
},
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"tutor_group": {"class_type": "tutor_group",
"code": "TG09A",
"max_students": 40,
"name": "Year 9 Tutor Group A",
"rooms": [{"id": 22,
"room_code": "Upper 10"
}
],
"staff": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"student_count": 10,
"id": 10,
"section": {"id": 2,
"name": "Middle school"
}
}
}
]

Year Groups: Get list for an Academic Year

Get list of school Year Groups for this Academic Year

path Parameters

academicYearId

required

integer

Integer ID of Academic Year

query Parameters

	object or object Sort records by given sort field, e.g. sort[field]=asc
filter[section]	integer Filter the results by Section ID
assessmentCreation	boolean Parameter used to enable in api v1 assessment creation functionality

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 8,
"academic_year": {"id": 1,
"name": "2020-21 Academic Year"
},
"code": "Y9",
"dfe_year": "1",
"final_year": false,
"form_count": 4,
"key_stage": "KS5",
"max_students": 500,
"name": "Year 9",
"position": 5,
"section": {"id": 1,
"name": "Middle School",
"position": 3
},
"status": "active",
"total_student_count": 400,
"uuid": "28db8526-dc32-4d18-9093-cde010d15b0b",
"year_group_heads": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
]
}
]

Year Groups: Get one in an Academic Year

Get a Year Group in an Academic Year

Authorizations:

OAuth

path Parameters

academicYearId required	integer Integer ID of Academic Year
id required	integer Example: 1 Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"id": 8,
"academic_year": {"id": 1,
"name": "2020-21 Academic Year"
},
"code": "Y9",
"dfe_year": "1",
"final_year": false,
"form_count": 4,
"key_stage": "KS5",
"max_students": 500,
"name": "Year 9",
"position": 5,
"section": {"id": 1,
"name": "Middle School",
"position": 3
},
"status": "active",
"total_student_count": 400,
"uuid": "28db8526-dc32-4d18-9093-cde010d15b0b",
"year_group_heads": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
]
}

Fetch Academic Structure Data For Staff

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"class_type": "eca",
"code": "ORCH",
"max_students": 50,
"name": "Orchestra",
"rooms": [{"id": 88,
"room_code": "Music Suite"
}
],
"staff": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"student_count": 22,
"id": 353,
"year_groups": [ ]
}
]

Fetch Academic Leadership Data For Staff

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 5,
"code": "MS",
"name": "Middle School",
"section_heads": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"year_groups": [{"id": 1,
"name": "Year 10"
}
],
"position": 1
}
]

Fetch classes for which the staff member is a leader of

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"academic_year": {"id": 1,
"name": "2020-21 Academic Year"
},
"code": "ORCH",
"max_students": 40,
"name": "Orchestra",
"rooms": [{"id": 14,
"room_code": "Music Studio 2"
}
],
"short_description": "School Orchestra",
"staff": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"staff_report_writers": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"student_count": 30,
"timetable_code": "Orch",
"id": 54,
"date_start": "2019-01-24",
"date_end": "2019-11-24",
"year_groups": [ ]
}
]

Student: Fetch Academic Structure Data For Students

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"class_type": "eca",
"code": "ORCH",
"max_students": 50,
"name": "Orchestra",
"rooms": [{"id": 88,
"room_code": "Music Suite"
}
],
"staff": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"student_count": 22,
"id": 353,
"year_groups": [ ]
}
]

Address

Management of addresses

Get list of Address Mappings for a Staff

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 147,
"address_types": [{"id": 2,
"name": "Billing",
"position": 1,
"deleted_at": null,
"system_value": true
}
],
"position": 1,
"address": {"id": 123,
"country": {"id": 257,
"name": "UK"
},
"organization": "BBC News",
"address_line_1": "123 Sesame Street",
"address_line_2": "",
"locality": "North End",
"administrative_area": "Avon",
"postal_code": "BS4 EV4"
},
"formatted_address": "BBC News, 123 Sesame Street, North End, Avon, BS4 EV4"
}
]

Get one Address Mapping for a staff member

Authorizations:

OAuth

path Parameters

id required	integer Example: 1 Integer ID of record
mappingId required	integer Represents the ID of an address mapping

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"id": 147,
"address_types": [{"id": 2,
"name": "Billing",
"position": 1,
"deleted_at": null,
"system_value": true
}
],
"position": 1,
"address": {"id": 123,
"country": {"id": 257,
"name": "UK"
},
"organization": "BBC News",
"address_line_1": "123 Sesame Street",
"address_line_2": "",
"locality": "North End",
"administrative_area": "Avon",
"postal_code": "BS4 EV4"
},
"formatted_address": "BBC News, 123 Sesame Street, North End, Avon, BS4 EV4"
}

Get list of Address Mappings for a Student

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"mapping": {"id": 147,
"address_types": [{"id": 2,
"name": "Billing",
"position": 1,
"deleted_at": null,
"system_value": true
}
],
"position": 1,
"address": {"id": 123,
"country": {"id": 257,
"name": "UK"
},
"organization": "BBC News",
"address_line_1": "123 Sesame Street",
"address_line_2": "",
"locality": "North End",
"administrative_area": "Avon",
"postal_code": "BS4 EV4"
},
"formatted_address": "BBC News, 123 Sesame Street, North End, Avon, BS4 EV4",
"resident_since": "2019-08-24"
},
"colocated-students": {"colocated-students": [{"mapping_id": 123,
"student": {"id": 1,
"boarding_type": {"id": 1,
"name": "Non-Boarder"
},
"date_of_birth": "2018-01-19",
"first_name": "Chana Leah",
"gender": {"id": 3,
"name": "Female"
},
"last_login": null,
"last_name": "Abergel",
"middle_name": null,
"name_in_local_language": null,
"preferred_name": null,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/student_profile_image/36/123123.jpg"
}
],
"learning_support_summary": [ ],
"tag_summary": [ ],
"has_global_note": true,
"form": {"id": 6,
"name": "10 A",
"year_group": {"id": 5,
"name": "Year 10"
}
}
}
}
]
},
"colocated-contacts": {"colocated-contacts": [{"mapping_id": 124,
"contact": {"access_to_app": true,
"country_of_birth": 2,
"deleted_at": null,
"email": "oriya.cohen@mail.com",
"employer": "BBC England",
"ethnicity": 2,
"faith": 3,
"first_name": "Ted",
"gender": 1,
"id": 6,
"last_name": "tester04",
"middle_name": null,
"nationalities": [1,
3
],
"sage_account_ref": "SAGE12345",
"status": true,
"students": [{"contacts": [ ],
"date_of_birth": "2010-02-11",
"deleted_at": null,
"first_name": "Oriya",
"gender": {"deleted_at": null,
"id": 5,
"name": "Female",
"position": 1,
"system_value": true
},
"id": 23,
"last_login": null,
"last_name": "Cohen",
"learning_support_categories": [ ],
"form": {"id": 6,
"name": "10 A",
"year_group": {"id": 5,
"name": "Year 10"
}
}
}
],
"title": {"id": 17,
"name": "Mr"
},
"vip": true
}
}
]
}
}
]

Get a list of related records/addresses for a student

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"address": {"id": 123,
"country": {"id": 257,
"name": "UK"
},
"organization": "BBC News",
"address_line_1": "123 Sesame Street",
"address_line_2": "",
"locality": "North End",
"administrative_area": "Avon",
"postal_code": "BS4 EV4"
},
"colocated-students": [{"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
],
"colocated-contacts": [{"access_status": "no_access",
"students_access": [{"relation_id": 34,
"access_to_student": true,
"student": {"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "Green House"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
}
],
"deleted_at": "2019-08-24T14:15:22Z",
"external_id": null,
"first_name": "Sarah",
"gender": {"id": 2,
"name": "Female"
},
"id": 37,
"last_name": "Shmyth",
"middle_name": null,
"primary_email": "user@example.com",
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.jpg",
"size": 306691,
"mime_type": "image/jpg",
"purpose": "contact_profile_image",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"status": "active",
"students": [{"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
],
"title": {"id": 5,
"name": "Miss"
},
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/contact_profile_image/36/123123.jpg"
}
]
}
]
}
]

Get a list of related records/addresses for a contact

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"address": {"id": 123,
"country": {"id": 257,
"name": "UK"
},
"organization": "BBC News",
"address_line_1": "123 Sesame Street",
"address_line_2": "",
"locality": "North End",
"administrative_area": "Avon",
"postal_code": "BS4 EV4"
},
"colocated-students": [{"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "Green House"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
]
}
]

Learning Support

Learning Support module - available as an extra purchase.

Learning Support Records: List

Authorizations:

OAuth

query Parameters

filter[yearGroup]	integer Filter the results by YearGroup ID
search	string API Query Search
	object or object or object or object or object or object or object Sort records by given sort field, e.g. sort[field]=asc
page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 15,
"description": "Mild ADHD",
"ehcp": true,
"ehcp_date": "2019-08-24",
"files": [{"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.doc",
"size": 306691,
"mime_type": "application/msword",
"purpose": "learning_support_record",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
}
],
"learning_support_date": "2019-08-24",
"learning_support_type": {"id": 2,
"name": "Moderate Learning Difficulty (MLD)"
},
"severity": {"id": 2,
"name": "Mild"
},
"status": {"id": 2,
"name": "active"
},
"student": {"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "Green House"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
},
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
}
},
"inactive_date": null
}
]

LearningSupport Record: Get

Either of the listed scopes is required

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"id": 15,
"description": "Mild ADHD",
"ehcp": true,
"ehcp_date": "2019-08-24",
"files": [{"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.doc",
"size": 306691,
"mime_type": "application/msword",
"purpose": "learning_support_record",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
}
],
"learning_support_date": "2019-08-24",
"learning_support_type": {"id": 2,
"name": "Moderate Learning Difficulty (MLD)"
},
"severity": {"id": 2,
"name": "Mild"
},
"status": {"id": 2,
"name": "active"
},
"student": {"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "Green House"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
},
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
}
},
"inactive_date": null
}

Learning Support Records: Get a list of Record statuses

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

Learning Support Severities: List

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

Learning Support Types: List

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

Learning Support Review Types: List

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

Learning Support: Get Learning Support Review by Id

Either of the listed scopes is required

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"id": 18,
"agreed_actions": "It was decided to monitor the situation and for another meeting to be held in 6 months' time.",
"attending_contacts": [{"access_status": "no_access",
"students_access": [{"relation_id": 1,
"access_to_student": true,
"student": {"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
}
],
"deleted_at": "2019-08-24T14:15:22Z",
"external_id": null,
"first_name": "Sarah",
"gender": {"id": 1,
"name": "Female"
},
"id": 10,
"last_name": "Uumelmahay",
"middle_name": null,
"primary_email": "user@example.com",
"profile_image": null,
"status": "active",
"students": [{"id": 0,
"access_status": "no_access",
"academic_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"country_of_birth": {"id": 1,
"name": "A non-null lookup value"
},
"date_of_birth": "2019-08-24",
"deleted_at": "2019-08-24T14:15:22Z",
"ethnicity": {"id": 1,
"name": "A string value"
},
"enrolment_status": "string",
"external_id": "string",
"faith": {"id": 1,
"name": "A string value"
},
"first_name": "string",
"gender": {"id": 1,
"name": "A string value"
},
"has_global_note": true,
"form": {"id": 0,
"name": "string",
"staff": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"section": {"id": 1,
"name": "A string value"
},
"year_group": {"id": 1,
"name": "A string value"
}
},
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"language_first": {"id": 1,
"name": "A non-null lookup value"
},
"language_second": {"id": 1,
"name": "A non-null lookup value"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "string",
"learning_support_record_summary": [{"id": 1,
"name": "A string value"
}
],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"middle_name": "string",
"name_in_local_language": "string",
"national_identity": "string",
"nationalities": [{"id": 1,
"name": "A string value"
}
],
"person_type": "string",
"preferred_name": "string",
"primary_email": "user@example.com",
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.doc",
"size": 306691,
"mime_type": "application/msword",
"purpose": "learning_support_record",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"tags": [{"id": 5,
"type": {"id": 4,
"name": "Attendance Issues",
"type": "text",
"color_option": 8
},
"text": "Often missing from morning roll call",
"number": null,
"date": "2019-08-24"
}
]
}
],
"title": {"id": 4,
"name": "Miss"
},
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
]
}
],
"attending_contact_text": "Also attending was the student's doctor, Dr Malthouse",
"attending_staff": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"is_student_attending": true,
"description": "Review of the student's use of tinted glasses to attempt to address issues.",
"ehcp_notes": "None",
"files": [{"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.doc",
"size": 306691,
"mime_type": "application/msword",
"purpose": "learning_support_record",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
}
],
"meeting_aims": "Recording of any observations on whether there is any change in the student's behaviour & learning outcomes",
"next_review": "2019-08-24T14:15:22Z",
"review_type": {"id": 1,
"name": "School action"
},
"review_date_time": "2019-04-24T14:15:22Z",
"special_needs_coordinators": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"review_status": {"id": 1,
"name": "active"
}
}

Learning Support terminology - terms selected that describes Learning Support for current school

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 1,
"name": "A string value"
}
]

Students: Get Learning Support fields by student Id

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"authority": {"id": 7,
"name": "Aldershot Council"
},
"authority_type": {"id": 65,
"name": "Parish council"
},
"disability": false,
"disability_description": null,
"placement_date": "2019-08-24"
}

Learning Support: Get List of Learning Support Reviews by student Id

Requires either one of the listed scopes

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

query Parameters

	object or object or object or object or object or object Sort records by given sort field, e.g. sort[field]=asc
page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset
search	string API Query Search
filter[status]	integer Filter the results based on Record's 'Status' ID value
filter[reviewType]	integer Filter the results based on Record's Review Type ID value
filter[isStudentAttending]	boolean Filter the results based on Review's 'Is Student Attending' value

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 18,
"agreed_actions": "It was decided to monitor the situation and for another meeting to be held in 6 months' time.",
"attending_contacts": [{"access_status": "no_access",
"students_access": [{"relation_id": 1,
"access_to_student": true,
"student": {"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
}
],
"deleted_at": "2019-08-24T14:15:22Z",
"external_id": null,
"first_name": "Sarah",
"gender": {"id": 1,
"name": "Female"
},
"id": 10,
"last_name": "Uumelmahay",
"middle_name": null,
"primary_email": "user@example.com",
"profile_image": null,
"status": "active",
"students": [{"id": 0,
"access_status": "no_access",
"academic_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"country_of_birth": {"id": 1,
"name": "A non-null lookup value"
},
"date_of_birth": "2019-08-24",
"deleted_at": "2019-08-24T14:15:22Z",
"ethnicity": {"id": 1,
"name": "A string value"
},
"enrolment_status": "string",
"external_id": "string",
"faith": {"id": 1,
"name": "A string value"
},
"first_name": "string",
"gender": {"id": 1,
"name": "A string value"
},
"has_global_note": true,
"form": {"id": 0,
"name": "string",
"staff": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"section": {"id": 1,
"name": "A string value"
},
"year_group": {"id": 1,
"name": "A string value"
}
},
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"language_first": {"id": 1,
"name": "A non-null lookup value"
},
"language_second": {"id": 1,
"name": "A non-null lookup value"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "string",
"learning_support_record_summary": [{"id": 1,
"name": "A string value"
}
],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"middle_name": "string",
"name_in_local_language": "string",
"national_identity": "string",
"nationalities": [{"id": 1,
"name": "A string value"
}
],
"person_type": "string",
"preferred_name": "string",
"primary_email": "user@example.com",
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.doc",
"size": 306691,
"mime_type": "application/msword",
"purpose": "learning_support_record",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"tags": [{"id": 5,
"type": {"id": 4,
"name": "Attendance Issues",
"type": "text",
"color_option": 8
},
"text": "Often missing from morning roll call",
"number": null,
"date": "2019-08-24"
}
]
}
],
"title": {"id": 4,
"name": "Miss"
},
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
]
}
],
"attending_contact_text": "Also attending was the student's doctor, Dr Malthouse",
"attending_staff": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"is_student_attending": true,
"description": "Review of the student's use of tinted glasses to attempt to address issues.",
"ehcp_notes": "None",
"files": [{"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.doc",
"size": 306691,
"mime_type": "application/msword",
"purpose": "learning_support_record",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
}
],
"meeting_aims": "Recording of any observations on whether there is any change in the student's behaviour & learning outcomes",
"next_review": "2019-08-24T14:15:22Z",
"review_type": {"id": 1,
"name": "School action"
},
"review_date_time": "2019-04-24T14:15:22Z",
"special_needs_coordinators": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"review_status": {"id": 1,
"name": "active"
}
}
]

Learning Support: Get List of Learning Support Records by student Id

Requires either one of the listed scopes

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

query Parameters

	object or object or object or object or object or object or object Sort records by given sort field, e.g. sort[field]=asc
page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset
search	string API Query Search
filter[status]	integer Filter the results based on Record's 'Status' ID value
filter[ehcp]	boolean Filter the results based on boolean 'EHCP' value
filter[severity]	integer Filter the results based on Record's Severity ID value
filter[learningSupportType]	integer Filter the results based on Record's Learning Support Type ID value

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 15,
"description": "Mild ADHD",
"ehcp": true,
"ehcp_date": "2019-08-24",
"files": [{"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.doc",
"size": 306691,
"mime_type": "application/msword",
"purpose": "learning_support_record",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
}
],
"learning_support_date": "2019-08-24",
"learning_support_type": {"id": 2,
"name": "Moderate Learning Difficulty (MLD)"
},
"severity": {"id": 2,
"name": "Mild"
},
"status": {"id": 2,
"name": "active"
},
"student": {"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "Green House"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
},
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
}
},
"inactive_date": null
}
]

Staff

Staff module - Contains services that pertain to Staff Profile data.

Staff: Get List

Get a collection of Staff records. Requires staff.current.overview.name-details.read, staff.past.read scopes for basic call, or each individual scope if filtering by status = 'current' or 'past' respectively

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset
search	string API Query Search
filter[department]	integer Filter the results by Department ID
filter[section]	integer Filter the results by Section ID
filter[status]	integer Filter the table results by Status ID
filter[subject]	integer Filter the results by Subject ID
filter[form]	integer Filter the results by Form ID
filter[subjectSet]	integer Filter the results by Subject Set ID
filter[tutorGroup]	integer Filter the results by Tutor Group ID
filter[yearGroup]	integer Filter the results by YearGroup ID
filter[gender]	integer Filter the results by gender ID
	object or object or object or object Sort records by given sort field, e.g. sort[field]=asc
assessmentCreation	boolean Parameter used to enable in api v1 assessment creation functionality

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
},
"report_writer": false
}
]

Staff: Get One Staff

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"access_status": "invited",
"multi_realm": false,
"academic_houses": [{"id": 1,
"name": "Green House"
}
],
"boarding_houses": [{"id": 1,
"name": "Green House"
}
],
"departments": [{"id": 4,
"name": "Drama"
}
],
"email": "user@example.com",
"external_id": "ST5466X",
"first_name": "Benjamin",
"forms": [{"id": 10,
"name": "Standard 9"
}
],
"gender": {"id": 1,
"name": "Male"
},
"id": 12,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Head of Drama",
"last_name": "Kakistos",
"middle_name": null,
"person_type": "staff",
"preferred_name": "Ben",
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.jpg",
"size": 306691,
"mime_type": "image/jpg",
"purpose": "staff_profile_image",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"roles": [{"id": 4,
"name": "Teacher"
}
],
"rooms": [ ],
"sections": [{"id": 2,
"name": "Upper School"
}
],
"status": "current",
"title": {"id": 1,
"name": "Mr"
}
}

Get list of Address Mappings for a Staff

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 147,
"address_types": [{"id": 2,
"name": "Billing",
"position": 1,
"deleted_at": null,
"system_value": true
}
],
"position": 1,
"address": {"id": 123,
"country": {"id": 257,
"name": "UK"
},
"organization": "BBC News",
"address_line_1": "123 Sesame Street",
"address_line_2": "",
"locality": "North End",
"administrative_area": "Avon",
"postal_code": "BS4 EV4"
},
"formatted_address": "BBC News, 123 Sesame Street, North End, Avon, BS4 EV4"
}
]

Get one Address Mapping for a staff member

Authorizations:

OAuth

path Parameters

id required	integer Example: 1 Integer ID of record
mappingId required	integer Represents the ID of an address mapping

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"id": 147,
"address_types": [{"id": 2,
"name": "Billing",
"position": 1,
"deleted_at": null,
"system_value": true
}
],
"position": 1,
"address": {"id": 123,
"country": {"id": 257,
"name": "UK"
},
"organization": "BBC News",
"address_line_1": "123 Sesame Street",
"address_line_2": "",
"locality": "North End",
"administrative_area": "Avon",
"postal_code": "BS4 EV4"
},
"formatted_address": "BBC News, 123 Sesame Street, North End, Avon, BS4 EV4"
}

Staff Contact Details: Get for Staff Member

Get contact detail information for a Staff member.

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"emergency_contact": "Mr Hercules Jones, 2045 Carpet Avenue, Pittsburgh. Call 1-800-LABRADOR after 4pm."
}

Emails: Get List of Email Addresses by staff Id

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 9,
"email": "contact@wcbs.co.uk",
"communication": {"id": 15,
"type": "Email",
"category": "email",
"deleted_at": null,
"system_value": true
},
"position": 2
}
]

Staff: Get Staff Employment Details

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"employment_contract": {"id": 1,
"name": "Full time"
},
"employment_start_date": "2010-08-24",
"employment_leave_date": "2019-08-24",
"graduate": true,
"nqt": true,
"nqt_expire_date": "2019-08-24",
"payroll_reference": "27B/6",
"personal_summary": "Diligent worker",
"qualifications": "PhD Marine Sport",
"reference": true,
"reference_number": "OO2332x/wasp"
}

Staff: Get Staff Further Details

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"site_resident": true,
"children": [{"first_name": "Kevin",
"id": 3,
"last_name": "Smoot",
"middle_name": null,
"name_in_local_language": null,
"preferred_name": null,
"person_type": "student"
}
],
"consent_photo": true,
"first_aider": false,
"first_aid_qualified": null,
"first_aid_expire_date": null
}

Staff: Get Staff Personal Details

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"date_of_birth": "1979-08-24",
"ethnicity": {"id": 100,
"name": "Other"
},
"gender": {"id": 1,
"name": "Male"
},
"nationality": {"id": 89,
"name": "British"
},
"previous_last_name": null,
"marital_status": {"id": 3,
"name": "Single"
},
"profile_signature_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "staff_sig.jpg",
"size": 50669,
"mime_type": "image/jpg",
"purpose": "staff_profile_signature_image",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"signature_images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
]
}

Phones: Get List of Phones by Staff Id

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 1,
"phone": "01782 555 555",
"communication": {"id": 11,
"type": "Home phone",
"category": "phone",
"deleted_at": null,
"system_value": true
},
"position": 1
}
]

Staff: Get a list of days and working times for a staff member

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 1,
"staff_id": 123,
"time_from": "08:15:00",
"time_to": "16:30:00",
"day": "wednesday"
}
]

Staff Contract Types: List

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

Staff Positions: List

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

Staff: Get Staff School Details

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"departments": [{"id": 1,
"name": "Science"
},
{"id": 44,
"name": "Physical Education"
}
],
"id": 54,
"job_title": "Teacher",
"learning_support_coordinator": false,
"positions": [{"id": 5,
"name": "Teacher"
}
],
"rooms": [ ],
"sections": [{"id": 4,
"name": "Upper school"
}
],
"subjects": [{"id": 9,
"name": "Sport & nutrition"
},
{"id": 88,
"name": "Rocket science"
}
],
"timetable_code": "PK3"
}

Contacts

Contacts module - Contains all services that pertain to Contact Profile data.

Contacts: Get List

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset
search	string API Query Search
filter[status]	integer Filter the table results by Status ID

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"access_status": "no_access",
"students_access": [{"relation_id": 34,
"access_to_student": true,
"student": {"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "Green House"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
}
],
"deleted_at": "2019-08-24T14:15:22Z",
"external_id": null,
"first_name": "Sarah",
"gender": {"id": 2,
"name": "Female"
},
"id": 37,
"last_name": "Shmyth",
"middle_name": null,
"primary_email": "user@example.com",
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.jpg",
"size": 306691,
"mime_type": "image/jpg",
"purpose": "contact_profile_image",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"status": "active",
"students": [{"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
],
"title": {"id": 5,
"name": "Miss"
},
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/contact_profile_image/36/123123.jpg"
}
]
}
]

Contacts: Get Contact

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"access_status": "no_access",
"multi_realm": false,
"students_access": [{"relation_id": 34,
"access_to_student": true,
"student": {"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "Green House"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
}
],
"deleted_at": "2019-08-24T14:15:22Z",
"external_id": null,
"first_name": "Sarah",
"gender": {"id": 2,
"name": "Female"
},
"id": 37,
"last_name": "Shmyth",
"middle_name": null,
"primary_email": "user@example.com",
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.jpg",
"size": 306691,
"mime_type": "image/jpg",
"purpose": "contact_profile_image",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"status": "active",
"students": [{"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
],
"title": {"id": 5,
"name": "Miss"
},
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/contact_profile_image/36/123123.jpg"
}
]
}

Contacts: Get contact consent

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"consent": true
}

Get a list of related records/addresses for a contact

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"address": {"id": 123,
"country": {"id": 257,
"name": "UK"
},
"organization": "BBC News",
"address_line_1": "123 Sesame Street",
"address_line_2": "",
"locality": "North End",
"administrative_area": "Avon",
"postal_code": "BS4 EV4"
},
"colocated-students": [{"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "Green House"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
]
}
]

School

School configuration

Academic Years: Get list

List all Academic Years for a school

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 6,
"date_start": "2020-09-01",
"date_end": "2021-08-31",
"description": "2020-21 Academic Year",
"terms": [{"id": 1,
"description": "Term 1"
}
],
"tense": "current"
}
]

Holidays: List all in an Academic Year

Get list of Holidays in an Academic Year

Authorizations:

OAuth

path Parameters

academicYearId

required

integer

Integer ID of Academic Year

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 4,
"description": "August bank holiday weekend",
"date_start": "2019-08-24",
"date_end": "2019-08-28"
}
]

Inset Days: Get list for an Academic Year

Get list of Inset Days in an Academic Year

Authorizations:

OAuth

path Parameters

academicYearId

required

integer

Integer ID of Academic Year

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 44,
"description": "August inset day",
"date_value": "2019-08-24"
}
]

Terms: Get list for an Academic Year

Get list of Terms in an Academic Year

Authorizations:

OAuth

path Parameters

academicYearId

required

integer

Integer ID of Academic Year

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 4,
"description": "August bank holiday weekend",
"date_start": "2019-08-24",
"date_end": "2019-08-28"
}
]

Closure Dates: List all in an Academic Year

Get list of Closure Dates in an Academic Year

Authorizations:

OAuth

path Parameters

academicYearId

required

integer

Integer ID of Academic Year

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 4,
"description": "August bank holiday weekend",
"date_start": "2019-08-24",
"date_end": "2019-08-28"
}
]

Locations: List

Locations: Get All

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

Rooms: List

Rooms: Get All

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset
search	string API Query Search
filter[location]	integer Filter the table results by Location ID

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 123,
"description": "Standard room assigned to Maths department",
"location": {"id": 1,
"name": "Ground floor",
"position": 2,
"deleted_at": null,
"system_value": false
},
"room_capacity": 50,
"room_code": "Maths room",
"telephone_extension": "x123",
"timetable_code": "12355AAXP4"
}
]

Room: Get One

Rooms: Get one

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"id": 123,
"description": "Standard room assigned to Maths department",
"location": {"id": 1,
"name": "Ground floor",
"position": 2,
"deleted_at": null,
"system_value": false
},
"room_capacity": 50,
"room_code": "Maths room",
"telephone_extension": "x123",
"timetable_code": "12355AAXP4"
}

Group Types: Get List

Group Types: Get All

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"value": "subject_set",
"label": "subject_set"
}
]

School regional default settings

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"regional_country_id": 34,
"start_day_week": "monday",
"timezone": "Europe/London"
}

Attendance

Get all attendance codes

Attendance: get all attendance codes

Authorizations:

OAuth

query Parameters

filter[display]

boolean

Filter the results based on boolean 'display' value

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 0,
"code": "/",
"description": "string",
"category": "present",
"display": null
}
]

Get a list of student session attendance records

Student attendance records: Get by student id

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

query Parameters

filter[attendanceCode]	integer Filter by Attendance Code
filter[attendanceSession]	string Enum: "am" "pm" Example: filter[attendanceSession]=am Filter by Attendance Session Type
filter[dateTime][from]	string <date-time> Filter - Date Start
filter[dateTime][to]	string <date-time> Filter - Date End
	Description (object) or Date (object) or Attendance code (object) or Attendance session (object) Sort records by given sort field, e.g. sort[field]=asc

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"session": "am",
"date": "2019-08-24",
"code": "/",
"description": "Present"
}
]

Learning Support

Learning Support module - available as an extra purchase.

Learning Support Records: List

Authorizations:

OAuth

query Parameters

filter[yearGroup]	integer Filter the results by YearGroup ID
search	string API Query Search
	object or object or object or object or object or object or object Sort records by given sort field, e.g. sort[field]=asc
page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 15,
"description": "Mild ADHD",
"ehcp": true,
"ehcp_date": "2019-08-24",
"files": [{"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.doc",
"size": 306691,
"mime_type": "application/msword",
"purpose": "learning_support_record",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
}
],
"learning_support_date": "2019-08-24",
"learning_support_type": {"id": 2,
"name": "Moderate Learning Difficulty (MLD)"
},
"severity": {"id": 2,
"name": "Mild"
},
"status": {"id": 2,
"name": "active"
},
"student": {"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "Green House"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
},
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
}
},
"inactive_date": null
}
]

LearningSupport Record: Get

Either of the listed scopes is required

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"id": 15,
"description": "Mild ADHD",
"ehcp": true,
"ehcp_date": "2019-08-24",
"files": [{"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.doc",
"size": 306691,
"mime_type": "application/msword",
"purpose": "learning_support_record",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
}
],
"learning_support_date": "2019-08-24",
"learning_support_type": {"id": 2,
"name": "Moderate Learning Difficulty (MLD)"
},
"severity": {"id": 2,
"name": "Mild"
},
"status": {"id": 2,
"name": "active"
},
"student": {"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "Green House"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
},
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
}
},
"inactive_date": null
}

Learning Support Records: Get a list of Record statuses

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

Learning Support Severities: List

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

Learning Support Types: List

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

Learning Support Review Types: List

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

Learning Support: Get Learning Support Review by Id

Either of the listed scopes is required

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"id": 18,
"agreed_actions": "It was decided to monitor the situation and for another meeting to be held in 6 months' time.",
"attending_contacts": [{"access_status": "no_access",
"students_access": [{"relation_id": 1,
"access_to_student": true,
"student": {"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
}
],
"deleted_at": "2019-08-24T14:15:22Z",
"external_id": null,
"first_name": "Sarah",
"gender": {"id": 1,
"name": "Female"
},
"id": 10,
"last_name": "Uumelmahay",
"middle_name": null,
"primary_email": "user@example.com",
"profile_image": null,
"status": "active",
"students": [{"id": 0,
"access_status": "no_access",
"academic_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"country_of_birth": {"id": 1,
"name": "A non-null lookup value"
},
"date_of_birth": "2019-08-24",
"deleted_at": "2019-08-24T14:15:22Z",
"ethnicity": {"id": 1,
"name": "A string value"
},
"enrolment_status": "string",
"external_id": "string",
"faith": {"id": 1,
"name": "A string value"
},
"first_name": "string",
"gender": {"id": 1,
"name": "A string value"
},
"has_global_note": true,
"form": {"id": 0,
"name": "string",
"staff": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"section": {"id": 1,
"name": "A string value"
},
"year_group": {"id": 1,
"name": "A string value"
}
},
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"language_first": {"id": 1,
"name": "A non-null lookup value"
},
"language_second": {"id": 1,
"name": "A non-null lookup value"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "string",
"learning_support_record_summary": [{"id": 1,
"name": "A string value"
}
],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"middle_name": "string",
"name_in_local_language": "string",
"national_identity": "string",
"nationalities": [{"id": 1,
"name": "A string value"
}
],
"person_type": "string",
"preferred_name": "string",
"primary_email": "user@example.com",
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.doc",
"size": 306691,
"mime_type": "application/msword",
"purpose": "learning_support_record",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"tags": [{"id": 5,
"type": {"id": 4,
"name": "Attendance Issues",
"type": "text",
"color_option": 8
},
"text": "Often missing from morning roll call",
"number": null,
"date": "2019-08-24"
}
]
}
],
"title": {"id": 4,
"name": "Miss"
},
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
]
}
],
"attending_contact_text": "Also attending was the student's doctor, Dr Malthouse",
"attending_staff": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"is_student_attending": true,
"description": "Review of the student's use of tinted glasses to attempt to address issues.",
"ehcp_notes": "None",
"files": [{"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.doc",
"size": 306691,
"mime_type": "application/msword",
"purpose": "learning_support_record",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
}
],
"meeting_aims": "Recording of any observations on whether there is any change in the student's behaviour & learning outcomes",
"next_review": "2019-08-24T14:15:22Z",
"review_type": {"id": 1,
"name": "School action"
},
"review_date_time": "2019-04-24T14:15:22Z",
"special_needs_coordinators": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"review_status": {"id": 1,
"name": "active"
}
}

Learning Support terminology - terms selected that describes Learning Support for current school

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 1,
"name": "A string value"
}
]

Students: Get Learning Support fields by student Id

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"authority": {"id": 7,
"name": "Aldershot Council"
},
"authority_type": {"id": 65,
"name": "Parish council"
},
"disability": false,
"disability_description": null,
"placement_date": "2019-08-24"
}

Learning Support: Get List of Learning Support Reviews by student Id

Requires either one of the listed scopes

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

query Parameters

	object or object or object or object or object or object Sort records by given sort field, e.g. sort[field]=asc
page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset
search	string API Query Search
filter[status]	integer Filter the results based on Record's 'Status' ID value
filter[reviewType]	integer Filter the results based on Record's Review Type ID value
filter[isStudentAttending]	boolean Filter the results based on Review's 'Is Student Attending' value

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 18,
"agreed_actions": "It was decided to monitor the situation and for another meeting to be held in 6 months' time.",
"attending_contacts": [{"access_status": "no_access",
"students_access": [{"relation_id": 1,
"access_to_student": true,
"student": {"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
}
],
"deleted_at": "2019-08-24T14:15:22Z",
"external_id": null,
"first_name": "Sarah",
"gender": {"id": 1,
"name": "Female"
},
"id": 10,
"last_name": "Uumelmahay",
"middle_name": null,
"primary_email": "user@example.com",
"profile_image": null,
"status": "active",
"students": [{"id": 0,
"access_status": "no_access",
"academic_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"country_of_birth": {"id": 1,
"name": "A non-null lookup value"
},
"date_of_birth": "2019-08-24",
"deleted_at": "2019-08-24T14:15:22Z",
"ethnicity": {"id": 1,
"name": "A string value"
},
"enrolment_status": "string",
"external_id": "string",
"faith": {"id": 1,
"name": "A string value"
},
"first_name": "string",
"gender": {"id": 1,
"name": "A string value"
},
"has_global_note": true,
"form": {"id": 0,
"name": "string",
"staff": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"section": {"id": 1,
"name": "A string value"
},
"year_group": {"id": 1,
"name": "A string value"
}
},
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"language_first": {"id": 1,
"name": "A non-null lookup value"
},
"language_second": {"id": 1,
"name": "A non-null lookup value"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "string",
"learning_support_record_summary": [{"id": 1,
"name": "A string value"
}
],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"middle_name": "string",
"name_in_local_language": "string",
"national_identity": "string",
"nationalities": [{"id": 1,
"name": "A string value"
}
],
"person_type": "string",
"preferred_name": "string",
"primary_email": "user@example.com",
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.doc",
"size": 306691,
"mime_type": "application/msword",
"purpose": "learning_support_record",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"tags": [{"id": 5,
"type": {"id": 4,
"name": "Attendance Issues",
"type": "text",
"color_option": 8
},
"text": "Often missing from morning roll call",
"number": null,
"date": "2019-08-24"
}
]
}
],
"title": {"id": 4,
"name": "Miss"
},
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
]
}
],
"attending_contact_text": "Also attending was the student's doctor, Dr Malthouse",
"attending_staff": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"is_student_attending": true,
"description": "Review of the student's use of tinted glasses to attempt to address issues.",
"ehcp_notes": "None",
"files": [{"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.doc",
"size": 306691,
"mime_type": "application/msword",
"purpose": "learning_support_record",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
}
],
"meeting_aims": "Recording of any observations on whether there is any change in the student's behaviour & learning outcomes",
"next_review": "2019-08-24T14:15:22Z",
"review_type": {"id": 1,
"name": "School action"
},
"review_date_time": "2019-04-24T14:15:22Z",
"special_needs_coordinators": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"review_status": {"id": 1,
"name": "active"
}
}
]

Learning Support: Get List of Learning Support Records by student Id

Requires either one of the listed scopes

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

query Parameters

	object or object or object or object or object or object or object Sort records by given sort field, e.g. sort[field]=asc
page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset
search	string API Query Search
filter[status]	integer Filter the results based on Record's 'Status' ID value
filter[ehcp]	boolean Filter the results based on boolean 'EHCP' value
filter[severity]	integer Filter the results based on Record's Severity ID value
filter[learningSupportType]	integer Filter the results based on Record's Learning Support Type ID value

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 15,
"description": "Mild ADHD",
"ehcp": true,
"ehcp_date": "2019-08-24",
"files": [{"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.doc",
"size": 306691,
"mime_type": "application/msword",
"purpose": "learning_support_record",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
}
],
"learning_support_date": "2019-08-24",
"learning_support_type": {"id": 2,
"name": "Moderate Learning Difficulty (MLD)"
},
"severity": {"id": 2,
"name": "Mild"
},
"status": {"id": 2,
"name": "active"
},
"student": {"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "Green House"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
},
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
}
},
"inactive_date": null
}
]

Timetable Maintenance

Timetable module - Administration of timetables

Timetables: Get List

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset
search	string API Query Search
filter[academicYear]	string Filter the table results by academic year ID

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 24,
"academic_year": {"id": 6,
"date_start": "2020-09-01",
"date_end": "2021-08-31",
"description": "2020-21 Academic Year",
"terms": [{"id": 1,
"description": "Term 1"
}
]
},
"name": "Q1 Weekly Junior School",
"rotating": true,
"duration_days": 5,
"date_from": "2019-01-03",
"date_to": "2019-04-24",
"time_from": "08:00:00",
"time_to": "16:30:00",
"sections": [{"id": 1,
"name": "Lower school"
}
],
"created_at": "2018-08-24T14:15:22Z",
"updated_at": "2019-02-24T14:15:22Z",
"created_by": {"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
},
"updated_by": {"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
},
"last_published_staff_at": "2019-01-24T14:15:22Z",
"last_published_students_at": "2019-02-24T14:15:22Z",
"last_draft_at": "2019-01-01T14:15:22Z",
"last_version_updated_at": "2019-02-24T14:15:22Z",
"last_version_updated_by": {"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
},
"queued_warning_generation": true,
"deleted": false,
"data_imported": "manual"
}
]

Timetables: Get single Timetable

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"id": 24,
"academic_year": {"id": 6,
"date_start": "2020-09-01",
"date_end": "2021-08-31",
"description": "2020-21 Academic Year",
"terms": [{"id": 1,
"description": "Term 1"
}
]
},
"name": "Q1 Weekly Junior School",
"rotating": true,
"duration_days": 5,
"date_from": "2019-01-03",
"date_to": "2019-04-24",
"time_from": "08:00:00",
"time_to": "16:30:00",
"sections": [{"id": 1,
"name": "Lower school"
}
],
"created_at": "2018-08-24T14:15:22Z",
"updated_at": "2019-02-24T14:15:22Z",
"created_by": {"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
},
"updated_by": {"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
},
"last_published_staff_at": "2019-08-24T14:15:22Z",
"last_published_students_at": "2019-08-24T14:15:22Z",
"last_draft_at": "2019-08-24T14:15:22Z",
"last_version_updated_at": "2019-08-24T14:15:22Z",
"last_version_updated_by": {"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
},
"queued_warning_generation": true,
"deleted": false,
"data_imported": "manual",
"days": [{"day_number": 0,
"label_week": "string",
"label_day": "string",
"periods": [{"id": 455,
"type": "period",
"time_from": "08:00:00",
"time_to": "09:00:00",
"timetable_import_number": 1,
"label": "New Slot",
"group_restriction_subject_set": 0,
"group_restriction_form": 0,
"group_restriction_tutor_group": 0,
"group_restriction_eca": 1,
"group_restriction_house": 0,
"group_restriction_duty": 0,
"attendance_period": 0,
"attendance_session": "am",
"allocation": [{"id": 657,
"class": {"academic_year": {"id": 1,
"name": "2020-21 Academic Year"
},
"code": "ORCH",
"max_students": 40,
"name": "Orchestra",
"rooms": [{"id": 14,
"room_code": "Music Studio 2"
}
],
"short_description": "School Orchestra",
"staff": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"staff_report_writers": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"student_count": 30,
"timetable_code": "Orch",
"id": 54,
"date_start": "2019-01-24",
"date_end": "2019-11-24",
"year_groups": [ ]
},
"period_span": "single",
"period_span_parent_id": 33,
"rooms": [{"id": 123,
"description": "Standard room assigned to Maths department",
"location": {"id": 1,
"name": "Ground floor",
"position": 2,
"deleted_at": null,
"system_value": false
},
"room_capacity": 50,
"room_code": "Maths room",
"telephone_extension": "x123",
"timetable_code": "12355AAXP4"
}
],
"allocated_persons": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"warnings": [{"id": 111,
"warning_type": "room_in_use",
"room": {"id": 123,
"description": "Standard room assigned to Maths department",
"location": {"id": 1,
"name": "Ground floor",
"position": 2,
"deleted_at": null,
"system_value": false
},
"room_capacity": 50,
"room_code": "Maths room",
"telephone_extension": "x123",
"timetable_code": "12355AAXP4"
},
"staff": {"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
},
"student": {"first_name": "Mary",
"id": 56,
"last_name": "Mulvihill",
"middle_name": null,
"name_in_local_language": null,
"preferred_name": null,
"title": {"id": 4,
"name": "Ms"
},
"person_type": "student"
},
"permitted": true,
"class": {"academic_year": {"id": 1,
"name": "2020-21 Academic Year"
},
"code": "ORCH",
"max_students": 40,
"name": "Orchestra",
"rooms": [{"id": 14,
"room_code": "Music Studio 2"
}
],
"short_description": "School Orchestra",
"staff": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"staff_report_writers": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"student_count": 30,
"timetable_code": "Orch",
"id": 54,
"date_start": "2019-01-24",
"date_end": "2019-11-24",
"year_groups": [ ]
},
"house": {"id": 9,
"address": null,
"code": "GH",
"genders": [{"id": 1,
"name": "Male"
}
],
"house_parents": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"house_type": "boarding",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/house_image/36/123123.jpg"
}
],
"max_students": 100,
"name": "Green House",
"note": null,
"phone": null,
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.jpg",
"size": 306691,
"mime_type": "image/jpg",
"purpose": "house_profile_image",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"staff": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"system_profile_image": "aqua"
}
}
]
}
]
}
]
}
],
"dates_based_on": "academic_year",
"dates_based_on_academic_term_id": 3
}

Timetable Views

Timetable module - Views and reporting of timetables, including calendar information

Staff: Get Timetable

Fetch collection of Timetable Periods that the Staff member is allocated against

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"timetables": [{"id": 4,
"name": "Base Timetable",
"time_from": "08:00:00",
"time_to": "16:30:00",
"days": [{"day_number": 1,
"label_week": "Week A",
"label_day": "Monday",
"periods": [{"id": 455,
"type": "period",
"time_from": "08:00:00",
"time_to": "09:00:00",
"timetable_import_number": 1,
"label": "New Slot",
"group_restriction_subject_set": 0,
"group_restriction_form": 0,
"group_restriction_tutor_group": 0,
"group_restriction_eca": 1,
"group_restriction_house": 0,
"group_restriction_duty": 0,
"attendance_period": 0,
"attendance_session": "am",
"allocation": [{"id": 657,
"class": {"academic_year": {"id": 1,
"name": "2020-21 Academic Year"
},
"code": "ORCH",
"max_students": 40,
"name": "Orchestra",
"rooms": [{"id": 14,
"room_code": "Music Studio 2"
}
],
"short_description": "School Orchestra",
"staff": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"staff_report_writers": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"student_count": 30,
"timetable_code": "Orch",
"id": 54,
"date_start": "2019-01-24",
"date_end": "2019-11-24",
"year_groups": [ ]
},
"period_span": "single",
"period_span_parent_id": 33,
"rooms": [{"id": 123,
"description": "Standard room assigned to Maths department",
"location": {"id": 1,
"name": "Ground floor",
"position": 2,
"deleted_at": null,
"system_value": false
},
"room_capacity": 50,
"room_code": "Maths room",
"telephone_extension": "x123",
"timetable_code": "12355AAXP4"
}
],
"allocated_persons": [{"access_status": "invited",
"academic_houses": [{"id": 1,
"name": "Green House"
}
],
"boarding_houses": [{"id": 1,
"name": "Green House"
}
],
"departments": [{"id": 4,
"name": "Drama"
}
],
"email": "user@example.com",
"external_id": "ST5466X",
"first_name": "Benjamin",
"forms": [{"id": 10,
"name": "Standard 9"
}
],
"gender": {"id": 1,
"name": "Male"
},
"id": 12,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Head of Drama",
"last_name": "Kakistos",
"middle_name": null,
"person_type": "staff",
"preferred_name": "Ben",
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.jpg",
"size": 306691,
"mime_type": "image/jpg",
"purpose": "staff_profile_image",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"roles": [{"id": 4,
"name": "Teacher"
}
],
"rooms": [ ],
"sections": [{"id": 2,
"name": "Upper School"
}
],
"status": "current",
"title": {"id": 1,
"name": "Mr"
}
}
],
"duty": true,
"warnings": [{"id": 111,
"warning_type": "room_in_use",
"room": {"id": 123,
"description": "Standard room assigned to Maths department",
"location": {"id": 1,
"name": "Ground floor",
"position": 2,
"deleted_at": null,
"system_value": false
},
"room_capacity": 50,
"room_code": "Maths room",
"telephone_extension": "x123",
"timetable_code": "12355AAXP4"
},
"staff": {"access_status": "invited",
"academic_houses": [{"id": 1,
"name": "Green House"
}
],
"boarding_houses": [{"id": 1,
"name": "Green House"
}
],
"departments": [{"id": 4,
"name": "Drama"
}
],
"email": "user@example.com",
"external_id": "ST5466X",
"first_name": "Benjamin",
"forms": [{"id": 10,
"name": "Standard 9"
}
],
"gender": {"id": 1,
"name": "Male"
},
"id": 12,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Head of Drama",
"last_name": "Kakistos",
"middle_name": null,
"person_type": "staff",
"preferred_name": "Ben",
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.jpg",
"size": 306691,
"mime_type": "image/jpg",
"purpose": "staff_profile_image",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"roles": [{"id": 4,
"name": "Teacher"
}
],
"rooms": [ ],
"sections": [{"id": 2,
"name": "Upper School"
}
],
"status": "current",
"title": {"id": 1,
"name": "Mr"
}
},
"student": {"id": 56,
"access_status": "invited",
"academic_house": {"id": 1,
"name": "Green House"
},
"boarding_type": {"id": 1,
"name": "Full Time Boarder"
},
"boarding_house": {"id": 1,
"name": "Green House"
},
"country_of_birth": {"id": 22,
"name": "Barbados"
},
"date_of_birth": "2010-08-24",
"deleted_at": null,
"ethnicity": {"id": 8,
"name": "Other"
},
"enrolment_status": "current",
"external_id": "MX99328",
"faith": {"id": 1,
"name": "Christian"
},
"first_name": "Miles",
"gender": {"id": 1,
"name": "Male"
},
"has_global_note": false,
"form": {"id": 8,
"name": "Form 4",
"staff": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"section": {"id": 1,
"name": "Lower School"
},
"year_group": {"id": 1,
"name": "Year 4"
}
},
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/student_profile_image/36/123123.jpg"
}
],
"language_first": {"id": 1,
"name": "English"
},
"language_second": {"id": 13,
"name": "Farsi"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Whyde",
"learning_support_record_summary": [ ],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"middle_name": null,
"name_in_local_language": null,
"national_identity": null,
"nationalities": [{"id": 22,
"name": "British"
}
],
"person_type": "stduent",
"preferred_name": null,
"primary_email": "user@example.com",
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.doc",
"size": 306691,
"mime_type": "application/msword",
"purpose": "learning_support_record",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"tags": [{"id": 5,
"type": {"id": 4,
"name": "Attendance Issues",
"type": "text",
"color_option": 8
},
"text": "Often missing from morning roll call",
"number": null,
"date": "2019-08-24"
}
]
},
"permitted": true,
"class": {"academic_year": {"id": 1,
"name": "2020-21 Academic Year"
},
"code": "ORCH",
"max_students": 40,
"name": "Orchestra",
"rooms": [{"id": 14,
"room_code": "Music Studio 2"
}
],
"short_description": "School Orchestra",
"staff": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"staff_report_writers": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"student_count": 30,
"timetable_code": "Orch",
"id": 54,
"date_start": "2019-01-24",
"date_end": "2019-11-24",
"year_groups": [ ]
},
"house": {"id": 9,
"address": null,
"code": "GH",
"genders": [{"id": 1,
"name": "Male"
}
],
"house_parents": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"house_type": "boarding",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/house_image/36/123123.jpg"
}
],
"max_students": 100,
"name": "Green House",
"note": null,
"phone": null,
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.jpg",
"size": 306691,
"mime_type": "image/jpg",
"purpose": "house_profile_image",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"staff": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"system_profile_image": "aqua"
}
}
]
}
]
}
]
}
]
}
]
}

Staff: Fetch Timetable Calendar

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

query Parameters

filter[dateFrom] required	string <date> Filter - Date Start
filter[dateTo] required	string <date> Filter - Date End
filter[date] required	string <date> Filter - Date

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"calendar": [{"entry_type": "timetable",
"timetable": {"id": 1,
"description": "Base Timetable"
},
"period": {"id": 44,
"type": "break",
"time_from": "10:00:00",
"time_to": "10:20:00",
"label": "recess",
"attendance_period": 4,
"attendance_session": null
},
"allocation": {"id": 657,
"class": {"academic_year": {"id": 1,
"name": "2020-21 Academic Year"
},
"code": "ORCH",
"max_students": 40,
"name": "Orchestra",
"rooms": [{"id": 14,
"room_code": "Music Studio 2"
}
],
"short_description": "School Orchestra",
"staff": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"staff_report_writers": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"student_count": 30,
"timetable_code": "Orch",
"id": 54,
"date_start": "2019-01-24",
"date_end": "2019-11-24",
"year_groups": [ ]
},
"period_span": "single",
"period_span_parent_id": 33,
"rooms": [{"id": 123,
"description": "Standard room assigned to Maths department",
"location": {"id": 1,
"name": "Ground floor",
"position": 2,
"deleted_at": null,
"system_value": false
},
"room_capacity": 50,
"room_code": "Maths room",
"telephone_extension": "x123",
"timetable_code": "12355AAXP4"
}
],
"allocated_persons": [{"access_status": "invited",
"academic_houses": [{"id": 1,
"name": "Green House"
}
],
"boarding_houses": [{"id": 1,
"name": "Green House"
}
],
"departments": [{"id": 4,
"name": "Drama"
}
],
"email": "user@example.com",
"external_id": "ST5466X",
"first_name": "Benjamin",
"forms": [{"id": 10,
"name": "Standard 9"
}
],
"gender": {"id": 1,
"name": "Male"
},
"id": 12,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Head of Drama",
"last_name": "Kakistos",
"middle_name": null,
"person_type": "staff",
"preferred_name": "Ben",
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.jpg",
"size": 306691,
"mime_type": "image/jpg",
"purpose": "staff_profile_image",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"roles": [{"id": 4,
"name": "Teacher"
}
],
"rooms": [ ],
"sections": [{"id": 2,
"name": "Upper School"
}
],
"status": "current",
"title": {"id": 1,
"name": "Mr"
}
}
],
"duty": true,
"warnings": [ ]
},
"color_option": 6
}
]
}

Student: Get Timetable

Fetch collection of Timetable Periods that the Student is allocated against

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"timetables": [{"id": 4,
"name": "Base Timetable",
"time_from": "08:00:00",
"time_to": "16:30:00",
"days": [{"day_number": 1,
"label_week": "Week A",
"label_day": "Monday",
"periods": [{"id": 455,
"type": "period",
"time_from": "08:00:00",
"time_to": "09:00:00",
"timetable_import_number": 1,
"label": "New Slot",
"group_restriction_subject_set": 0,
"group_restriction_form": 0,
"group_restriction_tutor_group": 0,
"group_restriction_eca": 1,
"group_restriction_house": 0,
"group_restriction_duty": 0,
"attendance_period": 0,
"attendance_session": "am",
"allocation": [{"id": 657,
"class": {"academic_year": {"id": 1,
"name": "2020-21 Academic Year"
},
"code": "ORCH",
"max_students": 40,
"name": "Orchestra",
"rooms": [{"id": 14,
"room_code": "Music Studio 2"
}
],
"short_description": "School Orchestra",
"staff": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"staff_report_writers": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"student_count": 30,
"timetable_code": "Orch",
"id": 54,
"date_start": "2019-01-24",
"date_end": "2019-11-24",
"year_groups": [ ]
},
"period_span": "single",
"period_span_parent_id": 33,
"rooms": [{"id": 123,
"description": "Standard room assigned to Maths department",
"location": {"id": 1,
"name": "Ground floor",
"position": 2,
"deleted_at": null,
"system_value": false
},
"room_capacity": 50,
"room_code": "Maths room",
"telephone_extension": "x123",
"timetable_code": "12355AAXP4"
}
],
"allocated_persons": [{"access_status": "invited",
"academic_houses": [{"id": 1,
"name": "Green House"
}
],
"boarding_houses": [{"id": 1,
"name": "Green House"
}
],
"departments": [{"id": 4,
"name": "Drama"
}
],
"email": "user@example.com",
"external_id": "ST5466X",
"first_name": "Benjamin",
"forms": [{"id": 10,
"name": "Standard 9"
}
],
"gender": {"id": 1,
"name": "Male"
},
"id": 12,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Head of Drama",
"last_name": "Kakistos",
"middle_name": null,
"person_type": "staff",
"preferred_name": "Ben",
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.jpg",
"size": 306691,
"mime_type": "image/jpg",
"purpose": "staff_profile_image",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"roles": [{"id": 4,
"name": "Teacher"
}
],
"rooms": [ ],
"sections": [{"id": 2,
"name": "Upper School"
}
],
"status": "current",
"title": {"id": 1,
"name": "Mr"
}
}
],
"duty": true,
"warnings": [{"id": 111,
"warning_type": "room_in_use",
"room": {"id": 123,
"description": "Standard room assigned to Maths department",
"location": {"id": 1,
"name": "Ground floor",
"position": 2,
"deleted_at": null,
"system_value": false
},
"room_capacity": 50,
"room_code": "Maths room",
"telephone_extension": "x123",
"timetable_code": "12355AAXP4"
},
"staff": {"access_status": "invited",
"academic_houses": [{"id": 1,
"name": "Green House"
}
],
"boarding_houses": [{"id": 1,
"name": "Green House"
}
],
"departments": [{"id": 4,
"name": "Drama"
}
],
"email": "user@example.com",
"external_id": "ST5466X",
"first_name": "Benjamin",
"forms": [{"id": 10,
"name": "Standard 9"
}
],
"gender": {"id": 1,
"name": "Male"
},
"id": 12,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Head of Drama",
"last_name": "Kakistos",
"middle_name": null,
"person_type": "staff",
"preferred_name": "Ben",
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.jpg",
"size": 306691,
"mime_type": "image/jpg",
"purpose": "staff_profile_image",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"roles": [{"id": 4,
"name": "Teacher"
}
],
"rooms": [ ],
"sections": [{"id": 2,
"name": "Upper School"
}
],
"status": "current",
"title": {"id": 1,
"name": "Mr"
}
},
"student": {"id": 56,
"access_status": "invited",
"academic_house": {"id": 1,
"name": "Green House"
},
"boarding_type": {"id": 1,
"name": "Full Time Boarder"
},
"boarding_house": {"id": 1,
"name": "Green House"
},
"country_of_birth": {"id": 22,
"name": "Barbados"
},
"date_of_birth": "2010-08-24",
"deleted_at": null,
"ethnicity": {"id": 8,
"name": "Other"
},
"enrolment_status": "current",
"external_id": "MX99328",
"faith": {"id": 1,
"name": "Christian"
},
"first_name": "Miles",
"gender": {"id": 1,
"name": "Male"
},
"has_global_note": false,
"form": {"id": 8,
"name": "Form 4",
"staff": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"section": {"id": 1,
"name": "Lower School"
},
"year_group": {"id": 1,
"name": "Year 4"
}
},
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/student_profile_image/36/123123.jpg"
}
],
"language_first": {"id": 1,
"name": "English"
},
"language_second": {"id": 13,
"name": "Farsi"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Whyde",
"learning_support_record_summary": [ ],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"middle_name": null,
"name_in_local_language": null,
"national_identity": null,
"nationalities": [{"id": 22,
"name": "British"
}
],
"person_type": "stduent",
"preferred_name": null,
"primary_email": "user@example.com",
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.doc",
"size": 306691,
"mime_type": "application/msword",
"purpose": "learning_support_record",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"tags": [{"id": 5,
"type": {"id": 4,
"name": "Attendance Issues",
"type": "text",
"color_option": 8
},
"text": "Often missing from morning roll call",
"number": null,
"date": "2019-08-24"
}
]
},
"permitted": true,
"class": {"academic_year": {"id": 1,
"name": "2020-21 Academic Year"
},
"code": "ORCH",
"max_students": 40,
"name": "Orchestra",
"rooms": [{"id": 14,
"room_code": "Music Studio 2"
}
],
"short_description": "School Orchestra",
"staff": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"staff_report_writers": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"student_count": 30,
"timetable_code": "Orch",
"id": 54,
"date_start": "2019-01-24",
"date_end": "2019-11-24",
"year_groups": [ ]
},
"house": {"id": 9,
"address": null,
"code": "GH",
"genders": [{"id": 1,
"name": "Male"
}
],
"house_parents": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"house_type": "boarding",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/house_image/36/123123.jpg"
}
],
"max_students": 100,
"name": "Green House",
"note": null,
"phone": null,
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.jpg",
"size": 306691,
"mime_type": "image/jpg",
"purpose": "house_profile_image",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"staff": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"system_profile_image": "aqua"
}
}
]
}
]
}
]
}
]
}
]
}

Students: Fetch Timetable Calendar

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

query Parameters

filter[dateFrom] required	string <date> Filter - Date Start
filter[dateTo] required	string <date> Filter - Date End
filter[date] required	string <date> Filter - Date

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"calendar": [{"entry_type": "timetable",
"timetable": {"id": 1,
"description": "Base Timetable"
},
"period": {"id": 44,
"type": "break",
"time_from": "10:00:00",
"time_to": "10:20:00",
"label": "recess",
"attendance_period": 4,
"attendance_session": null
},
"allocation": {"id": 657,
"class": {"academic_year": {"id": 1,
"name": "2020-21 Academic Year"
},
"code": "ORCH",
"max_students": 40,
"name": "Orchestra",
"rooms": [{"id": 14,
"room_code": "Music Studio 2"
}
],
"short_description": "School Orchestra",
"staff": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"staff_report_writers": [{"first_name": "John",
"id": 33,
"last_name": "Smith",
"middle_name": "Smyth",
"name_in_local_language": "Johan",
"preferred_name": "Jon",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
],
"student_count": 30,
"timetable_code": "Orch",
"id": 54,
"date_start": "2019-01-24",
"date_end": "2019-11-24",
"year_groups": [ ]
},
"period_span": "single",
"period_span_parent_id": 33,
"rooms": [{"id": 123,
"description": "Standard room assigned to Maths department",
"location": {"id": 1,
"name": "Ground floor",
"position": 2,
"deleted_at": null,
"system_value": false
},
"room_capacity": 50,
"room_code": "Maths room",
"telephone_extension": "x123",
"timetable_code": "12355AAXP4"
}
],
"allocated_persons": [{"access_status": "invited",
"academic_houses": [{"id": 1,
"name": "Green House"
}
],
"boarding_houses": [{"id": 1,
"name": "Green House"
}
],
"departments": [{"id": 4,
"name": "Drama"
}
],
"email": "user@example.com",
"external_id": "ST5466X",
"first_name": "Benjamin",
"forms": [{"id": 10,
"name": "Standard 9"
}
],
"gender": {"id": 1,
"name": "Male"
},
"id": 12,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Head of Drama",
"last_name": "Kakistos",
"middle_name": null,
"person_type": "staff",
"preferred_name": "Ben",
"profile_image": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "example.jpg",
"size": 306691,
"mime_type": "image/jpg",
"purpose": "staff_profile_image",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"roles": [{"id": 4,
"name": "Teacher"
}
],
"rooms": [ ],
"sections": [{"id": 2,
"name": "Upper School"
}
],
"status": "current",
"title": {"id": 1,
"name": "Mr"
}
}
],
"duty": true,
"warnings": [ ]
},
"color_option": 6
}
]
}

Pastoral

Pastoral Records, associated notes and actions

Pastoral Category: List

Authorizations:

OAuth

path Parameters

pastoralCategoryType

required

string

Enum: "wellbeing_event" "wellbeing_plan"

Pastoral category type

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 54,
"name": "Example category",
"position": 2,
"system_value": false,
"category": {"id": 1,
"name": "Parent category",
"position": 1,
"system_value": false,
"category": null,
"color": 3,
"sections": null,
"deleted_at": "2019-08-24T14:15:22Z"
},
"color": 0,
"sections": [{"id": 1,
"name": "Lower school"
}
],
"deleted_at": "2019-08-24T14:15:22Z"
}
]

Pastoral Category: Get one

Authorizations:

OAuth

path Parameters

pastoralCategoryType required	string Enum: "wellbeing_event" "wellbeing_plan" Pastoral category type
id required	integer Example: 1 Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"id": 54,
"name": "Example category",
"position": 2,
"system_value": false,
"category": {"id": 1,
"name": "Parent category",
"position": 1,
"system_value": false,
"category": null,
"color": 3,
"sections": null,
"deleted_at": "2019-08-24T14:15:22Z"
},
"color": 0,
"sections": [{"id": 1,
"name": "Lower school"
}
],
"deleted_at": "2019-08-24T14:15:22Z"
}

Pastoral Severity Levels: List

Authorizations:

OAuth

path Parameters

module

required

string

Value: "wellbeing"

Pastoral module

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 4,
"name": "Severe",
"color": 2
}
]

Pastoral: Get list of Events Deprecated

Get list of Pastoral Events

Authorizations:

OAuth

query Parameters

filter[type]	string Enum: "wellbeing_plan" "wellbeing_event" Filter results by Pastoral Event Type
filter[yearGroup]	integer Filter the results by YearGroup ID
filter[form]	integer Filter the results by Form ID
filter[category]	integer Filter the table results by Category ID
filter[status]	string Enum: "active" "inactive" Filter the table results by Status
filter[severity]	integer Filter the table results by Severity ID
	object Range filter for date/time
search	string API Query Search
	object or object or object or object or object or object or object or object Sort records by given sort field, e.g. sort[field]=asc
page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset
filter[assignedTo]	integer Filter results by assigned Staff ID
filter[includePastStudents]	boolean Include Past Students in the query results (false if not passed)

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 55,
"title": "Disrupted morning assembly",
"event_type": "wellbeing_event",
"severity": {"id": 4,
"name": "Minor",
"color": 8
},
"category": {"id": 4,
"name": "Disruption",
"color": 8
},
"status": "active",
"students": [{"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
],
"assignees": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"last_updated_at": "2019-08-24T14:15:22Z",
"subcategory": {"id": 4,
"name": "Recording only"
}
}
]

Pastoral: Get list of Events

Get list of Pastoral Events

Authorizations:

OAuth

query Parameters

filter[type]	string Enum: "wellbeing_plan" "wellbeing_event" Filter results by Pastoral Event Type
filter[yearGroup]	integer Filter the results by YearGroup ID
filter[form]	integer Filter the results by Form ID
filter[category]	integer Filter the table results by Category ID
filter[status]	string Enum: "active" "inactive" Filter the table results by Status
filter[severity]	integer Filter the table results by Severity ID
	object Range filter for date/time
search	string API Query Search
	object or object or object or object or object or object or object or object Sort records by given sort field, e.g. sort[field]=asc
page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset
filter[assignedTo]	integer Filter results by assigned Staff ID
filter[includePastStudents]	boolean Include Past Students in the query results (false if not passed)

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 14,
"title": "Wellbeing Event Example",
"event_type": "wellbeing_event",
"severity": null,
"category": {"id": 8,
"name": "Health",
"color_option": 9
},
"status": "active",
"student": {"id": 441,
"title": null,
"first_name": "Jon",
"middle_name": null,
"last_name": "Don",
"preferred_name": null,
"name_in_local_language": null,
"person_type": "student",
"status": "current",
"status_indicator": "current",
"images": [ ],
"tag_summary": [ ],
"learning_support_record_summary": [ ],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"has_global_note": false
},
"assignees": [ ],
"academic_structure": {"form": {"id": 505,
"name": "Form 1A"
},
"year_group": {"id": 41,
"name": "Year 1"
}
},
"last_updated_at": "2021-12-22T12:29:26+00:00",
"admissions_application": {"admission_year": {"id": 6,
"name": "2019-2020"
},
"admission_year_group": {"id": 1,
"name": "Kindergarten 1"
}
},
"subcategory": {"id": 3,
"name": "Eating Disorder",
"color_option": null
}
}
]

Pastoral: Get summary of Events

Get summary of Pastoral Events

Authorizations:

OAuth

query Parameters

filter[type]	string Enum: "wellbeing_plan" "wellbeing_event" Filter results by Pastoral Event Type
filter[yearGroup]	integer Filter the results by YearGroup ID
filter[form]	integer Filter the results by Form ID
filter[category]	integer Filter the table results by Category ID
filter[status]	string Enum: "active" "inactive" Filter the table results by Status
filter[severity]	integer Filter the table results by Severity ID
	object Range filter for date/time
search	string API Query Search
filter[assignedTo]	integer Filter results by assigned Staff ID
filter[includePastStudents]	boolean Include Past Students in the query results (false if not passed)

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"category": {"id": 1,
"name": "Orange",
"color": 8
},
"event_count": 0
}
]

Pastoral: Get single Event

Get Pastoral Event

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 55,
"title": "Disrupted morning assembly",
"event_type": "wellbeing_event",
"description": "Morning assembly was disrupted by shouting",
"severity": {"id": 3,
"name": "Minor"
},
"category": {"id": 6,
"name": "Disturbance",
"color": 8
},
"status": "active",
"datetime": "2019-08-24T14:15:22Z",
"students": [{"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
],
"assignees": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"last_updated_at": "2019-08-24T14:15:22Z",
"last_updated_by": {"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
},
"recorder": {"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
},
"subcategory": {"id": 14,
"name": "Reportable only"
}
}
]

GIRFEC SHANARRI Items: Get List of SHANARRI Items by Pastoral Event Id

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 1,
"type": "healthy",
"description": "Healthy Item description"
}
]

Linked Items: Get List of linked items by Pastoral Event Id

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 55,
"title": "Disrupted morning assembly",
"event_type": "wellbeing_event",
"severity": {"id": 4,
"name": "Minor",
"color": 8
},
"category": {"id": 4,
"name": "Disruption",
"color": 8
},
"status": "active",
"students": [{"id": 145,
"academic_house": {"id": 1,
"name": "Green House"
},
"access_status": "invited",
"boarding_house": {"id": 1,
"name": "A non-null lookup value"
},
"boarding_type": {"id": 1,
"name": "Full time boarder"
},
"date_of_birth": "2010-08-24",
"enrolment_status": "current",
"external_id": "X12332",
"first_name": "Mervyn",
"gender": {"id": 1,
"name": "Male"
},
"last_login": "2019-08-24T14:15:22Z",
"last_name": "Kirwan",
"middle_name": "Davin",
"name_in_local_language": null,
"person_type": "student",
"preferred_name": "Merv",
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"learning_support_record_summary": [{"id": 1,
"name": "The short description from the LS Record"
}
],
"medical_condition_severity": {"id": 1,
"name": "High",
"position": 1
},
"learning_support_summary": [ ],
"tag_summary": [{"id": 1,
"color_option": 8,
"content": "late",
"name": "Attendance Issues"
}
],
"has_global_note": true,
"form": {"id": 6,
"name": "Form 9A",
"section": {"id": 1,
"name": "Middle School"
},
"staff": [{"departments": [{"id": 9,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9087",
"first_name": "Peter",
"gender": {"id": 1,
"name": "Male"
},
"id": 68,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "Treacher",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": null,
"previous_last_name": null,
"sections": [{"id": 1,
"name": "Middle school"
}
],
"subjects": [{"id": 13,
"name": "Chemistry"
}
],
"status": "current",
"timetable_code": "PTSC",
"roles": [{"id": 5,
"name": "Teacher"
}
],
"title": {"id": 1,
"name": "Mr"
}
}
],
"year_group": {"id": 6,
"name": "Year 9",
"position": 3
}
}
}
],
"assignees": [{"departments": [{"id": 1,
"name": "Science"
}
],
"employment_leave_date": null,
"external_id": "ST9344",
"first_name": "Mary",
"gender": {"id": 2,
"name": "Female"
},
"id": 5,
"images": [{"type": "thumbnail",
"url": "https://wcbs-hub.imgix.net/S999/staff_profile_image/36/123123.jpg"
}
],
"job_title": "Teacher",
"last_name": "McMahnamahna",
"middle_name": null,
"person_type": "staff",
"positions": [{"id": 1,
"name": "Teacher"
}
],
"preferred_name": "Mary",
"previous_last_name": "Mulvihill",
"sections": [{"id": 1,
"name": "Lower School"
}
],
"subjects": [{"id": 1,
"name": "Physics"
}
],
"status": "current",
"timetable_code": "STMMSP",
"roles": [{"id": 1,
"name": "Teacher"
}
],
"title": {"id": 4,
"name": "Ms"
}
}
],
"last_updated_at": "2019-08-24T14:15:22Z"
}
]

GIRFEC Data: get year groups named persons

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 35,
"year_group_uuid": "a901d1a0-d1f1-4761-92bf-6c8192c4352b",
"staff": {"first_name": "Trevor",
"id": 93,
"last_name": "Staple",
"middle_name": null,
"preferred_name": "Trev",
"title": {"id": 1,
"name": "Mr"
},
"person_type": "staff"
}
}
]

Data

Endpoints which affect central settings - includes any list maintenance services (e.g. Countries). Data services that belong to a certain module can be found under that module.

Countries: Get List

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 14,
"name": "Australia",
"code": "AUS",
"code_alpha2": "AU",
"position": 14,
"deleted_at": null,
"system_value": true,
"display": true
}
]

Custom Fields Group: Get List

Authorizations:

OAuth

path Parameters

userType

required

string

Enum: "student" "staff" "contact"

User type

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

Custom Fields Field: Get List

Authorizations:

OAuth

query Parameters

groupId

required

integer <int32>

ID of the Custom Fields Group

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Some bit of text data",
"type": "text",
"group": {"id": 1,
"name": "A field group",
"position": 1,
"type": "student"
},
"position": 1,
"deleted_at": null,
"system_value": false
}
]

Custom Fields Option: Get List

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

Ethnicities: Get List

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 75,
"name": "Chinese",
"code": "CHNE",
"position": 28,
"display": true
}
]

Faiths: Get List

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 14,
"name": "Quaker",
"position": 4,
"deleted_at": null,
"system_value": true,
"display": true
}
]

Gender: Get List

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

Languages: Get List

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 4,
"name": "Afrikaans",
"position": 5,
"deleted_at": null,
"system_value": true,
"display": true
}
]

Marital Statuses: Get List

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

Nationalities: Get List

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 34,
"name": "Cameroonian",
"position": 34,
"deleted_at": null,
"system_value": true,
"display": true
}
]

Qualifications: Get List

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 1,
"name": "A string value"
}
]

Titles: List

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

Authorities: Get List

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

Authority Type: Get List

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

Locations: List

Locations: Get All

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 2,
"name": "Mrs",
"position": 1,
"deleted_at": null,
"system_value": true
}
]

Rooms: List

Rooms: Get All

Authorizations:

OAuth

query Parameters

page[number]	integer Number of page of recordset
page[size]	integer Number of records in recordset
search	string API Query Search
filter[location]	integer Filter the table results by Location ID

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 123,
"description": "Standard room assigned to Maths department",
"location": {"id": 1,
"name": "Ground floor",
"position": 2,
"deleted_at": null,
"system_value": false
},
"room_capacity": 50,
"room_code": "Maths room",
"telephone_extension": "x123",
"timetable_code": "12355AAXP4"
}
]

Room: Get One

Rooms: Get one

Authorizations:

OAuth

path Parameters

required

integer

Example: 1

Integer ID of record

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"id": 123,
"description": "Standard room assigned to Maths department",
"location": {"id": 1,
"name": "Ground floor",
"position": 2,
"deleted_at": null,
"system_value": false
},
"room_capacity": 50,
"room_code": "Maths room",
"telephone_extension": "x123",
"timetable_code": "12355AAXP4"
}

School Communication Details

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

{"school_name": "St Hubbins Boys Grammar",
"school_sms_name": "StHubBoys",
"address": "1234 Mockingbird Lane",
"country": {"id": 1,
"name": "United Kingdom"
},
"phone": "555-8575",
"email": "enquiries@sthubbins.ac.uk",
"website": "https://www.sthubbins.ac.uk",
"logo": {"id": "68d75310-d858-4d75-b47b-3e7089cceca8",
"name": "cormorant.png",
"size": 30663,
"mime_type": "image/png",
"purpose": "school_logo",
"uploaded_by_id": 163,
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": null
},
"logo_urls": {"large": "https://tempstorage/cormorant.png",
"large-2x": "https://tempstorage/cormorant-large.png"
}
}

Settings

Settings configuration data central to the application.

Academic Years: Get list

List all Academic Years for a school

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 6,
"date_start": "2020-09-01",
"date_end": "2021-08-31",
"description": "2020-21 Academic Year",
"terms": [{"id": 1,
"description": "Term 1"
}
],
"tense": "current"
}
]

Terms: Get list for an Academic Year

Get list of Terms in an Academic Year

Authorizations:

OAuth

path Parameters

academicYearId

required

integer

Integer ID of Academic Year

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"id": 4,
"description": "August bank holiday weekend",
"date_start": "2019-08-24",
"date_end": "2019-08-28"
}
]

Staff Default Working Hours: List

Get a list of the default working hours that a Staff member will have if no overrides have been set

Authorizations:

OAuth

header Parameters

realm

required

string

Example: S999

Realm ID

Responses

Response samples

Content type

application/json

[{"day": "monday",
"day_start": "08:00:00",
"day_end": "15:30:00"
}
]