AppointmentInclusionType

Provider/Client to Appointment connection

Fields

appointment · Appointment · The appointment the inclusion is connected to.

attended · Boolean · Indicate whether a group appointment attendee have taken part in the appointment

cancellation_reason · String · The reason for cancellation if the appointment was cancelled

cancelled · Boolean · Indicate if a group appointment attendee cancelled the appointment

cancelled_at · ISO8601DateTime · The timestamp of when the attendee cancelled the appointment

cancelled_by · User · The user who performed the cancellation

cancelled_by_id · ID · The ID of the user who performed the cancellation

confirmed · Boolean · If the client has confirmed the appointment, or don't need to (THIS IS FIELD IS CURRENTLY USED ONLY FOR GROUP APPT's)

external_uuid · ID · The UUID of the appointment inclusion. Can be used in conjunction with appointment settings to allow unauthenticated users to modify an appointment.

id · ID! · required · The unique identifier of the appointment inclusion

join_time · ISO8601DateTime · The datetime that the attendee joined the appointment

leave_time · ISO8601DateTime · The datetime that the attendee left the appointment

other_cancellation_reason · String · The other reason for cancellation if the appointment was cancelled

user · User · Attendee

user_id · ID · Attendee ID

deprecated

Use `user` field

Used By

Appointment.attended_clients

updateAppointmentInclusionPayload.appointment_inclusion

Query.appointmentInclusion

Definition

"""
Provider/Client to Appointment connection
"""
type AppointmentInclusionType {
  """
  The appointment the inclusion is connected to.
  """
  appointment: Appointment

  """
  Indicate whether a group appointment attendee have taken part in the appointment
  """
  attended: Boolean

  """
  The reason for cancellation if the appointment was cancelled
  """
  cancellation_reason: String

  """
  Indicate if a group appointment attendee cancelled the appointment
  """
  cancelled: Boolean

  """
  The timestamp of when the attendee cancelled the appointment
  """
  cancelled_at: ISO8601DateTime

  """
  The user who performed the cancellation
  """
  cancelled_by: User

  """
  The ID of the user who performed the cancellation
  """
  cancelled_by_id: ID

  """
  If the client has confirmed the appointment, or don't need to (THIS IS FIELD IS CURRENTLY USED ONLY FOR GROUP APPT's)
  """
  confirmed: Boolean

  """
  The UUID of the appointment inclusion. Can be used in conjunction with appointment settings to allow unauthenticated users to modify an appointment.
  """
  external_uuid: ID

  """
  The unique identifier of the appointment inclusion
  """
  id: ID!

  """
  The datetime that the attendee joined the appointment
  """
  join_time: ISO8601DateTime

  """
  The datetime that the attendee left the appointment
  """
  leave_time: ISO8601DateTime

  """
  The other reason for cancellation if the appointment was cancelled
  """
  other_cancellation_reason: String

  """
  Attendee
  """
  user: User

  """
  Attendee ID
  """
  user_id: ID @deprecated(reason: "Use `user` field")
}