archived_at | string or null <date-time> | ||||||||||
arrived | boolean or null | ||||||||||
object | |||||||||||
booking_ip_address | string or null <ipv4> | ||||||||||
cancellation_note | string or null | ||||||||||
cancellation_reason | integer or null | ||||||||||
cancellation_reason_description | string or null Enum: "Feeling Better" "Condition Worse" "Sick" "COVID-19 related" "Away" "Other" "Work" "" | ||||||||||
cancellation_url | string or null <uri> | ||||||||||
cancelled_at | string or null <date-time> | ||||||||||
created_at | string <date-time> | ||||||||||
deleted_at | string or null <date-time> | ||||||||||
email_reminder_sent | boolean or null | ||||||||||
id | string <int64> | ||||||||||
invoice_status | integer or null
| ||||||||||
object | |||||||||||
object | |||||||||||
notes | string or null | ||||||||||
online_booking_policy_accepted | boolean or null | ||||||||||
object | |||||||||||
object | |||||||||||
object | |||||||||||
sms_reminder_sent | boolean or null | ||||||||||
telehealth_url | string or null <uri> | ||||||||||
treatment_note_status | integer or null
| ||||||||||
updated_at | string <date-time> |
{- "archived_at": "2019-08-24T14:15:22Z",
- "arrived": true,
- "booking_ip_address": "10.0.0.43",
- "cancellation_note": "string",
- "cancellation_reason": 0,
- "cancellation_reason_description": "Feeling Better",
- "cancelled_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "email_reminder_sent": true,
- "id": "string",
- "invoice_status": 10,
- "notes": "string",
- "online_booking_policy_accepted": true,
- "sms_reminder_sent": true,
- "treatment_note_status": 10,
- "updated_at": "2019-08-24T14:15:22Z"
}
successful operation
{- "attendees": [
- {
- "archived_at": "2019-08-24T14:15:22Z",
- "arrived": true,
- "booking_ip_address": "10.0.0.43",
- "cancellation_note": "string",
- "cancellation_reason": 0,
- "cancellation_reason_description": "Feeling Better",
- "cancelled_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "email_reminder_sent": true,
- "id": "string",
- "invoice_status": 10,
- "notes": "string",
- "online_booking_policy_accepted": true,
- "sms_reminder_sent": true,
- "treatment_note_status": 10,
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "total_entries": 1,
- "links": {
}
}
Resource was created
Resource could not be saved due to validation errors
{- "booking_id": "1",
- "arrived": true,
- "notes": "string",
- "patient_id": "1",
- "patient_case_id": "1"
}
{- "archived_at": "2019-08-24T14:15:22Z",
- "arrived": true,
- "booking_ip_address": "10.0.0.43",
- "cancellation_note": "string",
- "cancellation_reason": 0,
- "cancellation_reason_description": "Feeling Better",
- "cancelled_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "email_reminder_sent": true,
- "id": "string",
- "invoice_status": 10,
- "notes": "string",
- "online_booking_policy_accepted": true,
- "sms_reminder_sent": true,
- "treatment_note_status": 10,
- "updated_at": "2019-08-24T14:15:22Z"
}
Successful operation
{- "archived_at": "2019-08-24T14:15:22Z",
- "arrived": true,
- "booking_ip_address": "10.0.0.43",
- "cancellation_note": "string",
- "cancellation_reason": 0,
- "cancellation_reason_description": "Feeling Better",
- "cancelled_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "email_reminder_sent": true,
- "id": "string",
- "invoice_status": 10,
- "notes": "string",
- "online_booking_policy_accepted": true,
- "sms_reminder_sent": true,
- "treatment_note_status": 10,
- "updated_at": "2019-08-24T14:15:22Z"
}
Resource was updated
Resource could not be saved due to validation errors
{- "arrived": true,
- "notes": "string",
- "patient_case_id": "1"
}
{- "archived_at": "2019-08-24T14:15:22Z",
- "arrived": true,
- "booking_ip_address": "10.0.0.43",
- "cancellation_note": "string",
- "cancellation_reason": 0,
- "cancellation_reason_description": "Feeling Better",
- "cancelled_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "email_reminder_sent": true,
- "id": "string",
- "invoice_status": 10,
- "notes": "string",
- "online_booking_policy_accepted": true,
- "sms_reminder_sent": true,
- "treatment_note_status": 10,
- "updated_at": "2019-08-24T14:15:22Z"
}
Only attendees of group appointments can be cancelled via this endpoint. Cancelling an individual appointment should be done via the cancel endpoint for individual appointments
Resource was cancelled
{- "cancellation_note": "string",
- "cancellation_reason": 10,
- "apply_to_repeats": true
}
successful operation
{- "attendees": [
- {
- "archived_at": "2019-08-24T14:15:22Z",
- "arrived": true,
- "booking_ip_address": "10.0.0.43",
- "cancellation_note": "string",
- "cancellation_reason": 0,
- "cancellation_reason_description": "Feeling Better",
- "cancelled_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "email_reminder_sent": true,
- "id": "string",
- "invoice_status": 10,
- "notes": "string",
- "online_booking_policy_accepted": true,
- "sms_reminder_sent": true,
- "treatment_note_status": 10,
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "total_entries": 1,
}
successful operation
{- "attendees": [
- {
- "archived_at": "2019-08-24T14:15:22Z",
- "arrived": true,
- "booking_ip_address": "10.0.0.43",
- "cancellation_note": "string",
- "cancellation_reason": 0,
- "cancellation_reason_description": "Feeling Better",
- "cancelled_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "email_reminder_sent": true,
- "id": "string",
- "invoice_status": 10,
- "notes": "string",
- "online_booking_policy_accepted": true,
- "sms_reminder_sent": true,
- "treatment_note_status": 10,
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "total_entries": 1,
}
successful operation
{- "attendees": [
- {
- "archived_at": "2019-08-24T14:15:22Z",
- "arrived": true,
- "booking_ip_address": "10.0.0.43",
- "cancellation_note": "string",
- "cancellation_reason": 0,
- "cancellation_reason_description": "Feeling Better",
- "cancelled_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "email_reminder_sent": true,
- "id": "string",
- "invoice_status": 10,
- "notes": "string",
- "online_booking_policy_accepted": true,
- "sms_reminder_sent": true,
- "treatment_note_status": 10,
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "total_entries": 1,
}