Search found 197 matches

by SLeon
Thu Aug 11, 2022 12:46 pm
Forum: API
Topic: Python Connector
Replies: 1
Views: 33

Re: Python Connector

The great part about the Open Dental API is that it can be used by any REST client. If a program can make a RESTful web call, it can utilize our API. For example, you can use Python to make API calls by importing the 'requests' library.
by SLeon
Tue Aug 09, 2022 8:50 am
Forum: API
Topic: API Request
Replies: 1
Views: 58

Re: API Request

We can add these to our development list. For #2, we have recently added an Adjustments GET resource (https://www.opendental.com/site/apiadjustments.html). Are there additional details you would like us to add to this method?
by SLeon
Tue Aug 09, 2022 8:05 am
Forum: API
Topic: GET APIProcedureLogs
Replies: 1
Views: 34

Re: GET APIProcedureLogs

I have just added/completed a procedure to our public demo dental office (ProcNum 48). It appears in my list of results when I use a past date filter (2022-08-01 12:00:00) but not when I use a future date (2023-02-07 11:32:50 from your example). Run the following requests with our public testing cre...
by SLeon
Tue Aug 09, 2022 7:43 am
Forum: API
Topic: GET ApiProcedureLogs
Replies: 2
Views: 90

Re: GET ApiProcedureLogs

Good morning,

Because these fields come from different tables and require many calculations, a query may be your best bet. I would recommend using Query #740 from https://opendentalsoft.com:1943/ODQuery ... yList.aspx as a starting place.
by SLeon
Thu Aug 04, 2022 8:19 am
Forum: API
Topic: Max 100
Replies: 17
Views: 572

Re: Max 100

I am glad you got the Local API up and running. One of the benefits of the Local API is that you do not need to open a firewall because it is a localhost request. This is in addition to the greatly increased speed, not requiring continuous internet connection, and absolutely zero set up besides laun...
by SLeon
Wed Aug 03, 2022 8:11 am
Forum: API
Topic: Max 100
Replies: 17
Views: 572

Re: Max 100

To use the Local API, please follow the steps listed on https://www.opendental.com/site/apilocal.html . I suspect that an instance of Open Dental is not running on the machine. I was able to replicate your exact error message when I closed my instance of Open Dental. Try launching Open Dental and se...
by SLeon
Wed Jul 27, 2022 11:05 am
Forum: API
Topic: Need help with Procedure Status
Replies: 1
Views: 83

Re: Need help with Procedure Status

There are 8 different ProcStatuses, listed here in our database schema . The API only mentions TP and C in the Procedurelogs POST method because we only allow the creation of these types of procedures with the API. All procedures are returned in Procedurelogs GET, regardless of their ProcStatuses.
by SLeon
Wed Jul 27, 2022 9:06 am
Forum: API
Topic: Ask to Arrive Early
Replies: 6
Views: 171

Re: Ask to Arrive Early

Yes. When completed, this new feature will be released to our beta version (22.2.XX). I will reply to this post then with the exact version it is in.
by SLeon
Wed Jul 27, 2022 7:48 am
Forum: API
Topic: Ask to Arrive Early
Replies: 6
Views: 171

Re: Ask to Arrive Early

I would estimate that this feature request will be completed within the next week or so.
by SLeon
Tue Jul 26, 2022 12:05 pm
Forum: API
Topic: New API endpoint
Replies: 8
Views: 484

Re: New API endpoint

The easiest way to get the procedure and procedure note information together is with the existing ChartModules GET ProgNotes method. If you don't need as much information about the procedure itself, just the note, we can add a ProcNotes GET to our development list.
by SLeon
Mon Jul 25, 2022 8:23 am
Forum: API
Topic: New API endpoint
Replies: 8
Views: 484

Re: New API endpoint

The first of the procedure note features is complete. A new method, ProcNotes POST, adds a note to a procedure. This method will be available in our next beta version, 22.2.23, which is estimated to be released within the next week. See https://www.opendental.com/site/apiprocnotes.html for more info...
by SLeon
Thu Jul 21, 2022 8:12 am
Forum: API
Topic: Max 100
Replies: 17
Views: 572

Re: Max 100

This feature request is complete. The Reports GET Aging method can now optionally filter results by ClinicNum (if clinics are enabled for the dental office). This feature is available now in our latest beta version, 22.2.21. For more information please see https://www.opendental.com/site/apireports....
by SLeon
Fri Jul 15, 2022 7:58 am
Forum: Developers
Topic: API Service Unable to connect
Replies: 9
Views: 447

Re: API Service Unable to connect

After reaching out to the developer directly, this issue as been resolved. We strongly recommend beta customers update to version 22.2.16 or later to install the Open Dental API Service. Additional information on Manual Installation of the Service has been added to our API Modes - Local and Service ...
by SLeon
Thu Jul 14, 2022 8:26 am
Forum: Developers
Topic: API Service Unable to connect
Replies: 9
Views: 447

Re: API Service Unable to connect

I see. The API Service was only added to our beta in version 22.2.13, which is why your second machine does not have the OpenDentalAPIService folder. The automatic installation of the API Service (and many other improvements) became available in 22.2.16. I strongly recommend you update machine #1 to...
by SLeon
Thu Jul 14, 2022 8:21 am
Forum: API
Topic: Max 100
Replies: 17
Views: 572

Re: Max 100

There are a couple items on our development list in front of your request, however I would estimate that this will be completed in the next week or so.
by SLeon
Thu Jul 14, 2022 8:14 am
Forum: API
Topic: Max 100
Replies: 17
Views: 572

Re: Max 100

1) I am sorry, let me clarify. You can already use the /reports/Aging endpoint to get 1000 results at a time when you use the Local or Service API (which runs on customers machines). 2) We will happily add the ability to filter the Aging report by ClinicNum. I have added this to our development list.
by SLeon
Wed Jul 13, 2022 3:02 pm
Forum: Developers
Topic: API Service Unable to connect
Replies: 9
Views: 447

Re: API Service Unable to connect

Which version of Open Dental are you using? For reference, the OpenDentalAPIService.exe is located in the \\OpenDental\OpenDentalAPIService directory.
by SLeon
Wed Jul 13, 2022 12:54 pm
Forum: Developers
Topic: API Service Unable to connect
Replies: 9
Views: 447

Re: API Service Unable to connect

The OpenDentalAPIService is automatically installed and started when the Open Dental software is updated to version 22.2.16 or later. If you are on this version or later, you can manually install the Service the same way you would the eConnector: On your server, launch Open Dental as Administrator. ...
by SLeon
Wed Jul 13, 2022 10:36 am
Forum: Developers
Topic: API Service Unable to connect
Replies: 9
Views: 447

Re: API Service Unable to connect

