Skip to main content

AvailableTypesResponse

Description

This is the format of the response you will receive for a AvailableTypes query.

API endpoints for AvailableTypesResponse

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/scheduling/availabletypes-response.

Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.

Data Model JSON for AvailableTypesResponse​

AvailableTypesResponse - Sample Payload
{
    "Meta": {
        "DataModel": "Scheduling",
        "EventType": "AvailableTypesResponse",
        "EventDateTime": "2022-08-16T14:21:20.733Z",
        "Test": true
    },
    "AppointmentType": [
        {
            "ID": "1234",
            "Name": "Office Visit",
            "Code":"OV",
            "ClassID":null,
            "ClassName":null,
            "BlockSchedule":null,
            "Duration": "10",
            "Reason": "Follow Up"
        }
    ]
}