Appointments GET Slots - Return all Providers and all Ops
Posted: Wed Oct 12, 2022 12:16 pm
Hello API team, we have a request:
Request : For the following API call --- GET /appointments/Slots?ProvNum=1&OpNum=18&dateStart=2022-03-28&dateEnd=2022-04-01 we need the ability to gives us results for all providers and with all operatories.
Please let me know.
Thank you so much API team
Appointments GET Slots
Version Added: 21.1
This is closer to how search behaves from within Open Dental instead of WebSched. This requires no advanced setup. It looks at open schedule times, whether the schedules are attached to a provider or an operatory.
There are, however, some differences between this and the Search in Open Dental. This returns entire open slots instead of a series of suggested appointment times or the first appointment time for each day. It also currently searches by entire appointment length instead of the XXX provider times on appointments. For providers assigned to a single operatory, the results will be the same as what a person would see if looking at the Appointments Module. If a provider has existing appointments in multiple operatories, it considers all of them as a whole and only returns slots that are available in all operatories for that provider simultaneously. See also Schedules GET.
Most users will specify a Provider and an Operatory.
Parameters: All parameters are optional.
date: For a single day. Must be today or a future date. Default is the next 14 days.
dateStart, dateEnd: For a date range, inclusive of both dates.
lengthMinutes: This allows ignoring slots that are too small.
ProvNum: Provider. Defaults to the Practice Default Provider.
OpNum: (Added in version 22.1) The operatory that the provider is assigned to.
Example Request:
GET /appointments/Slots?date=2021-02-15
GET /appointments/Slots?date=2022-03-30&ProvNum=50&OpNum=16
GET /appointments/Slots?ProvNum=1&OpNum=18&dateStart=2022-03-28&dateEnd=2022-04-01
Request : For the following API call --- GET /appointments/Slots?ProvNum=1&OpNum=18&dateStart=2022-03-28&dateEnd=2022-04-01 we need the ability to gives us results for all providers and with all operatories.
Please let me know.
Thank you so much API team
Appointments GET Slots
Version Added: 21.1
This is closer to how search behaves from within Open Dental instead of WebSched. This requires no advanced setup. It looks at open schedule times, whether the schedules are attached to a provider or an operatory.
There are, however, some differences between this and the Search in Open Dental. This returns entire open slots instead of a series of suggested appointment times or the first appointment time for each day. It also currently searches by entire appointment length instead of the XXX provider times on appointments. For providers assigned to a single operatory, the results will be the same as what a person would see if looking at the Appointments Module. If a provider has existing appointments in multiple operatories, it considers all of them as a whole and only returns slots that are available in all operatories for that provider simultaneously. See also Schedules GET.
Most users will specify a Provider and an Operatory.
Parameters: All parameters are optional.
date: For a single day. Must be today or a future date. Default is the next 14 days.
dateStart, dateEnd: For a date range, inclusive of both dates.
lengthMinutes: This allows ignoring slots that are too small.
ProvNum: Provider. Defaults to the Practice Default Provider.
OpNum: (Added in version 22.1) The operatory that the provider is assigned to.
Example Request:
GET /appointments/Slots?date=2021-02-15
GET /appointments/Slots?date=2022-03-30&ProvNum=50&OpNum=16
GET /appointments/Slots?ProvNum=1&OpNum=18&dateStart=2022-03-28&dateEnd=2022-04-01