appointmentBookingWarnings

Return potential booking issues for an appointment, date, time, repeats, attendees, and provider.

Arguments

appointment_type_id · ID · (optional) appointment type used to check for credits and for appointment duration.

attendee_ids · [ID] · (optional) IDs of clients assigned to the appointment.

date · String · date to check for conflicting events and credit deficits.

is_repeating · Boolean · (optional) whether this is a repeating appointment.

provider_id · ID · ID of the provider to check for conflicting events.

repeat_interval · String · (optional) what type of interval for repeating appointments (Weekly, Monthly, Biweekly, Every 4 Weeks).

repeat_times · String · (optional) how many times the appointment repeats.

recurring_appt_id · String · (optional) used to skip checking for conflicts on recurring appointments.

time · String · The time to check (in conjunction with date parameter) for conflicting events.

timezone · String · (optional) Timezone used when looking for conflicting events. Will default to timezone of provider if not provided.

current_appt_id · String · (optional) used to skip checking for conflicts on single appointments.

is_group_appt · Boolean · (optional) whether an existing appointment being checked is a group appointment or not.

is_editing · Boolean · (optional) whether editing an existing appointment or not.

additional_providers · String · (optional) for group appointments where org members are added as attending

length_in_minutes · Int · (optional) used when checking for conflicts for blocks, which have no appointment type with length

Returns

[AppointmentBookingWarning!]

Example

query appointmentBookingWarnings(
  $appointment_type_id: ID
  $attendee_ids: [ID]
  $date: String
  $is_repeating: Boolean
  $provider_id: ID
  $repeat_interval: String
  $repeat_times: String
  $recurring_appt_id: String
  $time: String
  $timezone: String
  $current_appt_id: String
  $is_group_appt: Boolean
  $is_editing: Boolean
  $additional_providers: String
  $length_in_minutes: Int
) {
  appointmentBookingWarnings(
    appointment_type_id: $appointment_type_id
    attendee_ids: $attendee_ids
    date: $date
    is_repeating: $is_repeating
    provider_id: $provider_id
    repeat_interval: $repeat_interval
    repeat_times: $repeat_times
    recurring_appt_id: $recurring_appt_id
    time: $time
    timezone: $timezone
    current_appt_id: $current_appt_id
    is_group_appt: $is_group_appt
    is_editing: $is_editing
    additional_providers: $additional_providers
    length_in_minutes: $length_in_minutes
  ) {
    category
    potential_issue_ids
    potential_issues
    subtitle
  }
}