Introduction

The Timetabling Solutions API provides the ability for schools to interact with their data in it's raw form (i.e. not as it's displayed in the web UI). This is a tool for developers and assumes some level of understanding on how to interact with a REST API.

Authentication

The API support Bearer authentication and requires that client applications retrieve an API token from the /api/authorize endpoint. This endpoint will require the provision of:

• client_id the UUID identifier of the client application, this can be retrieved from the App Integrations screen of the Management Portal.
• client_secret the secret value of the client application, this can be retrieved from the App Integrations screen of the Management Portal.
• credentials this is the username and password of the user account that will be used to authenticate to the API.

The effective permissions of the API token generated is the reductive combination of the permissions the user has and the permissions the client application has.

Using This Tool

First use the "Try it out" tool on the POST /api/authorize endpoint of the Authorization section on this page.

Then copy the resulting token, click on the Authorize button at the top right of the below section, and enter the token in the format "Bearer [token]" and click Authorize.

You will now be able to use the "Try it out" tool on all other endpoints of this page.