Interacting with the scheduling system

With your pre-requisite data set up in the Surpass Platform and Scheduler, and knowing how to connect to Scheduler, you can now interact with it by making the relevant requests to its endpoints.

This page gives an overview of the available Scheduler API resources to integrate with the Surpass Platform and other platforms.

In this section

Scheduling system URL

The URL to send requests to Scheduler endpoints is:

https://{Scheduler instance}/api/{endpoint}

Scheduling System Integration Postman Collection

All of the endpoints and requests required to integrate with the scheduling system can be found in the Surpass Platform Postman Workspace in the ‘Scheduling System’ collection.

You can import a copy of or fork of this resource and all its endpoints using the Run in Postman button.

Import this collection into your Postman Workspace

The following articles contain reference documentation related to one or more folders in the ‘Scheduling System’ Postman collection. You can also import the collection from any of these articles.

Candidate Management

The Candidate Management article contains reference documentation for the Candidate Management endpoints, for registering and managing candidates.

Staff Management

The Staff Management article contains reference documentation for the User Management endpoints, for creating and managing users (staff).

Scheduling Data

The Scheduling Data article contains reference documentation for the Scheduling Data endpoints, for retrieving scheduling data including departments, modules, and test centre rooms.

Centre Availability

The Centre Availability article contains reference documentation for the Centre Availability endpoints, for retrieving centre availability.

Booking Management

The Booking Management article contains reference documentation for the Booking Management endpoints, for booking and managing test bookings.