Schedule Objects
Last updated
Was this helpful?
Last updated
Was this helpful?
A Schedule Object is a type of App Object with a pre-defined structure intended to capture all relevant information pertaining to a scheduled appointment. Schedule Objects are used in tandem with a ; when a Schedule Object is associated with a scheduler, all relevant information collected by users from the scheduler will be automatically inserted into that Schedule Object in .
A Schedule Object must contain the following six properties:
session_id - that indicates the that the appointment is associated with. This corresponds the Session ID (designated session.id) automatically assigned as a at .
start_time - A that refers to the beginning date and time of the appointment.
end_time - A that refers to the ending date and time of the appointment.
recurrence - A that indexes the block of time selected for the appointment. Count begins at 0 and on the first occurrence of a potential appointment window, as defined by the tied to the associated .
calendar_event_id - that serves as an identifier for the Time Slot (as defined in the – note that this is not the same as the selected block of time which is indicated by recurrence) that defined the selected appointment block.
calendar_id - that serves as an identifier for the particular instance of used to make the appointment. This becomes particularly relevant in cases a contains multiple schedulers associated with the same Schedule Object.