Name | Description | Type | Additional information |
---|---|---|---|
ProcessId |
Process ID populated after creating appointment successfully. Ignored if set prior. This is the best internal reference to the appointment. Must be used for all internal references to the appointment. |
integer |
None. |
CaseId |
Case ID populated after creating appointment successfully. Ignored if set prior. This is typically used as the booking reference as it is the easiest number to reference and see in QFlow. |
integer |
None. |
ServiceId |
Service ID which the calendar is attached to. |
integer |
Required |
AppointmentDateTime |
Appointment Date and Time (or start date if BookFirstAvailable = true) |
date |
Required |
CustomerId |
Customer ID |
integer |
Required |
AppointmentTypeId |
Appointment Type ID. If you pass 0 or didn't pass anything, then system will get the first appointment type for the Service. If this is the case, this parameter will be set by the system in the return object. |
integer |
None. |
Subject |
Subject |
string |
Max length: 150 |
Notes |
Notes |
string |
Max length: 4000 |
ExtRef |
Case External Reference |
string |
Max length: 200 |
Classifications |
List of Classification Codes |
Collection of string |
Max length: 20 |
LanguageCode |
Language Code |
string |
Max length: 6 |
ReservedSlotId |
Pre-Reserved Slot Id (aka Slot Ordinal Number) |
integer |
None. |
UserId |
User Id of creator (typically 1 = System Admin/API) |
integer |
None. |
BookFirstAvailable |
Book First Available slot. AppointmentDateTime=start date; DaysToSearch=Days to look ahead |
boolean |
None. |
DaysToSearch |
If BookFirstAvailableDay=true, check this number of days to look ahead for vacancies |
integer |
None. |
BookFirstAvailMondays |
If BookFirstAvailableDay=true, check Mondays in the search for first available |
boolean |
None. |
BookFirstAvailTuesdays |
If BookFirstAvailableDay=true, check Tuesdays in the search for first available |
boolean |
None. |
BookFirstAvailWednesdays |
If BookFirstAvailableDay=true, check Wednesdays in the search for first available |
boolean |
None. |
BookFirstAvailThursdays |
If BookFirstAvailableDay=true, check Thursdays in the search for first available |
boolean |
None. |
BookFirstAvailFridays |
If BookFirstAvailableDay=true, check Fridays in the search for first available |
boolean |
None. |
BookFirstAvailSaturdays |
If BookFirstAvailableDay=true, check Saturdays in the search for first available |
boolean |
None. |
BookFirstAvailSundays |
If BookFirstAvailableDay=true, check Sundays in the search for first available |
boolean |
None. |
CustomProperties |
Collection of all custom properties for this appointment process |
Dictionary of string [key] and string [value] |
None. |