Skip to content
Honeywick Consulting

apptObject

Defines how and when to return selectable appointments.

{
"search": <timeInterval>,
"immediate": <timeInterval>,
"window": <timeInterval>,
"first": <timeInterval>,
"interval": <timeInterval>,
"appts": <integer>,
"limit": <integer> | null,
"ranks": [real],
"mode": PRIMARY | SECONDARY | null,
"virtual": { "search": timeInterval, "available": dowString, "slots": [HH:MM] } | null,
"resource": <bool>,
"strict": <bool>,
"available": <dowString>,
"delayBias": <real>,
"delayBiasPeriod": <timeInterval>,
"useExtended": <bool>,
"useVoluntary": <bool>,
"useStandby": <bool>,
}
immediate timeInterval default 2 hours
Prevents adjusting earliest if an appointment is sooner than this.
window timeInterval default 2 hours
Duration of each generated appointment slot.
first timeInterval default 08:00
Time after midnight when the first appointment window starts.
interval timeInterval default 1 hour
Time between successive appointment windows.
appts integer default 0
Total possible daily appointments.
limit integer
Maximum appointments returned (null = unlimited).
ranks real
Cost thresholds that group ranked appointments (e.g. [0.2, 0.5]).
mode PRIMARY | SECONDARY
Appointment-generation mode.
virtual { "search": timeInterval, "available": dowString, "slots": [HH:MM] }
Virtual fixed-slot appointments — named slots on given days.
resource bool default false
Expose specific-resource vs consolidated options.
strict bool default false
Keep slots within earliest/latest constraints.
available dowString default MTWTFSSX
Days of week available for appointments.
delayBias real default 0.0
Preference weighting toward earlier appointments.
delayBiasPeriod timeInterval default 1 day
Time over which full delay bias applies (50% at this point).
useExtended bool default false
Include extended-time appointments.
useVoluntary bool default false
Include voluntary-time appointments.
useStandby bool default false
Include standby-time appointments.
Section titled “Related”