Appointments GET (ASAP)

For requests or help with our API
Post Reply
PBECKER
Posts: 125
Joined: Mon Jan 03, 2022 11:54 am

Appointments GET (ASAP)

Post by PBECKER » Thu May 12, 2022 7:05 am

API Team

We believe we may have found a limitation on the Appointments GET (ASAP) method.

Scenario: If we runt the GET method it will attempt to return all records that have a priority of ASAP. But...As we know that is a max limit of rows that can be returned.

Proposed Solution: Update Appointments GET (ASAP) method to allow us use from and to date range or increase the number of rows to maybe 1000 rows.

SLeon
Posts: 476
Joined: Mon Mar 01, 2021 10:00 am

Re: Appointments GET (ASAP)

Post by SLeon » Thu May 12, 2022 8:19 am

Our API utilizes pagination for the return of large datasets. Appointments GET ASAP can easily return a very long list of appointments, which is why one of our example requests for that method is "/appointments/ASAP?Offset=200".

From our documentation:
For any method that returns a list of items, you will need to use pagination to get chunks of up to 100 items at a time.
...
If your result is exactly 100 rows, then perform sequential GETs with offsets until your result is less than 100 rows.
More information can be found in the Pagination section on our Implementation page https://www.opendental.com/site/apiimplementation.html.

It is worth noting that an advantage of using our Local API is that it pages results in 1000 count batches, instead of 100.

PBECKER
Posts: 125
Joined: Mon Jan 03, 2022 11:54 am

Re: Appointments GET (ASAP)

Post by PBECKER » Thu May 12, 2022 9:08 am

Hello Sarah!

What if we only would like to see ASAP priority for any records that have today's date and in the future. Meaning we don't want to see any records prior to today's date.

Let me know if this makes sense, my friend!

-Pedro

justine
Posts: 168
Joined: Tue Dec 28, 2021 7:59 am

Re: Appointments GET (ASAP)

Post by justine » Thu May 12, 2022 3:23 pm

Hello Becker,

Our API is designed to mimic Open Dental functionality as closely as possible, thus ensuring database integrity. There is currently no way to filter the ASAP list by date range within Open Dental itself, so the API honors that.

See: https://www.opendental.com/manual/asaplist.html

Appointments GET ASAP will let you filter by Provider and/or Clinic.

See: https://www.opendental.com/site/apiappointments.html

Filtering by Provider and/or Clinic should narrow the list down considerably, but if you're interested in further filtering, we can enhance ASAP to include an appointment status parameter.

Thanks!

Post Reply