AppointmentTypeNumber for Appointments POST
Posted: Fri Sep 30, 2022 10:51 am
Can we get some guidance on AppointmentTypeNumber for Appointments POST (create)
What values can we pass for AppointmentTypeNumber?
Where is their more rerferene info on how we can utilize AppointmentTypeNumber?
Thank you API team.
Appointments POST (create)
Version Added: 21.1
The following fields cannot be set as part of a POST: AptNum, provAbbr, ProcDescript, and UnschedStatus. Attempts to set them will be silently ignored.
PatNum: Required.
Op: Required.
AptDateTime: Required. String in "yyyy-MM-dd HH:mm:ss". Use Appointments GET Slots to find available times.
AptStatus: Optional. Either "Scheduled", "Complete", "UnschedList", "Planned", or (rarely used) "PtNote", "PtNoteCompleted". Default "Scheduled".
Pattern: Optional. Time pattern in 5 minute increments. A string consisting of 'X' and '/' characters only. Default "/XX/" (20 minutes).
Confirmed: Optional. Definition.DefNum where definition.Category=2. Default is the first definition in that Category.
Note: Optional. Default blank.
ProvNum: Optional. Defaults to the PriProv of the patient, if set, or the dental office's default provider.
ProvHyg: Optional. Default 0.
ClinicNum: Optional. Default is the ClinicNum of the Patient.
IsHygiene: Optional. Default "false".
IsNewPatient: (Added in version 21.3) Optional. Either "true" or "false". Default "false".
Priority: (Added in version 22.1) Optional. Either "Normal" or "ASAP". Default "Normal".
AppointmentTypeNum: (Added in version 22.1) Optional. FK to AppointmentType.AppointmentTypeNum. Default 0 (None). Follows the same logic for adding attached procedures, pattern, and color as in Open Dental. The pattern will only be applied if Pattern is not specified in the request.
What values can we pass for AppointmentTypeNumber?
Where is their more rerferene info on how we can utilize AppointmentTypeNumber?
Thank you API team.
Appointments POST (create)
Version Added: 21.1
The following fields cannot be set as part of a POST: AptNum, provAbbr, ProcDescript, and UnschedStatus. Attempts to set them will be silently ignored.
PatNum: Required.
Op: Required.
AptDateTime: Required. String in "yyyy-MM-dd HH:mm:ss". Use Appointments GET Slots to find available times.
AptStatus: Optional. Either "Scheduled", "Complete", "UnschedList", "Planned", or (rarely used) "PtNote", "PtNoteCompleted". Default "Scheduled".
Pattern: Optional. Time pattern in 5 minute increments. A string consisting of 'X' and '/' characters only. Default "/XX/" (20 minutes).
Confirmed: Optional. Definition.DefNum where definition.Category=2. Default is the first definition in that Category.
Note: Optional. Default blank.
ProvNum: Optional. Defaults to the PriProv of the patient, if set, or the dental office's default provider.
ProvHyg: Optional. Default 0.
ClinicNum: Optional. Default is the ClinicNum of the Patient.
IsHygiene: Optional. Default "false".
IsNewPatient: (Added in version 21.3) Optional. Either "true" or "false". Default "false".
Priority: (Added in version 22.1) Optional. Either "Normal" or "ASAP". Default "Normal".
AppointmentTypeNum: (Added in version 22.1) Optional. FK to AppointmentType.AppointmentTypeNum. Default 0 (None). Follows the same logic for adding attached procedures, pattern, and color as in Open Dental. The pattern will only be applied if Pattern is not specified in the request.