Centre Availability

In Scheduler, you can query the availability of a test centre/room before you book seat(s).

This article explains what calls can be made to the Scheduler API using the centre availability resource.

Import this API into your Postman Workspace

NOTE: This article documents the requests in the Centre Availability folder of the 'Scheduling System' Postman collection.

Integration Flow

The following diagram shows the Centre Availability integration flow:

Listing test centre/room availability

get /api/Enrolment/Availability/Room/Event

Send a request to the endpoint to retrieve a list of matching availability objects (available exam slots at the test centre/room). Refer to the available parameters to influence the response.

NOTE: You can use query parameters or pass a request body to retrieve a list of matching availability objects using this endpoint.

Parameters

Parameters are passed with the endpoint to influence the response. Header parameters are included in the request header. Path parameters are extensions of the endpoint, and query parameters follow ? after any path parameters.

Name	Parameter	Input	Description
authorization	header MANDATORY	`Bearer {token}`	A bearer token must be passed to authorise the user’s request, where `{token}` is the token string.
accept	header MANDATORY	`application/json`	Determines data format of the response, which must be JSON.
eventID	query OPTIONAL	`eventId={eventId}`	Filters results by test, where `{eventId}` is the test’s unique OptimeIndex identifier.
roomID	query OPTIONAL	`roomId={roomId}`	Filters results by room, where `{roomId}` is the room’s unique OptimeIndex identifier.
startDate	query OPTIONAL	`startDate={startDate}`	Filters results by start date, where `{startDate}` is in `DD/MM/YYYY` format, UTC.
endDate	query OPTIONAL	`endDate={endDate}`	Filters results by end date, where `{endDate}` is in `DD/MM/YYYY` format, UTC.
startTime	query OPTIONAL	`startTime={startTime}`	Filters results by start time, where `{startTime}` is in `HH:MM` format.
endTime	query OPTIONAL	`endTime={endTime}`	Filters results by end time, where `{endTime}` is in `HH:MM` format.
studentID	query OPTIONAL	`studentID={studentID}`	Filters results by candidate, where `{studentId}` is the candidate’s unique OptimeIndex identifier.

Sample request

The following is a sample request body to query test centre/room availability.

{
    "eventId": 1,
    "startDate": "30/11/2024",
    "endDate": "01/12/2024",
    "startTime": "10:00",
    "endTime": "14:00",
    "roomId": 1,
}

EXAMPLE: In this sample request, the test booking availability of room 1 for test booking 1 between 30/11/2024 and 01/12/2024 with a test start time between 10:00 and 14:00 is checked.

Sample response

If successful, the HTTP status code will be 200 and the response body will contain the information in JSON format as requested.

[
    {
        "date": "2024-11-30T00:00:00",
        "hasAvailability": true,
        "availability": [
            {
                "resourceType": "Datetime",
                "resourceParentId": null,
                "resourceId": "12:00 - 14:00",
                "buildingTimezone": null,
                "availableSeats": 5,
                "isOnline": false,
                "roomIndex": null,
                "maxCapacity": 5,
                "roomResource": null, 
                "seatsUsed": 0,
                "departmentSpacesRemaining": null,
                "timeslotId": null,
                "startTime": "2024-11-30T12:00:00Z",
                "endTime": "2024-11-30T14:00:00Z",
                "duration": 120,
                "day": 30
            }
        ],
        "week": 1
    },
    {
        "date": "2024-12-01T00:00:00",
        "hasAvailability": true,
        "availability": [
            {
                "resourceType": "Datetime",
                "resourceParentId": null,
                "resourceId": "12:00 - 14:00",
                "buildingTimezone": null,
                "availableSeats": 5,
                "isOnline": false,
                "roomIndex": null,
                "maxCapacity": 5,
                "roomResource": null,
                "seatsUsed": 0,
                "departmentSpacesRemaining": null,
                "timeslotId": null,
                "startTime": "2024-12-01T12:00:00Z",
                "endTime": "2024-12-01T14:00:00Z",
                "duration": 120,
                "day": 1
            }
        ],
        "week": 2
    }
]

Centre Availability

In This Article

Integration Flow

Listing test centre/room availability

Parameters

Sample request

Request body schema

Sample response

Response schema

Further reading

About the site