URL | https://<server domain name>/api/core/<version>/AvailabilitySlot/ |
Methods Supported | GET |
Description | Retrieves a set available timeslots within a given date range. |
Required parameters | Type | Description |
startDate | Date | The start date of the period in which to search for free timeslots (yyyy-mm-dd) |
endDate | Date | The end date of the period in which to search for free timeslots (yyyy-mm-dd) |
timezoneId | String(50) | The timezoneId of the time zone for the search. Input times are assumed to be in this time zone, and results are returned in that time zone. See GetLocations to determine the timezoneId for a given location. |
Optional parameters | Type | Description |
specialtyId | String(50) | Search filter: a list of specialties for which to search for available slots. (multiple items can be included for multiple specialties) |
appointmentTypeId | String(50) | The id of the appointment type. (see endpoint “Specialty Types”)When this parameter is given, it will split the available time slots by the appointment type’s time duration. Otherwise the available time slots will not be split. |
practitionerId | String(50) | The Id of the practitioner (see endpoint “Practitioner”) when this parameter is given, it will return slots only for the given practitioner. (multiple practitionerId’s can be included to get slots for multiple practitioners) |
locationId | String(50) | The Id of the location (see endpoint “Location”) when this parameter is given, it will return slots only for the given location. Otherwise all available timeslots will be returned. (multiple locationId’s can be included to get slots for multiple locations) |
pageNumber | Int | The page number of the results to return. The first page is 1, and so on. The results from row 1 to row 50 can be obtained by setting a pageNumber 1 and a pageSize of 50. The results from row 51 to row 100 can be obtained by setting a pageNumber 2 and a pageSize of 50 (default = 1) |
pageSize | Int | The maximum number of rows to return for the page. The pageSize is limited to a maximum of 100 at the time of writing (default = 50) |