List Vacancies in a Calendar

Lists the vacant time slots in a calendar for an appointment of the specified service type.

This endpoint requires the Appointments Manager role.

URL

GET: .../{applicationId}/calendars/{serviceId}/{date}/{cuIndex}/vacancies?serviceTypeId=<service-type-id>

Headers

Authorization: Bearer <accessToken>

Route Params

• serviceId: GUID, required.

• date: date in YYYY-MM-dd format; required.

• cuIndex: the calendar's unique identifier

Query Params

• serviceTypeId: GUID, required

Response

Success -> 200

Returns a list of vacant time slots.

The slot number indicates the appointment start time, representing the minutes elapsed since midnight.

For example, time slot 480 represents 8:00 am.

{
  "serviceTypeId": "<GUID>",
  "serviceTypeName": "Service Type Name",
  "duration": 10, // the time slots duration in minutes
  "slots": [
    800, 
    810,
    ...
  ]
}