Appointment Availability
GET {{baseUrl}}/experimental/health/v0/appointments?filter.clinicId=98989898&filter.typeName=FLU&filter.days=2&page.size=1&page.offset=0
Provides access to all available appointments based on one or more specified clinic locations and an optional appointment reason.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter.clinicId | number | (Required) A single unique identifier for a clinic location, which can be retrieved from the /health/v0/clinics endpoint. | |
filter.typeName | string | The name for for the appointmentType, which is returned in the the /health/v0/clinics endpoint for the selected location. This value as input is case insensitive, but will always be returned in all upper case. | |
filter.days | number | The number of days from today to query. For example, if 3 days are requested, appointments for today, tomorrow, and the following day would be returned. | |
page.size | number | The number of results to return. | |
page.offset | number | The index of the first item to return, using a 0-based index. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept-Language | string | The language or locale accepted by the client application. | |
x-mock-response-code | number | Used to specify the type of response to receive from the mock service. Indicate the desired response code from available codes on this service: 200, 400. |
RESPONSES
status: OK
{"data":[{"id":"82c6b2fb-3184-4e86-82c9-fa33002fdb09","versionKey":"5692cc40af18","typeName":"FLU","clinicId":"98989898","bookingUrl":"enim dolore","startDatetime":{"value":"2021-09-22T10:00Z","timezone":"America/New_York"},"endDatetime":{"value":"2021-09-22T10:30Z","timezone":"America/New_York"}}],"meta":{"page":{"offset":0,"size":1,"hasMore":false}}}