It sounds like you are on the right track. Could you please confirm a few things about your setup? Confirm the the API Service is installed on the server machine. It appears as OpenDentalAPIService in the Windows Service Manager. If installed, in this same window make sure the Service is running (or...
by SLeon
Wed Jul 13, 2022 9:17 am
Forum: API
Topic: New API endpoint
Replies: 8
Views: 484

Re: New API endpoint

The ability to create Procedure and Group notes are currently at the top of our development list. I would estimate that these will be completed in the next week or so.
by SLeon
Wed Jul 13, 2022 8:28 am
Forum: API
Topic: Refered From Post Method
Replies: 1
Views: 128

Re: Refered From Post Method

You can attach a referral source to a patient via the API by using RefAttaches POST (https://www.opendental.com/site/apirefattaches.html). To see a list of the dental office's referral sources, use Referrals GET (https://www.opendental.com/site/apireferrals.html). Do you need an endpoint to create n...
by SLeon
Wed Jul 13, 2022 7:59 am
Forum: API
Topic: Max 100
Replies: 17
Views: 572

Re: Max 100

The number of elements returned for an API request is determined by the Limit parameter. The default and maximum value for the Remote API is 100 elements and is 1000 elements for the Local and Service API modes. The API supports paging and you can use the Offset parameter to specify where in the res...
by SLeon
Tue Jul 12, 2022 4:01 pm
Forum: API
Topic: API Request - Practice Info GET
Replies: 2
Views: 167

Re: API Request - Practice Info GET

Yes, these data are stored as entries in our preference table and so you can retrieve them through the API with either Preferences GET or Queries PUT ShortQuery. The names of the preferences you are after are "PracticeTitle", "PracticePhone", and "PracticeAddress", respectively.
by SLeon
Mon Jul 11, 2022 2:06 pm
Forum: Advanced Topics
Topic: Creating tables and triggers in the Open Dental database
Replies: 4
Views: 356

Re: Creating tables and triggers in the Open Dental database

Open Dental does not support third parties manipulating customers' databases. From the Plugins page you linked in your post: Plug-ins and raw external queries should never be used to insert information into the database. This includes triggers and the addition of new tables into the database. Develo...
by SLeon
Fri Jul 08, 2022 10:41 am
Forum: API
Topic: API Key as Custom Bridge command line arg
Replies: 5
Views: 345

Re: API Key as Custom Bridge command line arg

Yes. If a customer's API Key has been disabled by the developer, any API request will return "401 - API key has been disabled by the developer". The apikey table in the customer's database will still, however, contain this disabled key for a period of time. Their local table is refreshed whenever th...
by SLeon
Fri Jul 08, 2022 9:31 am
Forum: API
Topic: API Key as Custom Bridge command line arg
Replies: 5
Views: 345

Re: API Key as Custom Bridge command line arg

The query can be run outside of the API. As the developer, you should be able to view all of your customer's API Keys when you are logged in to the Developer Portal website. Because you have to generate and give this key to the customer, most developers will also enter this into their software when ...
by SLeon
Thu Jul 07, 2022 9:28 am
Forum: API
Topic: API Setup in Australia
Replies: 5
Views: 364

Re: API Setup in Australia

Yes, the eConnector is required to use our eServices. Open Dental supports eServices in Australia. The eConnector is also required for the API. It is not required to sign up for eServices to use our API. The eConnector is included and kept up-to-date when the Open Dental program is updated. You can ...
by SLeon
Thu Jul 07, 2022 8:21 am
Forum: API
Topic: API Key as Custom Bridge command line arg
Replies: 5
Views: 345

Re: API Key as Custom Bridge command line arg

Because a dental office could be using multiple third party software programs, and therefore be associated with multiple API keys, we cannot simply add API Key as a Replacement Field to the Program Link Output File window. You can query this information directly from the customer's database, however...
by SLeon
Wed Jul 06, 2022 8:56 am
Forum: API
Topic: API Setup in Australia
Replies: 5
Views: 364

Re: API Setup in Australia

Yes, the API Setup page is the correct place to start. Our API servers are located here at Open Dental headquarters, which simply means all API traffic is routed through there. All API requests are sent to http://api.opendental.com/api/v1/..., processed at our servers, then travel via eConnector to ...
by SLeon
Tue Jul 05, 2022 11:42 am
Forum: API
Topic: API Setup in Australia
Replies: 5
Views: 364

Re: API Setup in Australia

Could you please clarify what you mean by "register OD APIs with Open Dental headquarters in the US"? We have customers using our API from outside the United States, and indeed, outside North America.
by SLeon
Tue Jul 05, 2022 9:53 am
Forum: API
Topic: eConnector Services starts failing making several requests close together
Replies: 7
Views: 683

Re: eConnector Services starts failing making several requests close together

Yes, you have that right. The eConnector would not be overwhelmed with requests. You can hand over any number of API requests without worrying about the traffic's impact.
by SLeon
Tue Jul 05, 2022 7:57 am
Forum: API
Topic: New API endpoint
Replies: 8
Views: 484

Re: New API endpoint

Thank you for your feature request, I have added it to our development list. We will plan to support the creating, reading, and modification of Procedure and Group notes through the API. Development will begin on these shortly.
by SLeon
Thu Jun 30, 2022 12:53 pm
Forum: API
Topic: eConnector Services starts failing making several requests close together
Replies: 7
Views: 683

Re: eConnector Services starts failing making several requests close together

The throttle rate I mentioned in my previous post occurs entirely on Open Dental API servers' side. The request is verified upon arrival and throttled at that point. This therefore translates into the response being throttled downstream. The eConnector's activity will be quite light even for older m...
by SLeon
Fri Jun 24, 2022 1:19 pm
Forum: API
Topic: Appointments GET Request to add duration and procedure number(s)
Replies: 2
Views: 379

Re: Appointments GET Request to add duration and procedure number(s)

A new method ChartModules GET PlannedAppts has been completed and will facilitate scheduling appointments with Appointments POST SchedulePlanned. It will display the complete list of Planned appointments as seen in the Chart Module in Open Dental. See https://www.opendental.com/site/apichartmodules....
by SLeon
Tue Jun 21, 2022 9:09 am
Forum: API
Topic: Having Issues triggering subscriptions
Replies: 3
Views: 409

Re: Having Issues triggering subscriptions

After reaching out to this user directly, we found there are sometimes issues with the Zapier webhook system processing hooks. Details here https://zapier.com/help/troubleshoot/behavior/zap-isnt-receiving-webhooks#inspect-the-request-data. They recommend confirming this by testing with a non-Zapier ...
by SLeon
Fri Jun 17, 2022 3:58 pm
Forum: API
Topic: API General Update Request | Include TimeZone on all datetimes
Replies: 3
Views: 540

Re: API General Update Request | Include TimeZone on all datetimes

In an effort to support many different type of DateTime formats, we have added a new URL parameter for API requests called DateTimeFormatString. This parameter is available for all API requests and will allow developers to fully customize the way all returned DateTimes (dates in "yyyy-MM-dd HH:mm:ss...
by SLeon
Fri Jun 17, 2022 2:58 pm
Forum: API
Topic: Having Issues triggering subscriptions
Replies: 3
Views: 409

Re: Having Issues triggering subscriptions

Just now with a test dental office, I first made a Subscription POST request that looked like this: { "EndPointUrl": "https://webhook.site/.../", "WatchTable": "Patient", "PollingSeconds": 3 } Then I logged into Open Dental for that dental office. Open Dental must be running to process Events. Next ...
by SLeon
Fri Jun 17, 2022 9:12 am
Forum: API
Topic: Scheduling a Planned Appointment
Replies: 4
Views: 416

Re: Scheduling a Planned Appointment

We have just completed a new API method to schedule a Planned appointment: Appointments POST SchedulePlanned. The recommended workflow for scheduling is as follows: 1. Get the AptNum of the Planned appointment you would like to schedule. This can be done with Appointments GET (single/multiple), Char...
by SLeon
Mon Jun 13, 2022 3:05 pm
Forum: API
Topic: Scheduling a Planned Appointment
Replies: 4
Views: 416

Re: Scheduling a Planned Appointment

We will begin implementation of both of these methods by the end of this week.
by SLeon
Mon Jun 13, 2022 11:07 am
Forum: API
Topic: Scheduling a Planned Appointment
Replies: 4
Views: 416

Re: Scheduling a Planned Appointment

Using a Planned appointment to make a Scheduled appointment has many moving parts. Appointments PUT (update) does not provide all of the functionality you would need. Open Dental makes a second appointment (Scheduled) and retains the original (Planned) appointment. This relationship is linked via th...
by SLeon
Mon Jun 13, 2022 11:07 am
Forum: API
Topic: Appointments GET Request to add duration and procedure number(s)
Replies: 2
Views: 379

Re: Appointments GET Request to add duration and procedure number(s)

It appears the information you are after is displayed in the Planned Appointments Tab in the Chart Module (https://opendental.com/manual/apptplanned.html. We can create an API method (ChartModules GET PlannedAppts) to return the information in this grid, as well as the AptNum and ProcNums for the pr...
by SLeon
Fri Jun 10, 2022 9:38 am
Forum: API
Topic: Appointment's UnschedStatus
Replies: 2
Views: 339

Re: Appointment's UnschedStatus

We have added the ability to update the UnschedStatus field in Appointments PUT (update). We have also added the field to the return objects of our Appointments GET method. See https://www.opendental.com/site/apiappointments.html for more information. The new field will be available in our next beta...
by SLeon
Mon Jun 06, 2022 11:06 am
Forum: API
Topic: Questions related to Subscriptions
Replies: 1
Views: 299

Re: Questions related to Subscriptions

For database events, any change to the specified table will cause an event to fire. This will occur at the interval specified in the PollingSeconds field. It is important to note that the EndPointUrl of the subscription must have a trailing '/' character. The WorkStation is the name of the machine u...
by SLeon
Thu Jun 02, 2022 10:12 am
Forum: API
Topic: eConnector Services starts failing making several requests close together
Replies: 7
Views: 683

Re: eConnector Services starts failing making several requests close together

That is correct, you should not have to limit the quantity or frequency of requests at any point. If you are utilizing the remote API endpoint (https://api.opendental.com) you may bump into our throttle rate, but throttled requests are simply delayed not failed. It is worth noting that our Local API...
by SLeon
Thu Jun 02, 2022 9:05 am
Forum: API
Topic: Appointment's UnschedStatus
Replies: 2
Views: 339

Re: Appointment's UnschedStatus

Yes, we can add support for editing UnschedStatus to Appointments PUT (update). It has has been added to our development list.
by SLeon
Thu Jun 02, 2022 8:56 am
Forum: API
Topic: eConnector Services starts failing making several requests close together
Replies: 7
Views: 683

Re: eConnector Services starts failing making several requests close together

The API has been carefully designed to scale and handle an extremely high volume of traffic. At the dental office level, the eConnector is the only theoretical limitation on throughput. That being said, the eConnector is designed to handle such a high level of traffic that customers should never be ...
by SLeon
Fri May 20, 2022 1:45 pm
Forum: API
Topic: How to: Post to public webhook?
Replies: 9
Views: 974

Re: How to: Post to public webhook?

There appeared to be a small issue where more than one workstation could fire a database event. This has been fixed and will be available in version 22.1.32.
by SLeon
Fri May 20, 2022 10:21 am
Forum: API
Topic: Appointment Types?
Replies: 6
Views: 860

Re: Appointment Types?

We have completed this feature request. Appointments GET (single/multiple) will now display the AppointmentTypeNum for the appointment type. Our Appointments POST (create) and PUT (update) methods also support assigning an appointment type in the JSON body. These methods will be available staring in...
by SLeon
Thu May 19, 2022 9:48 am
Forum: API
Topic: API General Update Request | Include TimeZone on all datetimes
Replies: 3
Views: 540

Re: API General Update Request | Include TimeZone on all datetimes

The addition of time zone information has been added to our development list. The output string will be in "yyyy-MM-dd HH:mm:sszzz" format, and so will appear as "2022-05-19 09:42:45-07:00". Our plan is to toggle on the time zone information with a URL parameter. This will allow developers to opt in...
by SLeon
Wed May 18, 2022 11:01 am
Forum: API
Topic: How to: Post to public webhook?
Replies: 9
Views: 974

Re: How to: Post to public webhook?

Thank you, I am actively looking into this issue.
by SLeon
Tue May 17, 2022 11:04 am
Forum: API
Topic: How to: Post to public webhook?
Replies: 9
Views: 974

Re: How to: Post to public webhook?

All appointments that changed since the last poll will be included in a single payload. For example, if five appointments have been changed within the poll interval, then a single payload containing a list of five appointments will be sent.
by SLeon
Mon May 16, 2022 1:25 pm
Forum: API
Topic: How to: Post to public webhook?
Replies: 9
Views: 974

Re: How to: Post to public webhook?

1. The change to the appointment can be done within Open Dental or via the API.

2. The endpoint does not need to be local. We were able to use webhook.site successfully.

It is worth noting that Open Dental has to be running to send the results.
by SLeon
Mon May 16, 2022 12:16 pm
Forum: API
Topic: How to: Post to public webhook?
Replies: 9
Views: 974

Re: How to: Post to public webhook?

API Events and Subscriptions are indeed how you would go about this. (https://www.opendental.com/site/apisubscriptions.html) 1. Send a Subscriptions POST request similar to below: (Note the trailing '/') { "EndPointUrl": "https://webhook.site/.../", "WatchTable": "Appointment", "PollingSeconds": 60 ...
by SLeon
Thu May 12, 2022 8:19 am
Forum: API
Topic: Appointments GET (ASAP)
Replies: 3
Views: 506

Re: Appointments GET (ASAP)

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, yo...
by SLeon
Mon May 09, 2022 8:57 am
Forum: API
Topic: Request-Blockouts
Replies: 1
Views: 357

Re: Request-Blockouts

Blockouts are a type of Schedule. You can currently get detailed information on blockouts with our Schedules GET method (https://www.opendental.com/site/apischedules.html). Specify "SchedType=Blockout" along with a date range and you will see all blockouts for that period. Blockout Types are a defin...
by SLeon
Wed May 04, 2022 10:26 am
Forum: Main Forum
Topic: Patient notes through API
Replies: 6
Views: 1253

Re: Patient notes through API

Sorry for the delay in replying. When you access the API's Developer website, do you see the box next to ApiReadAll checked under your list of permissions? The permissions for the API are different than those used for FHIR.
by SLeon
Mon May 02, 2022 8:23 am
Forum: API
Topic: Medicaid vs Non Medicaid Patients
Replies: 5
Views: 784

Re: Medicaid vs Non Medicaid Patients

The development for Patients GET (single) and Patients GET Simple will begin quite shortly and should be available rather soon.
by SLeon
Thu Apr 28, 2022 3:26 pm
Forum: API
Topic: Appointment Types?
Replies: 6
Views: 860

Re: Appointment Types?

Right now you can send the following JSON to api.opendental.com/api/via/queries/ShortQuery to get a list of appointment types for the dental office. { "SqlCommand":"SELECT * FROM appointmenttype" } You will get back something like this: { "AppointmentTypeNum": 1, "AppointmentTypeName": "WebSched New...
by SLeon
Thu Apr 28, 2022 2:53 pm
Forum: API
Topic: API Feature Request | Update Allergies/Diseases/Medications
Replies: 8
Views: 1089

Re: API Feature Request | Update Allergies/Diseases/Medications

Our current beta version will become our stable version within the next month or two.
by SLeon
Thu Apr 28, 2022 2:45 pm
Forum: API
Topic: Medicaid vs Non Medicaid Patients
Replies: 5
Views: 784

Re: Medicaid vs Non Medicaid Patients

I have added including the MedicaidID field to our Patients GET (single), Patients GET Simple, Patients POST, and Patients PUT methods to our development list.
by SLeon
Thu Apr 28, 2022 2:22 pm
Forum: API
Topic: Appointment Types?
Replies: 6
Views: 860

Re: Appointment Types?

Appointment Types are stored in their own table (appointmenttype). You can use Queries PUT ShortQuery to see the list of appointment types created by the dental office. We will add "AppointmentType" as one of the fields that can be included when creating and modifying appointments. The method Appoin...
by SLeon
Mon Apr 25, 2022 8:14 am
Forum: API
Topic: API Feature Request | Update Allergies/Diseases/Medications
Replies: 8
Views: 1089

Re: API Feature Request | Update Allergies/Diseases/Medications

The final requested feature, MedicationPats PUT is complete and available now in version 22.1.23.

Please see https://www.opendental.com/site/apimedicationpats.html for more information on this method.
by SLeon
Fri Apr 22, 2022 3:48 pm
Forum: API
Topic: API Request
Replies: 19
Views: 3713

Re: API Request

The final requested feature has been completed:

1. Defintions POST will allow the creation of new Definitions. See https://www.opendental.com/site/apidefinitions.html for more information.
2-7. (Previously completed)

This new method is available now in version 22.1.24.
by SLeon
Thu Apr 21, 2022 9:55 am
Forum: API
Topic: Aging A/R - API
Replies: 3
Views: 591

Re: Aging A/R - API

If you are open to using a query, I believe Query #159 posted on our Query Page would give you the information you need. This could be used with our Queries PUT ShortQuery API method for each patient.
by SLeon
Tue Apr 19, 2022 8:35 am
Forum: API
Topic: Aging A/R - API
Replies: 3
Views: 591

Re: Aging A/R - API

There is not yet an API method that will return an account breakdown for a patient. Currently, you can get a patient's total balance with AccountModules GET PatientBalances, but this does not itemize the individual charges by procedure. We will work on adding a method for you to retrieve this detail...
by SLeon
Thu Apr 14, 2022 1:19 pm
Forum: API
Topic: Requests for new API endpoints and new fields for an existing endpoint
Replies: 21
Views: 3982

Re: Requests for new API endpoints and new fields for an existing endpoint

The Priority field has been added as an optional field in the Appointments POST (create) and Appointments PUT (update) methods. This will be available in our next beta version 22.1.22, which is estimated to be released within the next week. For more information on own Appointments methods, see https...
by SLeon
Wed Apr 13, 2022 10:03 am
Forum: API
Topic: API Feature Request | Update Allergies/Diseases/Medications
Replies: 8
Views: 1089

Re: API Feature Request | Update Allergies/Diseases/Medications

1a. Diseases DELETE is complete and is available now in version 22.1.21. See https://www.opendental.com/site/apidiseases.html. 1b. Diseases PUT is complete and will be available in version 22.1.22. This version is expected to be released within the next week. 2. Allergies PUT and DELETE are complete...
by SLeon
Wed Apr 13, 2022 9:48 am
Forum: API
Topic: Document Category clarification
Replies: 12
Views: 1764

Re: Document Category clarification

I see in another thread that you made it possible to send a Date Created usingthe sftp Upload method. Is it possible for Date Created to be added for the regular POST Upload method? DateCreated has been added as an optional field in Documents POST Upload. This will be available in version 22.1.21. ...
by SLeon
Wed Apr 13, 2022 9:47 am
Forum: API
Topic: New API Request
Replies: 6
Views: 1152

Re: New API Request

The last feature request is complete.

Claims DELETE will delete a claim via ClaimNum. This method is available in 22.1.21. For more information see https://www.opendental.com/site/apiclaims.html.
by SLeon
Tue Apr 12, 2022 9:03 am
Forum: API
Topic: API Feature Request | Update Allergies/Diseases/Medications
Replies: 8
Views: 1089

Re: API Feature Request | Update Allergies/Diseases/Medications

Of course. All six of these methods are currently in development. I expect them to be available relatively shortly.
by SLeon
Tue Apr 12, 2022 9:01 am
Forum: API
Topic: Customer API key return data issue
Replies: 11
Views: 1446

Re: Customer API key return data issue

Subsequently installed eConnectors fail silently and preserve the connection of the original, valid eConnector. This is helpful in many cases, for example, if another workstation at the dental office accidentally tries to install a second eConnector. This erroneous eConnector does not disrupt the es...
by SLeon
Mon Apr 11, 2022 12:20 pm
Forum: API
Topic: Requests for new API endpoints and new fields for an existing endpoint
Replies: 21
Views: 3982

Re: Requests for new API endpoints and new fields for an existing endpoint

Yes, we can add the Priority field in Appointments PUT and POST. This has been added to our development list.
by SLeon
Mon Apr 11, 2022 9:35 am
Forum: API
Topic: Customer API key return data issue
Replies: 11
Views: 1446

Re: Customer API key return data issue

I understand your concern. Multiple offices using a single registration key should never happen in production. Each Open Dental customer must use a unique registration key and should not be shared with other customers. Many issues will arise if one dental office is trying to use another office's the...
by SLeon
Fri Apr 08, 2022 3:58 pm
Forum: API
Topic: API Request-Blockouts
Replies: 8
Views: 1771

Re: API Request-Blockouts

Schedules can now be retrieved by their primary key through the API with Schedules GET (single).

This is available in version 22.1.19. Please see https://www.opendental.com/site/apischedules.html for more information.
by SLeon
Fri Apr 08, 2022 11:25 am
Forum: API
Topic: Customer API key return data issue
Replies: 11
Views: 1446

Re: Customer API key return data issue

You can send an email to vendor.relations at opendental.com, and they can get you set up.
by SLeon
Thu Apr 07, 2022 11:24 am
Forum: API
Topic: Customer API key return data issue
Replies: 11
Views: 1446

Re: Customer API key return data issue

I understand that you have three different environments, machines, and databases, but it sounds like you are only using one registration key, correct? A registration key and eConnector share a one to one relationship. To use three different databases, each would need it's own registration key, eConn...
by SLeon
Wed Apr 06, 2022 3:04 pm
Forum: API
Topic: API Feature Request | Update Allergies/Diseases/Medications
Replies: 8
Views: 1089

Re: API Feature Request | Update Allergies/Diseases/Medications

Both PUT and DELETE methods have been added to our development list for Allergies, Diseases, and MedicationPats.
by SLeon
Wed Apr 06, 2022 9:27 am
Forum: API
Topic: New API Request
Replies: 6
Views: 1152

Re: New API Request

Two of these requested features are complete. 1. Claims PUT now allows setting the AccidentDate field of claims. See https://www.opendental.com/site/apiclaims.html for more information. 2. The new method Providers PUT allows changing the following fields: PreferredName, Abbr, FName, LName, MI, Suffi...
by SLeon
Wed Apr 06, 2022 8:41 am
Forum: API
Topic: Customer API key return data issue
Replies: 11
Views: 1446

Re: Customer API key return data issue

The API utilizes the dental office's eConnector to validate developer API, customer API, and registration keys with Open Dental. Do you have an eConnector installed and running on each machine? At the time of eConnector installation, you choose which database to pair it with. An eConnector is specif...
by SLeon
Wed Mar 30, 2022 9:21 am
Forum: API
Topic: Requests for new API endpoints and new fields for an existing endpoint
Replies: 21
Views: 3982

Re: Requests for new API endpoints and new fields for an existing endpoint

The final method for this list of requested features has been completed. 1. ChartModules GET PatientInfo will get information for the patient similar to how it appears in the Chart Module. 2-6. (previously completed) This method will be available in 22.1.18. More information can be found at https://...
by SLeon
Wed Mar 30, 2022 9:19 am
Forum: API
Topic: New API Request
Replies: 9
Views: 1817

Re: New API Request

Claims PUT Split is compete. It will move the specified procedures from an existing claim to a new claim, adhering to the same validation process as in Open Dental.

This method is available in 22.1.17. See https://www.opendental.com/site/apiclaims.html for more information.
by SLeon
Tue Mar 29, 2022 9:21 am
Forum: API
Topic: Document Category clarification
Replies: 12
Views: 1764

Re: Document Category clarification

We can absolutely add DateCreated to the Document POST Upload method. I have added it to our list and should be able start development rather shortly.
by SLeon
Mon Mar 28, 2022 9:33 am
Forum: API
Topic: API Request: Version Number of Open Dental
Replies: 1
Views: 457

Re: API Request: Version Number of Open Dental

1. We will update the demo dental office to version 22.1.16 today. This will allow you to test 22.1 separately from your existing 21.4 dental office. 2. The program version of the server is stored as a preference in the database. You can retrieve this but using Queries PUT ShortQuery with an SqlComm...
by SLeon
Fri Mar 25, 2022 8:46 am
Forum: API
Topic: API Request-Blockouts
Replies: 8
Views: 1771

Re: API Request-Blockouts

Yes, we can add specifying a ScheduleNum to Schedules GET.
by SLeon
Thu Mar 24, 2022 3:49 pm
Forum: API
Topic: Document Category clarification
Replies: 12
Views: 1764

Re: Document Category clarification

I have confirmed there is an issue with transferring files greater than 3MB when using the Documents POST Upload method. We will investigate this immediately. In the meantime, Documents POST UploadSftp was added in 21.2 and easily handles larger files.
by SLeon
Thu Mar 24, 2022 1:34 pm
Forum: Main Forum
Topic: Patient notes through API
Replies: 6
Views: 1253

Re: Patient notes through API

Poonam, What is the version of your eConnector? Both PatientNotes GET and PatientNotes PUT require a version 21.2 or higher. In 21.4.26, we added the Service field (https://www.opendentalsoft.com:8085/forum/viewtopic.php?f=9&t=7706&p=34240&hilit=patientnotes#p34277) in both the GET and PUT endpoints...
by SLeon
Mon Mar 21, 2022 3:33 pm
Forum: API
Topic: API Features Requested
Replies: 25
Views: 9510

Re: API Features Requested

The provColor field has been added to Providers GET. The color is returned as a string in "R,G,B" format.

This will be available in 22.1.14. See https://www.opendental.com/site/apiproviders.html for more information.
by SLeon
Mon Mar 21, 2022 3:28 pm
Forum: API
Topic: Allergies Post Method
Replies: 1
Views: 481

Re: Allergies Post Method

We reached out to this developer directly to investigate this issue. ApiAllOthers is required to use Allergies POST, and is available in permission tiers 3 and 4.
by SLeon
Mon Mar 21, 2022 11:32 am
Forum: API
Topic: Requests for new API endpoints and new fields for an existing endpoint
Replies: 21
Views: 3982

Re: Requests for new API endpoints and new fields for an existing endpoint

1. (ChartModules GET PatientInfo is currently in development) 2-4. (previously completed) 5. SheetFields GET is complete. This will return all the fields on a given sheet. 6. (previously completed) This method will be available in 22.1.10. See https://www.opendental.com/site/apisheetfields.html for ...
by SLeon
Mon Mar 21, 2022 11:23 am
Forum: API
Topic: Medical Summary-POST
Replies: 1
Views: 457

Re: Medical Summary-POST

The Medical Summary shown in that grid is filled from the Medical field in the PatientNotes table. You can already edit this via the API with PatientNotes PUT (https://www.opendental.com/site/apipatientnotes.html).
by SLeon
Mon Mar 21, 2022 8:31 am
Forum: API
Topic: Document Category clarification
Replies: 12
Views: 1764

Re: Document Category clarification

Open Dental does not have a size limit for documents or images in the Image module. The only limitation you may encounter is if you are using the Documents POST Upload method, which takes a very large Base64 string. This string is stored the document.Note field, which is limited to 16 million charac...
by SLeon
Wed Mar 16, 2022 1:03 pm
Forum: API
Topic: API Request-Blockouts
Replies: 8
Views: 1771

Re: API Request-Blockouts

Schedules GET is complete. This method supports filtering by date(s), schedule type, or a specific provider, employee, or blockout. This method will be available in 22.1.13, which is estimated to be released within the week. More information on Schedules GET can be found at https://www.opendental.co...
by SLeon
Wed Mar 16, 2022 12:09 pm
Forum: API
Topic: New API Request
Replies: 6
Views: 1152

Re: New API Request

These three feature requests have been added to our development list. Thank you again for being so thorough in describing your intended use cases.
by SLeon
Tue Mar 15, 2022 8:13 am
Forum: API
Topic: API Features Requested
Replies: 25
Views: 9510

Re: API Features Requested

... Would it be possible to add `ProvColor` column into endpoint: https://www.opendental.com/site/apiproviders.html ? We have started development on this request. Colors are stored in the Open Dental database as their 32-bit representation. Would it be more helpful to return it in that format ("-36...
by SLeon
Mon Mar 14, 2022 8:32 am
Forum: API
Topic: New API Request
Replies: 9
Views: 1817

Re: New API Request

Yes, Claims PUT Split is nearly complete and will likely be finished within the week.
by SLeon
Fri Mar 11, 2022 12:47 pm
Forum: API
Topic: API Demo Dental Office offline for maintenance
Replies: 1
Views: 469

Re: API Demo Dental Office offline for maintenance

Maintenance on our demo dental office is complete. It is again available for use.
by SLeon
Thu Mar 10, 2022 1:49 pm
Forum: API
Topic: API Demo Dental Office offline for maintenance
Replies: 1
Views: 469

API Demo Dental Office offline for maintenance

We are currently in the process of updating the demo dental office used for API testing. API requests made with that set of testing credential will be unavailable during this time. We expect this downtime to be minimal. This thread will update at its conclusion. Actual customer keys and dental offic...
by SLeon
Wed Mar 09, 2022 4:55 pm
Forum: Developers
Topic: Where is ODApi.dll (opendental 22.1)?
Replies: 3
Views: 772

Re: Where is ODApi.dll (opendental 22.1)?

The ODAPI dll is now in our available in our public 22.1 repository.
by SLeon
Wed Mar 09, 2022 1:53 pm
Forum: Developers
Topic: Where is ODApi.dll (opendental 22.1)?
Replies: 3
Views: 772

Re: Where is ODApi.dll (opendental 22.1)?

We are actively working on moving a version of this dll into our public 22.1 repository.
by SLeon
Wed Mar 09, 2022 10:33 am
Forum: API
Topic: Document Category clarification
Replies: 12
Views: 1764

Re: Document Category clarification

This issue was originally reported here https://www.opendentalsoft.com:8085/for ... 580#p34116 and a fix has been implemented. Updating to 21.4.22 should resolve this issue.
by SLeon
Mon Mar 07, 2022 9:24 am
Forum: API
Topic: Document Category clarification
Replies: 12
Views: 1764

Re: Document Category clarification

The DocCategory field for Documents can be any definition.DefNum where the definition.Category=18. This Definition category will always be 18 and will never change, however the dental office has control over the definitions in that category. They can add new ones as they see fit, and hide (not delet...
by SLeon
Fri Mar 04, 2022 3:32 pm
Forum: API
Topic: Requests for new API endpoints and new fields for an existing endpoint
Replies: 21
Views: 3982

Re: Requests for new API endpoints and new fields for an existing endpoint

For the request #3, I totally for get to ask, if it is possible to return the Patient Responsibility (how much that patient owed) for this end point? (https://www.opendental.com/site/apipatients.html). We have added a new API method to get this information. AccountModules GET PatientBalances will r...
by SLeon
Fri Mar 04, 2022 3:29 pm
Forum: API
Topic: API Request
Replies: 19
Views: 3713

Re: API Request

Another feature request has been completed: 1. (Currently in development) 2-3. (Previously completed) 4. The new method Userod POST will create a new user and assign them to the specified UserGroup. See https://www.opendental.com/site/apiuserods.html for more information. 5-7. (Previously completed)...
by SLeon
Wed Mar 02, 2022 4:48 pm
Forum: API
Topic: API: high/duplicate AptNum returned by Appointments GET (multiple)
Replies: 4
Views: 1002

Re: API: high/duplicate AptNum returned by Appointments GET (multiple)

We are in the process of switching to a new demo dental office database for our testing credentials. You will soon see smaller primary keys for some of our tables, such as appointments.
by SLeon
Tue Mar 01, 2022 12:09 pm
Forum: API
Topic: API Request
Replies: 19
Views: 3713

Re: API Request

Another feature request has been completed: 1. (Currently in development) 2. (Previously completed) 3-4. (Currently in development) 5. (Previously completed) 6. A new method, Reports GET Aging, has been added. This returns the same information as the Aging A/R report in Open Dental and has an option...
by SLeon
Mon Feb 28, 2022 10:53 am
Forum: API
Topic: Requests for new API endpoints and new fields for an existing endpoint
Replies: 21
Views: 3982

Re: Requests for new API endpoints and new fields for an existing endpoint

1. A new method, ChartModules GET ProgNotes, has been added and gets the Progress Notes for a patient. similar to how it shows in the Chart Module. See https://www.opendental.com/site/apichartmodules.html for more details. A method to get the Patient Info grid from the Chart Module is currently in d...
by SLeon
Wed Feb 23, 2022 9:01 am
Forum: API
Topic: ASAP and Appointments GET (multiple)
Replies: 2
Views: 924

Re: ASAP and Appointments GET (multiple)

This feature request has been completed. The appointments returned in Appointments GET now contains the Priority field, which will allow the differentiation between "Normal" and "ASAP" appointments. This will be available in version 21.4.26. For more information see https://www.opendental.com/site/a...
by SLeon
Tue Feb 22, 2022 3:08 pm
Forum: API
Topic: Short Query - Possible Bug
Replies: 3
Views: 789

Re: Short Query - Possible Bug

You will want to update to 21.3.51, as that is when we last updated how the Queries API methods handled the credentials in the OpenDentalWebConfig.xml file.
by SLeon
Tue Feb 22, 2022 12:28 pm
Forum: API
Topic: Short Query - Possible Bug
Replies: 3
Views: 789

Re: Short Query - Possible Bug

This is the same issue described in https://www.opendentalsoft.com:8085/for ... ery#p34027 and is not a bug.

Please see the information regarding how our Queries methods considers SQL users in our documentation https://www.opendental.com/site/apiqueries.html.
by SLeon
Mon Feb 21, 2022 6:30 pm
Forum: API
Topic: Tier 4 API Key - "Developer API key does not have permission for ApiReadAll."
Replies: 1
Views: 573

Re: Tier 4 API Key - "Developer API key does not have permission for ApiReadAll."

We are actively in the process of updating our Developer Portal website to include all of our API Permissions. We have reached out to this developer found that he did not email vendor.relations at opendental.com to assign API permissions to this key. Our updated portal page will make it easier for A...
by SLeon
Mon Feb 21, 2022 12:36 pm
Forum: API
Topic: Does the patientNotes PUT endpoint allow setting the `Service` column of the `patientnote` table?
Replies: 5
Views: 1402

Re: Does the patientNotes PUT endpoint allow setting the `Service` column of the `patientnote` table?

This feature request has been completed. The Service field can now be set with the PatientNotes PUT method. It is also returned as a field in the PatientNotes GET results. This will be available in 21.4.26, which is estimated to be release later this week. For more information on this method see htt...
by SLeon
Mon Feb 21, 2022 11:46 am
Forum: API
Topic: GET - OpenDental DB name and images path
Replies: 1
Views: 541

Re: GET - OpenDental DB name and images path

A way to get this information already exists in our API:

1. Database name: Use Queries PUT ShortQuery and run "SELECT DATABASE()".

2. The opendentimages path is stored as the "DocPath" preference, and can be retrieved using Preferences GET.
by SLeon
Thu Feb 17, 2022 9:51 am
Forum: API
Topic: Requests for new API endpoints and new fields for an existing endpoint
Replies: 21
Views: 3982

Re: Requests for new API endpoints and new fields for an existing endpoint

Another requested has been completed: 1. (currently in development) 2-4. (previously completed) 5. We have added a new method called Sheets GET that returns information on all the sheets for a given patient. See https://www.opendental.com/site/apisheets.html for more information. API methods to supp...
by SLeon
Tue Feb 15, 2022 4:01 pm
Forum: API
Topic: API Issue - Slots
Replies: 11
Views: 2046

Re: API Issue - Slots

... Right now when we do GET on slots we get the below response which is an entire business day. 8am to 7pm, which is great but how do find out which slot are not yet taken i.e already scheduled. Should we also be pulling all scheduled appointments and then compare for slots not taken as scheduled?...
by SLeon
Tue Feb 15, 2022 3:50 pm
Forum: API
Topic: API Issue - Slots
Replies: 11
Views: 2046

Re: API Issue - Slots

Benlicas, If you do not specify a ProvNum in the appointments GET Slots endpoint, the search is performed with the customer's Default Practice Provider. Similarly, if a date (or date range) is not specified, the search defaults to the next two weeks. These providers must be scheduled (either to an o...
by SLeon
Tue Feb 15, 2022 3:21 pm
Forum: API
Topic: Postman Response - "The server has encountered an error."
Replies: 3
Views: 904

Re: Postman Response - "The server has encountered an error."

We have reached out to the developer and determined that the two dental offices in question had eConnectors on an older version not supported by Open Dental's API, which is only available in version 21.1 and later. We are going to improve our error messages to better reflect the specific issue that ...
by SLeon
Tue Feb 15, 2022 1:11 pm
Forum: API
Topic: API Issue - Slots
Replies: 11
Views: 2046

Re: API Issue - Slots

Based on the scenario you provided, I would expect the JSON results you included. You mention that Provider 18 is only available 0800-1100 even though they are scheduled 0800-1900? Is this because you have appointments during the 1100-1900 time frame? I also noticed a date in the url of your API met...
by SLeon
Mon Feb 07, 2022 11:29 am
Forum: API
Topic: API Features Requested
Replies: 25
Views: 9510

Re: API Features Requested

Marek,

The Documents POST Upload bug with the blank document description has been fixed. It will be available in 21.4.22.
by SLeon
Fri Feb 04, 2022 3:51 pm
Forum: API
Topic: Does the patientNotes PUT endpoint allow setting the `Service` column of the `patientnote` table?
Replies: 5
Views: 1402

Re: Does the patientNotes PUT endpoint allow setting the `Service` column of the `patientnote` table?

Yes, the PatientNotes PUT method only allows the setting of those three fields. However, the "Service" column would simple for us to add if requested.
by SLeon
Tue Feb 01, 2022 3:07 pm
Forum: API
Topic: New API Request
Replies: 9
Views: 1817

Re: New API Request

We will add a new method to split claims via the API. It has been added to our development list and we will start implementing it fairly shortly.
by SLeon
Tue Feb 01, 2022 9:17 am
Forum: API
Topic: ShortQuery help
Replies: 3
Views: 867

Re: ShortQuery help

I am glad you've got it working. That leads me to believe that there might have been an issue with the dental office's eConnector. When that is the case, it returns a 400 error and a "An error has occurred on the server" message. To others that may encounter this issue, I would first make sure the e...
by SLeon
Mon Jan 31, 2022 1:08 pm
Forum: API
Topic: New API Request
Replies: 9
Views: 1817

Re: New API Request

Thank you for the intended use case and notes for this method. It is very helpful in the implementation process. We will discuss claim splitting at our next API meeting and update this thread by tomorrow.
by SLeon
Mon Jan 31, 2022 12:21 pm
Forum: API
Topic: Appointment Slots Question
Replies: 2
Views: 759

Re: Appointment Slots Question

By not specifying a Provider in Appointments GET Slots, the search will use the dental office's Practice Default Provider. I will update our documentation to reflect this. Additionally, I have added two provider schedules to our demo database. One provider has a ProvNum of 1 (who is also the Practic...
by SLeon
Mon Jan 31, 2022 10:59 am
Forum: API
Topic: ShortQuery help
Replies: 3
Views: 867

Re: ShortQuery help

What is the specific error message you are getting with the 400 BadRequest error? This will describe a number of SQL-related issues with the query you are trying to run. For example, your SQL command should be "SELECT * FROM patient" (not plural "patients"). You are likely getting the an error messa...
by SLeon
Thu Jan 27, 2022 9:52 am
Forum: API
Topic: Requests for new API endpoints and new fields for an existing endpoint
Replies: 21
Views: 3982

Re: Requests for new API endpoints and new fields for an existing endpoint

The next requested feature is complete. 1-2. (Currently in development) 3-4. (Previously completed) 5. (Currently in development) 6. Documents GET now returns two new fields: DocCategory (defintion.DefNum) and docCategory (definition.ItemName). See https://www.opendental.com/site/apidocuments.html f...
by SLeon
Thu Jan 27, 2022 9:08 am
Forum: API
Topic: API Features Requested
Replies: 25
Views: 9510

Re: API Features Requested

Thank you! As we work with the implementation we noticed two more fields that we used to set in our integration, but we can't find them in current API: 1. Possibility to set Position​ field on a patient when updating/creating (especially updating) 2. Option to provide DateCreated​ field when upload...
by SLeon
Tue Jan 25, 2022 4:59 pm
Forum: API
Topic: Requests for new API endpoints and new fields for an existing endpoint
Replies: 21
Views: 3982

Re: Requests for new API endpoints and new fields for an existing endpoint

Yes. We are currently developing methods for returning the Patient Info grid and the All Information grid in red above. The third red box, Chart Views, just filters what can be seen in the All Information grid and is set up differently by each dental office. Filtering functionality will be present i...
by SLeon
Fri Jan 21, 2022 12:55 pm
Forum: Developers
Topic: ShoryQuery Syntax Question
Replies: 4
Views: 1173

Re: ShoryQuery Syntax Question

This issue was determined to be Python-related and has been resolved. In this instance the label for the JSON string needed to be changed from 'data' to 'json', shown below. ShortQuerysite = "https://api.opendental.com/api/v1/queries/ShortQuery" results = requests.put(ShortQuerysite, headers = heade...
by SLeon
Thu Jan 20, 2022 2:13 pm
Forum: Developers
Topic: ShoryQuery Syntax Question
Replies: 4
Views: 1173

Re: ShoryQuery Syntax Question

Your JSON formatting looks correct. You can always test against our demo database with our testing credentials to confirm (See https://www.opendental.com/site/apisetup.html). That specific error message is most often seen when there is an issue with the dental office's eConnector. Usually this due t...
by SLeon
Wed Jan 19, 2022 2:48 pm
Forum: API
Topic: API Request
Replies: 19
Views: 3713

Re: API Request

Feature request #7 has been completed. Appointments GET (multiple) has a new search parameter: PatNum. Supplying this will refine the list of appointments to that patient. You can determine the most recent appointment from this list. PatNum can be used alongside the other search parameters, if desir...
by SLeon
Fri Jan 14, 2022 5:05 pm
Forum: API
Topic: API Features Requested
Replies: 25
Views: 9510

Re: API Features Requested

A fix for the Documents POST Upload bug has been implemented. Now only one file will show in the Image Module tree. This will be available in our next update.
by SLeon
Fri Jan 14, 2022 11:36 am
Forum: API
Topic: API Features Requested
Replies: 25
Views: 9510

Re: API Features Requested

1. The ICEName and the ICEPhone can already be set by using PatientNotes PUT. See https://www.opendental.com/site/apipatientnotes.html.
2. We consider this a bug and are currently looking into the issue.
by SLeon
Wed Jan 12, 2022 9:41 am
Forum: API
Topic: New APIs Needed
Replies: 8
Views: 2846

Re: New APIs Needed

The last of these requested features has been completed. 1-4. (Previously completed) 5. Two new methods Employers POST and Employers PUT have been implemented. See https://www.opendental.com/site/apiemployers.html. 6. (Previously completed) These methods will be available in version 21.4.16, which i...
by SLeon
Wed Jan 12, 2022 9:36 am
Forum: API
Topic: Requests for new API endpoints and new fields for an existing endpoint
Replies: 21
Views: 3982

Re: Requests for new API endpoints and new fields for an existing endpoint

The next requested feature is complete. 1-2. (Currently in development) 3. New fields have been added to Patients GET (single) and Patients GET Simple. EstBalance will indicate that patient's individual balance and BalTotal shows the patient's family total balance (if they are the guarantor for the ...
by SLeon
Wed Jan 05, 2022 4:50 pm
Forum: Advanced Topics
Topic: Min production version for HL7 and API
Replies: 1
Views: 906

Re: Min production version for HL7 and API

The minimum stable versions of Open Dental are

HL7 - Version 6.7
FHIR - Version 16.3

Also, Open Dental's own API was released in version 21.1. More details can be found here https://www.opendental.com/site/apispecification.html
by SLeon
Mon Jan 03, 2022 4:52 pm
Forum: API
Topic: New APIs Needed
Replies: 8
Views: 2846

Re: New APIs Needed

Three more of these requested features have been completed. 1-2. (Previously completed) 3. A new method, Claims PUT (update), has been added. See https://www.opendental.com/site/apiclaims.html. 4. Two new methods, Carriers POST and Carriers PUT, have been added. See https://www.opendental.com/site/a...
by SLeon
Mon Jan 03, 2022 4:51 pm
Forum: API
Topic: Requests for new API endpoints and new fields for an existing endpoint
Replies: 21
Views: 3982

Re: Requests for new API endpoints and new fields for an existing endpoint

The first requested feature is complete.

1-3. (Currently in development)
4. The new method Popups GET will retrieve all patient, family, and superfamily popups for a given PatNum. For more information, please see https://www.opendental.com/site/apipopups.html. It is available as of version 21.4.12.
by SLeon
Mon Jan 03, 2022 3:42 pm
Forum: API
Topic: API Documents
Replies: 2
Views: 1095

Re: API Documents

The API allows retrieving documents via DocNum with Documents POST DownloadSftp. The document will be downloaded to the sftp site you specify. For more information, please see our documentation: https://www.opendental.com/site/apidocuments.html.
by SLeon
Mon Jan 03, 2022 2:53 pm
Forum: Developers
Topic: The remote server returned an error: (500) Internal Server Error
Replies: 6
Views: 7320

Re: The remote server returned an error: (500) Internal Server Error

Poonam,

How are you requesting this list of patients? Are you using the Patients GET (multiple), Queries POST, or Queries PUT ShortQuery API method?
by SLeon
Tue Dec 21, 2021 8:50 am
Forum: API
Topic: API change log
Replies: 3
Views: 1206

Re: API change log

We have just finished integrating our API documentation into our Open Dental web manual. The new link for API specifications can be found here: https://www.opendental.com/site/apispecification.html.
by SLeon
Mon Dec 20, 2021 5:00 pm
Forum: API
Topic: Requests for new API endpoints and new fields for an existing endpoint
Replies: 21
Views: 3982

Re: Requests for new API endpoints and new fields for an existing endpoint

Thank you for your requests for new API features. 1. The details under the Patient Info section are pulled from many different tables. Some of these items, like Allergies and MedicalSummary are already available through existing API methods. Which of these fields do you need for your web application...
by SLeon
Fri Dec 17, 2021 11:44 am
Forum: Developers
Topic: Developer Portal Access
Replies: 22
Views: 10795

Re: Developer Portal Access

We no longer recommend removing the <UserLow> and <PasswordLow> tags in the OpenDentalWebConfig.xml file. The API Queries POST and Queries PUT can now be run without setting up special SQL users or modifying the config file. Please see our updated documentation for details: https://www.opendental.co...
by SLeon
Tue Dec 14, 2021 9:42 am
Forum: API
Topic: New APIs Needed
Replies: 8
Views: 2846

Re: New APIs Needed

Another requested feature has been completed. 1. (Previously completed) 2. Two new methods, PatPlans PUT and InsSubs PUT, have been added for updating patient plan information. Details below. 3. (Updating Claims is currently in development) 4. (Creating/Updating Carriers is currently in development)...
by SLeon
Fri Dec 10, 2021 12:19 pm
Forum: API
Topic: New APIs Needed
Replies: 8
Views: 2846

Re: New APIs Needed

The first of these requested features is complete. 1. The Patients PUT method now supports updating Address2, SecProv, ChartNumber, PreferContactMethod, PreferConfirmMethod, TxtMsgOk, and Language fields. DateTStamp is not an editable field but is updated automatically when any other field is update...
by SLeon
Fri Dec 10, 2021 12:16 pm
Forum: API
Topic: API Features Requested
Replies: 25
Views: 9510

Re: API Features Requested

The first of the two recent feature requests is complete. The Position field has been implemented for both the Patients PUT and Patients POST methods. These are available now in our latest beta version 21.4.8. For more information about this method, please see the API section of our manual: https://...
by SLeon
Wed Dec 08, 2021 9:16 am
Forum: API
Topic: API Features Requested
Replies: 25
Views: 9510

Re: API Features Requested

1. Yes, the Position field for patients can be added to Patients PUT and Patients POST methods.
2. Yes, we can add DateCreated as an optional field in Documents POST UploadSftp.

Both of these items have been added to our development list and you can expect an update on our progress shortly.
by SLeon
Mon Dec 06, 2021 11:56 am
Forum: API
Topic: Confirm appointment status mapping
Replies: 3
Views: 1619

Re: Confirm appointment status mapping

1. Yes, the dental office can map any definition (where defintion.Category=2) to these eConfirmation statuses. 2. The dental office does not need to sign up for eConfirmations to set these preferences, but using the "confirmVal" field in appointments PUT Confirm is meant for offices that do. In most...
by SLeon
Thu Dec 02, 2021 9:30 am
Forum: API
Topic: Confirm appointment status mapping
Replies: 3
Views: 1619

Re: Confirm appointment status mapping

There are two distinct fields for an appointment that describe a status: Confirmed and AptStatus. Confirmed Confirmed describes the confirmation status of the appointment. It is the result of the dental office's attempt to contact the patient to confirm their appointment. This is a definition where ...
by SLeon
Wed Dec 01, 2021 4:50 pm
Forum: API
Topic: New APIs Needed
Replies: 8
Views: 2846

Re: New APIs Needed

Thank you, mandmdiet, for this list of API feature requests. Your Use Cases for each new method are extremely helpful in the implementation process. We will discuss these items at our API development meeting tomorrow and update you shortly.
by SLeon
Thu Nov 18, 2021 11:44 am
Forum: API
Topic: PriProv field is 0 in GET Patients & GET Patients/{patientNumber} API
Replies: 5
Views: 3507

Re: PriProv field is 0 in GET Patients & GET Patients/{patientNumber} API

The PriProv and SecProv fields have been added to Patients GET (single) results. SecProv has also been added to the results of Patients GET Simple.

These will be available in our next beta version (21.3.28) which is estimated to be released within the next week.
by SLeon
Wed Nov 17, 2021 11:10 am
Forum: API
Topic: PriProv field is 0 in GET Patients & GET Patients/{patientNumber} API
Replies: 5
Views: 3507

Re: PriProv field is 0 in GET Patients & GET Patients/{patientNumber} API

We can easily add the PriProv value to the return result in Patients GET (single). This has been added to our development list and should be available rather soon. The Patients GET (multiple) uses the exact query used search for patients within Open Dental. This is why it returns a priProvAbbr but n...
by SLeon
Tue Nov 09, 2021 9:21 am
Forum: API
Topic: Two New API Permissions
Replies: 0
Views: 2811

Two New API Permissions

Two new API Permissions have been added. The first is called Payments and is required to use the existing Payments POST method. The second is PayPlans and is required to use the existing PayPlans POST method. Both of these methods were previously under the AllOthers permission, but have been changed...
by SLeon
Tue Nov 09, 2021 9:12 am
Forum: API
Topic: API Features Requested
Replies: 25
Views: 9510

Re: API Features Requested

The final items from this list of requested features are complete. We have added MedicationPats GET and POST to allow the reading and creating of medications that are attached to a specified patient. To facilitate the management of medications that can be assigned to patients, Medication GET and POS...
by SLeon
Mon Nov 01, 2021 12:03 pm
Forum: API
Topic: Cancelling appointments
Replies: 10
Views: 8250

Re: Cancelling appointments

The new method Appointments PUT Break is complete. This is the only way appointments should be marked as "Broken" through the API. It will be available in our next beta version (21.3.22) which is estimated to be released later this week. Please see our updated documentation for more information on t...
by SLeon
Mon Oct 18, 2021 12:14 pm
Forum: API
Topic: API Features Requested
Replies: 25
Views: 9510

Re: API Features Requested

The next items on the requested features list have been implemented. 1-6. (Previously done) 7. Methods for AllergyDefs GET and POST have been added, although these will rarely be used. 8. Allergies POST has been added. Developers will use this method in most cases, as it will automatically create/in...
by SLeon
Wed Oct 13, 2021 2:51 pm
Forum: API
Topic: Cancelling appointments
Replies: 10
Views: 8250

Re: Cancelling appointments

Along with changing the AptStatus to "Broken", multiple things can occur when an appointment is broken in Open Dental. For example, certain procedure codes can be added to the appointment. These options are set up by the dental office. Because more than just the AptStatus of the appointment is affec...
by SLeon
Mon Oct 11, 2021 2:23 pm
Forum: API
Topic: Appointment statuses Planned, PtNote and PtNoteCompleted
Replies: 2
Views: 2830

Re: Appointment statuses Planned, PtNote and PtNoteCompleted

Yes, an API request will return appointments of any AptStatus. More information on planned appointments can be found here https://www.opendental.com/manual213/apptplanned.html. PtNote/PtNoteCompleted appointments are described at the bottom of this page https://www.opendental.com/manual213/apptspati...
by SLeon
Fri Oct 08, 2021 1:24 pm
Forum: API
Topic: Cancelling appointments
Replies: 10
Views: 8250

Re: Cancelling appointments

I apologize for the misunderstanding. The AptStatus field can be used to change the status of the appointment to "Broken". This can be done with the Appointments PUT method. I will update our documentation to give more details on this and other fields for that method.
by SLeon
Fri Oct 08, 2021 9:08 am
Forum: API
Topic: Categories and appointment service types question
Replies: 16
Views: 9100

Re: Categories and appointment service types question

Unfortunately, when a Web Sched appointment (either NewPat or ExistingPat) is made, the specific defNumApptType is only stored as string in its Note field. While this would be visible through an API request, the Note can easily be overwritten by the dental office, and is therefore an unreliable way ...
by SLeon
Thu Oct 07, 2021 2:47 pm
Forum: API
Topic: API Request: Updating a Claim
Replies: 10
Views: 5615

Re: API Request: Updating a Claim

A customer needs to update their version of Open Dental to update their eConnector. They are able to update to and use our latest beta version right now, if they so choose. If the office does not want to update to a beta version but still use this new method, they will need to wait until version 21....
by SLeon
Wed Oct 06, 2021 2:51 pm
Forum: API
Topic: Categories and appointment service types question
Replies: 16
Views: 9100

Re: Categories and appointment service types question

Appointments GET WebSched will indicate the eServiceLogType of the appointments returned. This is how you can tell how the appointment was scheduled originally ("NewPat", "ExistingPat", etc). Note that this field will be "None" if not scheduled through WebSched. The defNumApptType is a definition.De...
by SLeon
Wed Oct 06, 2021 2:00 pm
Forum: API
Topic: API Request: Updating a Claim
Replies: 10
Views: 5615

Re: API Request: Updating a Claim

Yes, the Etrans component is happening behind the scenes as we discussed. I will add this information to the documentation for clarity. The version of the customer's eConnector determines the API methods that can be accessed. For example, once they update it to 21.3.16, this Claims PUT Status method...
by SLeon
Tue Oct 05, 2021 8:16 am
Forum: API
Topic: API Request: Updating a Claim
Replies: 10
Views: 5615

Re: API Request: Updating a Claim

Claims PUT Status has been completed and will be available in the next beta update (version 21.3.16). Details can be found in our updated documentation (https://www.opendental.com/resources/OpenDentalAPI.pdf). Please let me know if does not entirely cover your use cases.
by SLeon
Tue Oct 05, 2021 8:12 am
Forum: API
Topic: Patients List by Provider
Replies: 3
Views: 3642

Re: Patients List by Provider

Patients GET Simple now supports filtering by the PriProv field. This will be available in the next beta update (version 21.3.16). Details can be found in our updated documentation (https://www.opendental.com/resources/OpenDentalAPI.pdf).
by SLeon
Tue Sep 28, 2021 9:10 am
Forum: API
Topic: API Request: Updating a Claim
Replies: 10
Views: 5615

Re: API Request: Updating a Claim

This has been added to our development list. We will add a new method for updating the ClaimStatus on a specific claim to Sent. It will include the DateSent and DateSentOrig as fields that can be specified in the JSON. The API method will also handle the Etrans insertion automatically, as well.
by SLeon
Tue Sep 28, 2021 8:03 am
Forum: API
Topic: Documents POST DownloadSftp - sync or async?
Replies: 1
Views: 2596

Re: Documents POST DownloadSftp - sync or async?

For Documents POST DownloadSftp, the API response will wait to return until the SFTP action is finished. This could be a successful upload, or a failure due to invalid SFTP credentials, etc. You will receive an error message describing the failure in the response if the SFTP action was unsuccessful....
by SLeon
Mon Sep 27, 2021 10:32 am
Forum: Developers
Topic: Patients List - API question
Replies: 1
Views: 2426

Re: Patients List - API question

I have moved your question over to our API forums and answered it there (viewtopic.php?f=9&t=7616).
by SLeon
Mon Sep 27, 2021 10:31 am
Forum: API
Topic: Patients List by Provider
Replies: 3
Views: 3642

Patients List by Provider

We received this question on another forum and I am answering it here for better visibility. Does the GET Patients (multiple) endpoint in the new API allow a Get of all Patients attached to a Primary Provider. In the Schema details for 21.1 the Patients section has a PriProv field, but when I did a ...
by SLeon
Mon Sep 27, 2021 10:08 am
Forum: Developers
Topic: Update claim table using shortquery api
Replies: 2
Views: 2707

Re: Update claim table using shortquery api

The queries executed with the Queries PUT ShortQuery method need to be read-only, so it will not allow direct updates to the claim table. We will need to implement an API method to do this. Please visit the API forums to make a feature request, so that we can develop exactly what you are looking for.
by SLeon
Fri Sep 24, 2021 3:33 pm
Forum: API
Topic: API Features Requested
Replies: 25
Views: 9510

Re: API Features Requested

Another item from this requested feature list has been implemented. 1-5. (Previously done) 6. PayPlan POST is a new method that allows the creation of a patient payment plan for a specified dollar amount. All plan terms (such as APR, delayed interest/payments, and charge frequency) are fully support...
by SLeon
Fri Sep 24, 2021 3:20 pm
Forum: API
Topic: Categories and appointment service types question
Replies: 16
Views: 9100

Re: Categories and appointment service types question

Appointments GET WebSched is a new method that gets a list of all appointments, indicating which were made through the WebSched service. You can use the eServiceLogType field to determine if it is a Web Sched "NewPat" or "ExistingPat" appointment. More information can be found on our updated documen...
by SLeon
Fri Sep 24, 2021 1:35 pm
Forum: API
Topic: Email addresses for Providers
Replies: 2
Views: 2836

Re: Email addresses for Providers

Development on Userods GET was just completed. It be will available in version 21.3.13, which is estimated to be released early next week.
by SLeon
Wed Sep 22, 2021 12:31 pm
Forum: API
Topic: Email addresses for Providers
Replies: 2
Views: 2836

Email addresses for Providers

A developer recently contacted me with the following question and I am moving it here for better visibility. Would "email" be included in the data returned from Providers GET? After testing, we found that "email" was not returned. Our system requires email for all users and was hoping you could help...
by SLeon
Thu Sep 16, 2021 10:09 am
Forum: API
Topic: API Features Requested
Replies: 25
Views: 9510

Re: API Features Requested

Three more items from this requested features list have been implemented. 1-4.(previously done) 5. RefAttaches POST is a new method that attaches a patient to any referral source, either by name or ReferralNum. A second method, Referrals GET, has also been added to view all referral sources for the ...
by SLeon
Thu Sep 16, 2021 9:46 am
Forum: API
Topic: Request for API surfacing of timestamps
Replies: 2
Views: 3260

Re: Request for API surfacing of timestamps

We have added support for the DateTStamp parameter to Providers GET. Details can be found in our updated documentation here https://www.opendental.com/resources/OpenDentalAPI.pdf.
by SLeon
Fri Sep 03, 2021 8:35 am
Forum: Developers
Topic: Developer Portal Access
Replies: 22
Views: 10795

Re: Developer Portal Access

The grant needs to be for the ''@'localhost' user, not to the 'root'@'localhost' user. You also only need to set the SELECT permission to use the Queries PUT ShortQuery API method.
by SLeon
Thu Sep 02, 2021 10:35 am
Forum: Developers
Topic: Developer Portal Access
Replies: 22
Views: 10795

Re: Developer Portal Access

The ShortQuery method will use the ''@localhost MySql user for your database. This ''@localhost user has no permissions granted by default, so you just need to grant that MySql user SELECT privileges to be able to run your query.
by SLeon
Thu Sep 02, 2021 8:27 am
Forum: Developers
Topic: Developer Portal Access
Replies: 22
Views: 10795

Re: Developer Portal Access

The difference is that Patients GET was released in version 21.1 and Queries PUT ShortQuery is in version 21.2. Because your eConnector is on version 21.1, you cannot access the ShortQuery method until you update it to 21.2. Our documentation indicates which version each API method was released just...
by SLeon
Wed Sep 01, 2021 1:42 pm
Forum: API
Topic: Cancelling appointments
Replies: 10
Views: 8250

Re: Cancelling appointments

The method Appointments PUT Confirm has been recently expanded to support all appointment confirmation statuses. This will allow you to set the status to "Broken" to indicate a cancellation, or to any other ApptConfirm status the office has setup, via a defNum. The original confirmVal field is used ...
by SLeon
Wed Sep 01, 2021 8:06 am
Forum: Developers
Topic: Developer Portal Access
Replies: 22
Views: 10795

Re: Developer Portal Access

With your eConnector on that version, you should be able to use any API method that was released in 21.1, such as Patients GET. Which method are you using when you get this error?
by SLeon
Tue Aug 31, 2021 1:46 pm
Forum: API
Topic: Power of attorney query
Replies: 3
Views: 4187

Re: Power of attorney query

A new method, PatientNotes GET, now provides this functionality. It returns the patient's ICEName, ICEPhone, and Medical summary note. These fields can also be updated with PatientNotes PUT method, if desired. More details can be found in our updated documentation https://www.opendental.com/resource...
by SLeon
Tue Aug 31, 2021 1:42 pm
Forum: API
Topic: API Features Requested
Replies: 25
Views: 9510

Re: API Features Requested

The three following items have been implemented from the list above. 1. Appointments PUT Confirm now supports all ApptConfirmed status types and can be set via DefNum. 2. (previously done) 3. Recalls PUT Status is a new method that allows updating the status on recall reminders. 4. PatientNotes PUT ...
by SLeon
Tue Aug 31, 2021 1:08 pm
Forum: Developers
Topic: Developer Portal Access
Replies: 22
Views: 10795

Re: Developer Portal Access

Your Authorization header appears to be formatted correctly. This type of error message generally points to an issue with the eConnector. What version is your eConnector on?
by SLeon
Fri Aug 27, 2021 9:19 am
Forum: API
Topic: Request for API surfacing of timestamps
Replies: 2
Views: 3260

Re: Request for API surfacing of timestamps

Jason, The field DateTStamp found in many of the API methods is the timestamp you are looking for. It is the exact server time that row in the database was last modified. The ability to specify the DateTStamp as a search paramater for patients already exists in the newer Patients GET Simple method. ...
by SLeon
Fri Aug 20, 2021 10:38 am
Forum: API
Topic: GET Patients altered after the specified date and time
Replies: 4
Views: 5049

Re: GET Patients altered after the specified date and time

A new API method, Patients GET Simple, has been added and supports filtering patients by DateTStamp. Details can be found in our updated documentation (https://www.opendental.com/resources/OpenDentalAPI.pdf).
by SLeon
Fri Aug 20, 2021 8:25 am
Forum: API
Topic: Retreiving test patients
Replies: 2
Views: 3617

Re: Retreiving test patients

These patients appear to be from the our demo database for the API. In your API requests, are you using your own credentials in the Authorization header or the test ones from the documentation?
by SLeon
Mon Aug 16, 2021 3:48 pm
Forum: API
Topic: API Features Requested
Replies: 25
Views: 9510

API Features Requested

A developer recently emailed us the following API feature requests. The API forums are the best place for communication on requested features, so we are moving these items here for better visibility. 1. Appointment Confirm - we need more statuses, we use it not only to confirm, but also to mark pati...
by SLeon
Tue Aug 10, 2021 1:21 pm
Forum: API
Topic: GET multiple appointments pagesize and offset
Replies: 2
Views: 3489

Re: GET multiple appointments pagesize and offset

For your first two questions, the API utilizes paging to return large result sets. See the Pagination section in our documentation for details. https://www.opendental.com/resources/OpenDentalAPI.pdf. There is a maximum limit of 100 results, but you can specify an offset. API methods that include Dat...
by SLeon
Fri Aug 06, 2021 2:30 pm
Forum: API
Topic: Categories and appointment service types question
Replies: 16
Views: 9100

Re: Categories and appointment service types question

Whether clinics are enabled are not is stored as a preference so you can utilize the Preferences GET method for this. The PrefName is called EasyNoClinics, where a value of 0 indicates that clinics are enabled.
by SLeon
Thu Aug 05, 2021 8:44 am
Forum: API
Topic: Cancelling appointments
Replies: 10
Views: 8250

Re: Cancelling appointments

The Confirmed field is tied to the eServices Automated Messaging feature, if the office has set that up. More information can be found here https://opendental.com/manual/confirmationstatus.html. Currently the API does not support cancelling an appointment, only rescheduling, but we can look into this.
by SLeon
Wed Aug 04, 2021 12:36 pm
Forum: API
Topic: Power of attorney query
Replies: 3
Views: 4187

Re: Power of attorney query

The API offers the Queries POST and Queries PUT ShortQuery methods as a way to obtain information not directly available through other API methods. Emergency contact information is stored in the PatientNote table, more details here: https://www.opendental.com/OpenDentalDocumentation21-1.xml#patientn...
by SLeon
Tue Aug 03, 2021 8:53 am
Forum: API
Topic: Categories and appointment service types question
Replies: 16
Views: 9100

Re: Categories and appointment service types question

I am glad to hear you were able to get GET SlotsWebSched working! The appointment type is not currently a field that is returned when using GET appointments, but is clearly necessary for this workflow. I will add this to our development list. Do you have any remaining questions/concerns about using ...
by SLeon
Thu Jul 29, 2021 1:58 pm
Forum: API
Topic: ClinicNum question
Replies: 1
Views: 3635

Re: ClinicNum question

The ClinicNum is not the external ID of a practice. Information on the clinic table can be found on our Database Documentation page https://www.opendental.com/OpenDentalDocumentation21-1.xml. If a practice has multiple physical locations, they can choose to enable and utilize the Clinics feature, as...
by SLeon
Thu Jul 29, 2021 11:07 am
Forum: API
Topic: Categories and appointment service types question
Replies: 16
Views: 9100

Re: Categories and appointment service types question

The defNumApptType parameter for GET /appointments/SlotsWebSched is defined in our documentation as "definition.DefNum where definition.Category=42 (NewPat) or 51 (ExistingPat)". These are the AppointmentTypes specifically associated with the Web Scheduling eService. You can send the following API r...
by SLeon
Wed Jul 28, 2021 2:21 pm
Forum: API
Topic: GET Patients altered after the specified date and time
Replies: 4
Views: 5049

Re: GET Patients altered after the specified date and time

We can absolutely implement an API method for this. Expect this to be available very soon!
by SLeon
Tue Jul 27, 2021 8:59 am
Forum: Developers
Topic: ShortQuery
Replies: 5
Views: 4807

Re: ShortQuery

The ShortQuery method will use the ''@localhost MySql user for your database by default, unless you have specifically set up a different UserLow (which is rare). This ''@localhost user has no permissions granted by default, so you just need to grant that MySql user SELECT privileges to be able to ru...
by SLeon
Mon Mar 01, 2021 11:07 am
Forum: Developers
Topic: sudden server error
Replies: 1
Views: 5530

Re: sudden server error

The API is up and running, are you still experiencing this issue? If so, what resource(s) does your script call?