Search provider availability slots for VA returning a ProviderAvailabilityVA object

get

https://api.talkdeskapp.com/healthcare/available-appointments-va

Search provider available appointment slots using interactionId returning one ProviderAvailabilityVA object only. If the search finds multiple slots a ProviderAvailabilityVA object is returned with its remaining property pointing to the number of results found (not considering the one returned) and the closest slot. If no slots are found then the remaining property returns -1.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

hls-provider:read

Query Params

interaction_id

string

required

length between 1 and 2147483647

Required interaction Id

provider_id

string

required

length between 1 and 2147483647

Healthcare provider identification

service_type_id

string

required

length between 1 and 2147483647

Healthcare service type identification

location_id

string

required

length between 1 and 2147483647

Healthcare location identification

count

integer

1 to 50

Defaults to 1

Number of slots to fetch

max_days

integer

1 to 30

Defaults to 30

Number of days to consider

preferred_time

string

enum

Preferred slot time

Allowed:

preferred_week_day

string

enum

Preferred slot week day

Allowed:

preferred_month

string

enum

Preferred slot month

timezone

string

length between 1 and 2147483647

Timezone from this interaction and must respect this format America/Chicago.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Scope

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

405Method Not Allowed

415Unsupported Media Type