Exclusions

The exclusions endpoint can be used to retrieve students' exclusion events.

Access: This is a read-only resource managed directly by the school.

Permissions: a school level access token with the exclusions scope is required to access exclusion information.

List Exclusions

Returns a list of exclusions. By default, exclusions are returned that occurred during the current academic year.

Request

GET /exclusions?start_date={start_date}&end_date={end_date}
Headers
Accept: application/vnd.assembly+json; version=1
Authorization: Bearer b2s7a9s8BQokikJOvBiI2HlWgH4olfQ2
Parameter Default Example Description
start_date beginning of academic year 2017-06-05

start of period to return exclusions for

end_date end of academic year 2017-06-05

end of period to return exclusions for

per_page 100 25

number of results to return

page 1 2

page number to return

URI Template: /exclusions?start_date={start_date}&end_date={end_date}

Response 200

Headers
Content-Type: application/json; charset=utf-8
Payload
{
  "object": "list",
  "total_count": 3,
  "total_pages": 1,
  "current_page": 1,
  "prev_page": null,
  "next_page": null,
  "data": [
    {
      "object": "exclusion",
      "id": 1,
      "student_id": 108634,
      "exclusion_type": "Fixed Term",
      "exclusion_reason": "Bullying",
      "start_date": "2017-06-05T09:00:00.000Z",
      "start_session": "AM",
      "end_date": "2017-06-06T09:00:00.000Z",
      "end_session": "PM",
      "exclusion_length": 4
    },
    {
      "object": "exclusion",
      "id": 2,
      "student_id": 108916,
      "exclusion_type": "Fixed Term",
      "exclusion_reason": "Theft",
      "start_date": "2017-04-04T09:00:00.000Z",
      "start_session": "AM",
      "end_date": "2017-04-04T09:00:00.000Z",
      "end_session": "PM",
      "exclusion_length": 2
    },
    {
      "object": "exclusion",
      "id": 3,
      "student_id": 108298,
      "exclusion_type": "Fixed Term",
      "exclusion_reason": "Damage",
      "start_date": "2017-03-22T09:00:00.000Z",
      "start_session": "AM",
      "end_date": "2017-03-24T09:00:00.000Z",
      "end_session": "PM",
      "exclusion_length": 6
    }
  ]
}

View Exclusions for a Student

Returns a list of exclusions for a given student. By default, exclusions are returned that occurred during the current academic year.

Request

GET /exclusions?student_id={student_id}&start_date={start_date}&end_date={end_date}
Headers
Accept: application/vnd.assembly+json; version=1
Authorization: Bearer b2s7a9s8BQokikJOvBiI2HlWgH4olfQ2
Parameter Default Example Description
student_id 108364

ID of the student as an integer

start_date beginning of academic year 2017-06-05

start of period to return exclusions for

end_date end of academic year 2017-06-05

end of period to return exclusions for

per_page 100 25

number of results to return

page 1 2

page number to return

URI Template: /exclusions?student_id={student_id}&start_date={start_date}&end_date={end_date}

Response 200

Headers
Content-Type: application/json; charset=utf-8
Payload
{
  "object": "list",
  "total_count": 1,
  "total_pages": 1,
  "current_page": 1,
  "prev_page": null,
  "next_page": null,
  "data": [
    {
      "object": "exclusion",
      "id": 1,
      "student_id": 108634,
      "exclusion_type": "Fixed Term",
      "exclusion_reason": "Bullying",
      "start_date": "2017-06-05T09:00:00.000Z",
      "start_session": "AM",
      "end_date": "2017-06-06T09:00:00.000Z",
      "end_session": "PM",
      "exclusion_length": 4
    }
  ]
}