Calendar Events

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

MIS Support: Currently only SIMS is supported as not all MIS make calendar information available

Permissions: A school level access token with the calendar scope is required to access event data from the calendar feature in the school's MIS.

List Calendar Events

Returns a list of calendar events from the school calendar. We strongly recommend that you use an object type to filter the events that will be returned to you. Presently, with SIMS only support, we've exposed the raw types from the underlying MIS. As such, it's most likely that you'll mostly be interested in 'User' events. This category includes items such as staff meetings and school assembly times as you can see from the sample response below.

Note the If-Modified-Since header is optional (see the page on Conditional Requests for more details).

Request

GET /calendar_events
Headers
Accept: application/vnd.assembly+json; version=1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0sZZxr3r...
If-Modified-Since: Mon, 13 Mar 2017 20:00:00 GMT
Parameter Default Example Description
event_type User

a calendar object type from the underlying MIS

per_page 100 25

number of results to return

page 1 2

page number to return

URI Template: /calendar_events{?event_type,per_page,page}

Response 200

Headers
Content-Type: application/json; charset=utf-8
Last-Modified: Mon, 13 Mar 2017 20:00:00 GMT
Payload
{
  "object": "list",
  "total_count": 360,
  "total_pages": 180,
  "current_page": 1,
  "prev_page": null,
  "next_page": 2,
  "data": [
    {
      "object": "calendar_event",
      "id": 4485,
      "name": "Meeting",
      "description": "SLT Meeting",
      "start_date": "2015-09-03T16:00:00.000Z",
      "end_date": "2015-09-03T17:30:00.000Z",
      "is_active": true,
      "is_recurrent": true,
      "mis_type": {
        "name": "User",
        "description": "School Event"
      }
    },
    {
      "object": "calendar_event",
      "id": 4763,
      "name": "Assembly",
      "description": "KS5 Assembly",
      "start_date": "2016-05-23T08:30:00.000Z",
      "end_date": "2016-05-23T09:00:00.000Z",
      "is_active": true,
      "is_recurrent": true,
      "mis_type": {
        "name": "User",
        "description": "School Event"
      }
    }
  ]
}