Search found 476 matches

by SLeon
Fri Dec 30, 2022 1:03 pm
Forum: Developers
Topic: Can you add a table to the OpenDental
Replies: 1
Views: 3336

Re: Can you add a table to the OpenDental

Good morning, Open Dental recommends developers use the API to interact with customer databases. From the Programming Resources page: Queries Simple read-only operations can be performed with queries. This is useful for reports. Any third party is welcome to query the database as long as no writes a...
by SLeon
Thu Dec 29, 2022 3:59 pm
Forum: API
Topic: Treatment Plans
Replies: 5
Views: 1757

Re: Treatment Plans

Good afternoon,

Yes we can create a TreatPlan Get method for you. I have added this to our development list.
by SLeon
Wed Dec 28, 2022 8:31 am
Forum: API
Topic: API not found. Requesting new APIs
Replies: 57
Views: 177479

Re: API not found. Requesting new APIs

Good morning,

The SubstitutionLink POST feature request has been completed. It will be available in our next beta version, 22.4.5.
by SLeon
Tue Dec 27, 2022 10:19 am
Forum: API
Topic: Put for the oduser table
Replies: 2
Views: 1228

Re: Put for the oduser table

Good morning,

Yes, we can create a PUT method for the UserODs resource. I have added this to our development list.
by SLeon
Tue Dec 20, 2022 1:56 pm
Forum: API
Topic: API endpoint to creat API Key
Replies: 6
Views: 2008

Re: API endpoint to creat API Key

Could you please elaborate on the bolded portion below? our goal is either add api keys via an api get method or have a 15 days stored on our database ready for use. If I understand you correctly, there is nothing in the Developer Portal preventing you from generating several Customer API Keys and k...
by SLeon
Thu Dec 15, 2022 10:43 am
Forum: API
Topic: procCode in procedurelogs
Replies: 8
Views: 2489

Re: procCode in procedurelogs

The ProcedureLogs GET method now accepts the AptNum parameter. It can be used alone or alongside our other search filters for this method (PatNum and DateTStamp).

This feature is available in version 22.3.32. See https://www.opendental.com/site/apiprocedurelogs.html for more information.
by SLeon
Tue Dec 13, 2022 12:57 pm
Forum: API
Topic: Deleting old API keys
Replies: 5
Views: 1585

Re: Deleting old API keys

These two enhancements to the Developer Portal have just been added and are available now.
  • A checkbox to toggle displaying enabled or all Customer API keys.
  • A confirmation message that appears when clicking Add, to prevent accidental generation of new API keys.
by SLeon
Tue Dec 06, 2022 2:26 pm
Forum: API
Topic: API not found. Requesting new APIs
Replies: 57
Views: 177479

Re: API not found. Requesting new APIs

Thank you for letting us know, Dhru. I have updated your feature request on our list.
by SLeon
Tue Dec 06, 2022 8:36 am
Forum: API
Topic: API not found. Requesting new APIs
Replies: 57
Views: 177479

Re: API not found. Requesting new APIs

Good morning, Some of our API methods, such as FamilyModules GET, return information that is displayed via Open Dental's UI. Many times, this information is a compilation of data stored in several database tables. This is especially true in the case of FamilyModules GET, as it gathers information fr...
by SLeon
Fri Dec 02, 2022 11:31 am
Forum: API
Topic: How to: Post to public webhook?
Replies: 21
Views: 5814

Re: How to: Post to public webhook?

@joergzastrau Program Links exist to prevent the need for a specific, additional button. If launching the cmd instance is slow, would utilizing the ApiEvents logic for the appointment table be helpful? You would be alerted to any changes made to the table, including scheduling new appointments. @rin...
by SLeon
Fri Dec 02, 2022 9:07 am
Forum: API
Topic: New feature requests
Replies: 5
Views: 1843

Re: New feature requests

We have completed two of the above feature requests. 1. Tasks Tasks PUT is in development. 2. AutoNotes AutoNotes POST & AutoNotes PUT are in development. AutoNoteControls POST will create an AutoNoteControl and allows the setting of all fields. AutoNoteControls PUT will edit an existing AutoNoteCon...
by SLeon
Fri Dec 02, 2022 8:31 am
Forum: API
Topic: API not found. Requesting new APIs
Replies: 57
Views: 177479

Re: API not found. Requesting new APIs

Good morning.

It's not a bother. I added those two methods to our development list on Tuesday. I would estimate that they will be implemented in a couple of weeks, but I will update this thread with our progress.
by SLeon
Fri Dec 02, 2022 8:08 am
Forum: API
Topic: How to sync patfields back to our system from OD ?
Replies: 5
Views: 1638

Re: How to sync patfields back to our system from OD ?

We will develop both of these options, but prioritize the latter subscription one for you. I would expect this to be complete in roughly three weeks' time.
by SLeon
Wed Nov 30, 2022 10:41 am
Forum: API
Topic: Payments
Replies: 7
Views: 2061

Re: Payments

There are roughly a dozen feature requests on our development list prior to this one. I would estimate that development will start on these two in the next two weeks. We will update this thread with our progress, but you are welcome to message me directly as well.
by SLeon
Wed Nov 30, 2022 10:38 am
Forum: API
Topic: How to sync patfields back to our system from OD ?
Replies: 5
Views: 1638

Re: How to sync patfields back to our system from OD ?

Good morning, We can do the following to support your use case: Enhance the existing PatFields GET method. We can make the PatNum and FieldName optional parameters and add SecDateTEdit as a new parameter. This would allow you to only get PatFields that have changed since a certain datetime. We would...
by SLeon
Wed Nov 30, 2022 7:56 am
Forum: API
Topic: Payments
Replies: 7
Views: 2061

Re: Payments

Good morning,

Yes, we can also add the ability to "select" specific procedure(s) to apply the payment to.
by SLeon
Tue Nov 29, 2022 3:53 pm
Forum: API
Topic: Payments
Replies: 7
Views: 2061

Re: Payments

Good afternoon, The Payments POST method does create paysplit(s) as part of it's payment insertion logic. This occurs on a FIFO basic according to the dental office's Allocation Setup (https://opendental.com/manual/allocationssetup.html). Meaning the API handles payments identically as in Open Denta...
by SLeon
Tue Nov 29, 2022 3:20 pm
Forum: API
Topic: API Newbie
Replies: 1
Views: 994

Re: API Newbie

I have written up a quick guide to get started using the Open Dental API here: http://opendentalsoft.com/forum/viewtopic.php?f=9&t=7918. If you have access to the Developer Portal already, you will find Steps 2 onward the most helpful. Feel free to ask any additional questions. We plan to create mor...
by SLeon
Tue Nov 29, 2022 3:16 pm
Forum: API
Topic: API Guide - Getting Started
Replies: 0
Views: 6373

API Guide - Getting Started

The Open Dental API (commonly "OD API" or simply "the API") is an interface for developers to safely interact with customers' databases. Because directly writing to customer databases is not allowed, the API provides the ability for third party developers to create robust and powerful software witho...
by SLeon
Tue Nov 29, 2022 1:13 pm
Forum: API
Topic: API endpoint to creat API Key
Replies: 6
Views: 2008

Re: API endpoint to creat API Key

This is a great question and I want to fully address your inquiry. The Developer Portal is secure, requiring a username and password. We would have to add this entirely new layer of validation to the current API model. The portal also requires active human interaction to log in and click to add a ne...
by SLeon
Tue Nov 29, 2022 11:52 am
Forum: API
Topic: API not found. Requesting new APIs
Replies: 57
Views: 177479

Re: API not found. Requesting new APIs

A patient's insurance plan information is available in the PatPlan table. You can use PatPlan PUT to change some of these fields (see https://www.opendental.com/site/apipatplans.html). Are there any other fields you need us to add to this method?
by SLeon
Tue Nov 29, 2022 11:49 am
Forum: API
Topic: InsVerifies GET
Replies: 9
Views: 2593

Re: InsVerifies GET

Hey there,

The above method to get the insurance data you are after is called with Benefits GET. This is not yet available, but 22.3.27 is estimated to be released later this week.
by SLeon
Tue Nov 29, 2022 10:28 am
Forum: API
Topic: API not found. Requesting new APIs
Replies: 57
Views: 177479

Re: API not found. Requesting new APIs

Nope, I have already added them to our development list. We will update this thread with our progress.
by SLeon
Tue Nov 29, 2022 9:00 am
Forum: API
Topic: API not found. Requesting new APIs
Replies: 57
Views: 177479

Re: API not found. Requesting new APIs

1. We can create InsPlans PUT to update the GroupNum (and other fields). 2. We will also add a way to insert downgrades for specific insurance plans with SubstitutionLinks POST. 3. If you are referring to the main grid in the Chart Modules, that information is automatically generated from many diffe...
by SLeon
Tue Nov 29, 2022 8:20 am
Forum: API
Topic: API not found. Requesting new APIs
Replies: 57
Views: 177479

Re: API not found. Requesting new APIs

Good morning, 1. The Group Number is a field in the insplan table. Are you wanting to just update this field or are you wanting to create a new insurance plan? 2. Which type of downgrade are you trying to perform? On a procedure for a specific insurance plan, or universally for all insurance plans? ...
by SLeon
Mon Nov 28, 2022 2:54 pm
Forum: API
Topic: New feature requests
Replies: 5
Views: 1843

New feature requests

A developer has recently emailed with a list of feature requests. I am posting this list and our progress here for greater visibility. 1. Tasks Tasks GET will get a list of tasks based on status, tasklist, and other search parameters. Added in 22.3.16. Tasks POST will create a task on behalf of a us...
by SLeon
Mon Nov 28, 2022 8:00 am
Forum: API
Topic: Can't access the benefits API
Replies: 2
Views: 1236

Re: Can't access the benefits API

Which version of Open Dental are you using? Benefits GET was added in version 22.3.27.
by SLeon
Mon Nov 21, 2022 9:33 am
Forum: API
Topic: Deleting old API keys
Replies: 5
Views: 1585

Re: Deleting old API keys

These are excellent questions. The assignment of an API key to a dental office is permanent, and this linkage cannot be altered in any way. If Dental Office B attempts to add an API key already assigned to Dental Office A, they will see the message "API key has already been assigned". This protects ...
by SLeon
Mon Nov 21, 2022 8:31 am
Forum: API
Topic: Deleting old API keys
Replies: 5
Views: 1585

Re: Deleting old API keys

Good morning, Would adding the ability in the Developer Portal to hide disabled API Keys suit your needs? This would avoid the irreversible nature of deleting a key but facilitate the management of only active customers. We would default the view to show only active keys, but this could be toggled o...
by SLeon
Mon Nov 21, 2022 8:06 am
Forum: API
Topic: Subscription Events not getting triggered
Replies: 1
Views: 1011

Re: Subscription Events not getting triggered

Good morning, Here a few troubleshooting steps that other forum users found helpful: When you call Subscriptions GET, does the DateTimeStart field update? This column is updated everytime Open Dental checks the database for entries to send in an event. Meaning this field will increment by the Pollin...
by SLeon
Fri Nov 18, 2022 1:01 pm
Forum: API
Topic: Scheduling a Planned Appointment
Replies: 14
Views: 3926

Re: Scheduling a Planned Appointment

We have added the Layman's Term field to the new method ProcedureCodes GET, as request above. This is available in beta version 22.3.22 and later.
by SLeon
Thu Nov 17, 2022 11:03 am
Forum: API
Topic: API Enhancement Request: Referrals
Replies: 3
Views: 1674

Re: API Enhancement Request: Referrals

We have added Referrals POST as a new method to create new referral sources through the API.

This is available in beta version 22.3.23 and later. Please see https://www.opendental.com/site/apireferrals.html for more information.
by SLeon
Thu Nov 17, 2022 8:02 am
Forum: API
Topic: Local API issue
Replies: 5
Views: 1456

Re: Local API issue

(Unlikely) The database chosen on the workstation is the same as the database utilized by the eConnector. You can check the database used by the Local API when it is launched with Open Dental: ChooseDatabase.gif And the database used by the eConnector (and therefore the Remote API) in \\OpenDental\...
by SLeon
Wed Nov 16, 2022 2:49 pm
Forum: API
Topic: Standard Report Queries
Replies: 2
Views: 1362

Re: Standard Report Queries

Good afternoon,

The Query Monitor is a great way to see the SQL queries running behind Open Dental actions, including reports. It is worth noting that sometimes multiple queries are used to produce a report and many will translate the information into a human-readable format prior to display.
by SLeon
Wed Nov 16, 2022 2:35 pm
Forum: API
Topic: Local API issue
Replies: 5
Views: 1456

Re: Local API issue

Good afternoon, I understand that the same JSON body is producing different results when sent to different endpoints (Local API "http://localhost:30222/api/v1/appointments" vs Remote API "https://api.opendental.com/api/v1/appointments"). Could you please verify a few details when using the Local API...
by SLeon
Fri Nov 11, 2022 8:22 am
Forum: API
Topic: Webhook not getting triggerred for API Subscriptions
Replies: 8
Views: 1905

Re: Webhook not getting triggerred for API Subscriptions

Good morning,

Open Dental has to be running to process subscriptions and send events. The API Service will also do this, if you have it installed.

Do you experience this issue when either of the above are running?
by SLeon
Wed Nov 09, 2022 8:22 am
Forum: API
Topic: procCode in procedurelogs
Replies: 8
Views: 2489

Re: procCode in procedurelogs

Good morning, Yes, the procCode field was added to the Procedurelogs GET results in version 21.4.7. This is why your dental office on version 22.1.49 returns this result and the 21.3.42 dental office does not. We can absolutely add a parameter for this method to filter by AptNum. I have added this t...
by SLeon
Mon Nov 07, 2022 11:01 am
Forum: API
Topic: How to: Post to public webhook?
Replies: 21
Views: 5814

Re: How to: Post to public webhook?

Good morning, Thank you for sharing your integrations with everyone. I am sure this will help other developers aiming to do similar things with their software. Could you please clarify how a traditional Program Link will not work for either of these? I believe they provide all the functionality you ...
by SLeon
Thu Nov 03, 2022 3:08 pm
Forum: API
Topic: How to: Post to public webhook?
Replies: 21
Views: 5814

Re: How to: Post to public webhook?

Good afternoon, I have investigated this issue and have come to the following conclusion. Some webhook services accept additional information appended in the url, many do not. While there is no established standard, our goal is to support many different implementation strategies and help developers ...
by SLeon
Thu Nov 03, 2022 7:38 am
Forum: API
Topic: InsVerifies GET
Replies: 9
Views: 2593

Re: InsVerifies GET

Good morning Pedro,

Yes. In the soon-to-be released Benefits GET, we will also return the FK of the plan. This will either be the PlanNum (for InsPlans) or the PatPlanNum (for PatPlans). Most benefits are attached using insplan.PlanNum.
by SLeon
Mon Oct 31, 2022 7:54 am
Forum: API
Topic: How to: Post to public webhook?
Replies: 21
Views: 5814

Re: How to: Post to public webhook?

Thank you for this information. I am looking into this issue to see if it is something on our end. I will update this thread soon.
by SLeon
Thu Oct 27, 2022 3:49 pm
Forum: API
Topic: How to: Post to public webhook?
Replies: 21
Views: 5814

Re: How to: Post to public webhook?

One reason for appending this additional text is to indicate the response does contain the full appointment table. The returned objects are the API version of the object which contains some fields not found in the database table and is missing some that are. Appending "event" helps to make this dist...
by SLeon
Mon Oct 17, 2022 3:10 pm
Forum: API
Topic: Patient first visit date.
Replies: 4
Views: 1820

Re: Patient first visit date.

Sure thing! I have added it to our list.
by SLeon
Mon Oct 17, 2022 9:51 am
Forum: API
Topic: Offset for Queries PUT ShortQuery
Replies: 2
Views: 1508

Re: Offset for Queries PUT ShortQuery

Good morning Greg,

We have fixed the issue you described in your post above. Using the ?Offset=100 parameter for queries with fewer than 100 results will now return an empty list as one would expect. This change will be available starting in versions 22.2.43 and 22.3.14.
by SLeon
Mon Oct 17, 2022 8:56 am
Forum: API
Topic: InsVerifies GET
Replies: 9
Views: 2593

Re: InsVerifies GET

Good morning,

This information is stored in the Benefits table. We can create a Benefits GET method that will return information for an specified insurance plan. Let me know if this works for you and we can add it to the development list.
by SLeon
Mon Oct 17, 2022 8:05 am
Forum: API
Topic: Patient first visit date.
Replies: 4
Views: 1820

Re: Patient first visit date.

Good morning,

The date a patient first visited the dental office is stored in the patient.DateFirstVisit field. This is not currently returned through the API, but I will add to our development list to include it in our Patients GET methods' results.
by SLeon
Fri Oct 14, 2022 8:34 am
Forum: API
Topic: Scheduling a Planned Appointment
Replies: 14
Views: 3926

Re: Scheduling a Planned Appointment

Good morning, To first touch on your question about the relationship between Planned and Scheduled appointments, Justin is correct that both appointments continue to exist as rows in the appointment table and you can discern them by their primary keys (AptNum). I would like to add that Open Dental u...
by SLeon
Thu Oct 13, 2022 8:48 am
Forum: API
Topic: Appointments GET Slots - Return all Providers and all Ops
Replies: 3
Views: 1741

Re: Appointments GET Slots - Return all Providers and all Ops

Good morning Pedro, Thank you for the clarification. I understand that you are not just wanting to know a timeslot to schedule an appointment in, but all the available times for your providers and their operatories. I believe you are wanting to something akin to the information shown visually in the...
by SLeon
Wed Oct 12, 2022 2:45 pm
Forum: API
Topic: How to get API Servives?
Replies: 9
Views: 2444

Re: How to get API Servives?

The API Service has been enhanced to show a Configuration Settings window when installing it through Open Dental. This will allow changes to the database connection details without having to manually edit the OpenDentalWebConfig.xml file. Customers will see this new window starting in versions 22.2....
by SLeon
Wed Oct 12, 2022 1:29 pm
Forum: API
Topic: Appointments GET Slots - Return all Providers and all Ops
Replies: 3
Views: 1741

Re: Appointments GET Slots - Return all Providers and all Ops

The Appointments GET Slots method is meant to check the availability of a provider in their assigned and scheduled operatory. The logic checks the provider's schedule, scheduleops, and appointments for that operatory for the date range. This is helpful for determining when to make a new appointment ...
by SLeon
Mon Oct 10, 2022 8:17 am
Forum: API
Topic: AppointmentTypeNumber for Appointments POST
Replies: 3
Views: 1592

Re: AppointmentTypeNumber for Appointments POST

Good morning Pedro, There are two common ways you can add procedures to an appointment through the API: Use the Appointments POST method and supply an AppointmentTypeNum in your JSON. This will automatically add the Pattern, Procedures, and Color associated with the specified Appointment Type. See h...
by SLeon
Fri Sep 30, 2022 3:15 pm
Forum: API
Topic: Benefits line item.
Replies: 9
Views: 2521

Re: Benefits line item.

There are two API feature requests above Benefits POST on our development list. I would expect implementation on this to start within the next week. No, you cannot run insert SQL commands directly through the API. See the documentation for the Queries resources https://www.opendental.com/site/apique...
by SLeon
Thu Sep 29, 2022 1:51 pm
Forum: API
Topic: API Enhancement Request: Referrals
Replies: 3
Views: 1674

Re: API Enhancement Request: Referrals

Yes, we can add a Referrals POST method to the API. I have added this to our development list.
by SLeon
Thu Sep 29, 2022 11:21 am
Forum: API
Topic: Custom insert command in API
Replies: 1
Views: 1150

Re: Custom insert command in API

I have added this feature request to our development list. Please see my response on your other post (https://www.opendentalsoft.com:8085/for ... 915#p34915)
by SLeon
Thu Sep 29, 2022 11:21 am
Forum: API
Topic: Benefits line item.
Replies: 9
Views: 2521

Re: Benefits line item.

Great! Thank you for confirming this. I have added this to our development list. I will update this thread once it is complete.
by SLeon
Thu Sep 29, 2022 10:59 am
Forum: API
Topic: Benefits line item.
Replies: 9
Views: 2521

Re: Benefits line item.

I understand you are wanting to utilize the API and we are happy to create an API method for you to do so. I would like to clarify which benefit fields you are requesting us to include in this new method. The form I linked above allows setting the Category, ProcCode, Type, Percent, Amount, Time Peri...
by SLeon
Thu Sep 29, 2022 8:46 am
Forum: API
Topic: How to get API Servives?
Replies: 9
Views: 2444

Re: How to get API Servives?

Good morning Genyus, Your OpenDentalWebConfig file is missing a "Note" node. Open Dental will automatically make this file and install the API Service for customers who have the API enabled (Setup > Advanced Setup > API). To manually fix this issue, paste in the <Note>DentalOffice</Note> node after ...
by SLeon
Wed Sep 28, 2022 12:28 pm
Forum: Developers
Topic: Insurance plan benefit
Replies: 3
Views: 9273

Re: Insurance plan benefit

dhe wrote: ↑
Wed Sep 28, 2022 11:30 am
Is any way to insert Benefits line item add from API
Please see my response to your other post on the API Forums (https://www.opendentalsoft.com:8085/for ... 904#p34904).
by SLeon
Wed Sep 28, 2022 11:51 am
Forum: API
Topic: Benefits line item.
Replies: 9
Views: 2521

Re: Benefits line item.

For clarification, you would like to add Benefits similar to the the form seen on this page? https://opendental.com/manual/benefitinforowview.html
by SLeon
Wed Sep 28, 2022 8:03 am
Forum: API
Topic: How to get API Servives?
Replies: 9
Views: 2444

Re: How to get API Servives?

Good morning, Here are some troubleshooting steps you can take for the API Service: Check the connection details in \OpenDental\OpenDentalAPIService\OpenDentalWebConfig.xml to ensure your database credentials are correct Uninstall the API Service, launch Open Dental as administrator, and reinstall t...
by SLeon
Tue Sep 27, 2022 9:03 am
Forum: API
Topic: Open Dental have centralized server?
Replies: 1
Views: 1172

Re: Open Dental have centralized server?

Good morning,

When the eConnector is installed on the dental office's server, it becomes associated with that registration key and database. The Open Dental API uses the dental office's eConnector to retrieve information about their local database.
by SLeon
Mon Sep 26, 2022 10:26 am
Forum: Main Forum
Topic: No eService account found for this registration key
Replies: 1
Views: 1196

Re: No eService account found for this registration key

Good morning, Is this a new database with a valid registration key? When you navigate to Setup > Advanced Setup> API, does the new window pop up or do you get an error message straight away. In either case, what is the exact error message displayed? Another thing to note is that a web call is made w...
by SLeon
Mon Sep 26, 2022 8:24 am
Forum: API
Topic: Modifying Appointment Notes
Replies: 1
Views: 1256

Re: Modifying Appointment Notes

Good morning, This is a great question. Updating only the Note field via our Appointments PUT (update) method is absolutely fine. We caution using this method without a deeper understanding of our database scheme in most cases. An example is how changing an appointment's Status to "Broken" does not ...
by SLeon
Mon Sep 26, 2022 8:10 am
Forum: API
Topic: API error during new patient creation
Replies: 2
Views: 1325

Re: API error during new patient creation

Good morning, The error message you are seeing is not new and is meant to prevent duplicate patients from being added via the API. Our Patients POST method will return this message when you attempt to create a patient with the exact same FName, LName, Birthdate, and either Email or phone number as a...
by SLeon
Tue Sep 20, 2022 2:58 pm
Forum: API
Topic: Slot API error
Replies: 13
Views: 2805

Re: Slot API error

Thank you for confirming those details for us. I was just able to reproduce this error in a very specific circumstance. It was when the Practice Default Provider was not assigned to any operatories, was scheduled for the day but not to any specific operatory, and did not specify an OpNum in the API ...
by SLeon
Mon Sep 19, 2022 8:57 am
Forum: API
Topic: Slot API error
Replies: 13
Views: 2805

Re: Slot API error

Good morning, We are currently in the process of improving the error messages we return when API requests are incorrectly formatted. In select cases, we give the "Error. This is most likely a version issue..." message you have reported. The reason we suggested you are receiving this message as a res...
by SLeon
Thu Sep 15, 2022 3:41 pm
Forum: Developers
Topic: Appointment API issues
Replies: 6
Views: 4428

Re: Appointment API issues

If you goal is to find general opening for staffing purposes, you may also find Query #1241 from our Query Examples page useful.

You can use the Queries resource in the API to run this.
by SLeon
Wed Sep 14, 2022 1:40 pm
Forum: Developers
Topic: Appointment API issues
Replies: 6
Views: 4428

Re: Appointment API issues

Sure, we can look into adding a ClinicNum parameter. However, this method already supports specifying the operatory that the provider is assigned to. Most dental offices do not have a single provider assigned to all operatories in a clinic.
by SLeon
Wed Sep 14, 2022 12:53 pm
Forum: Developers
Topic: Appointment API issues
Replies: 6
Views: 4428

Re: Appointment API issues

Appointments GET Slots can be used for dental offices with or without clinics. What does your API request look like? It is important to note that if not specifying a ProvNum in the request, the method searches using the Practice Default Provider. We recommend users provide both the ProvNum and the O...
by SLeon
Wed Sep 14, 2022 8:35 am
Forum: API
Topic: Slot API error
Replies: 13
Views: 2805

Re: Slot API error

Thank you so much for the follow up. but my version 22.2.37 still has the same problem. I used the API of 'appointments' instead of appointment/Slots. Do I need to install beta version of 22.3.6? We have just updated our public demo dental office to version 22.2.37 without issue. All API requests w...
by SLeon
Tue Sep 13, 2022 2:22 pm
Forum: API
Topic: Slot API error
Replies: 13
Views: 2805

Re: Slot API error

Updating to 22.3.6 will resolve this issue. There was problem with the eConnector that only impacted API customers using versions 22.3.4 and 22.3.5.

However, we generally advise against our customers updating to the first few versions of each beta release.
by SLeon
Mon Sep 12, 2022 8:53 am
Forum: API
Topic: Slot API error
Replies: 13
Views: 2805

Re: Slot API error

Good morning, This message from the eConnector logger file indicates that there was an issue with your eConnector service running. I have updated a test dental office to 22.2.37 as well, and am able to use the Appointments GET Slots endpoint successfully. According to our records, your eConnector ap...
by SLeon
Thu Sep 01, 2022 3:01 pm
Forum: API
Topic: Patients GET (multiple)
Replies: 3
Views: 1624

Re: Patients GET (multiple)

Good afternoon Pedro,

The Patients GET (multiple) method is the same search that occurs in the Patient Select form within Open Dental, which lacks these two fields.

However, we can absolutely add Gender and Position filters to our Patients GET Simple method, if that would be satisfactory.
by SLeon
Wed Aug 31, 2022 11:05 am
Forum: Developers
Topic: Plugin won't load in debugger (customer db)
Replies: 7
Views: 5070

Re: Plugin won't load in debugger (customer db)

Edit: I am glad you found a work around. I am leaving the below information in case others find it useful. Yes, as of 21.4 all plugins must be whitelisted here at Open Dental HQ. However, if the dental office is able to use your plugin, it is already whitelisted. This whitelisting check is based on ...
by SLeon
Wed Aug 31, 2022 10:15 am
Forum: Developers
Topic: Plugin won't load in debugger (customer db)
Replies: 7
Views: 5070

Re: Plugin won't load in debugger (customer db)

Hey there,

What is your typical process for creating your debugging environment? Which version of Open Dental are you trying to do this with, and have you been successful with pervious versions?

Lastly, what sort of output/error message display when Visual Studio fails to build in DEBUG mode?
by SLeon
Fri Aug 26, 2022 11:23 am
Forum: API
Topic: API Performance Suggestions
Replies: 13
Views: 3978

Re: API Performance Suggestions

Thank you for confirming all these details for your DEV credentials. There are two different things you can try. 1. Uninstall the API Service and update to our latest beta version (prompt the auto-install of the API Service again) We released a new beta version (22.2.31) last night. Remove your manu...
by SLeon
Thu Aug 25, 2022 9:46 am
Forum: API
Topic: API Performance Suggestions
Replies: 13
Views: 3978

Re: API Performance Suggestions

Hey there, I am sorry you are having issues starting the API Service. Could you please confirm a few things? - The API is enabled. Launch Open Dental with your DEV regkey, navigate to Setup > Advanced Setup > API, and verify that the Enabled box is checked. The OpenDentalAPIService will not automati...
by SLeon
Mon Aug 22, 2022 8:07 am
Forum: API
Topic: Order of webschedule slots
Replies: 1
Views: 1187

Re: Order of webschedule slots

The results for Appointments GET SlotsWebSched are ordered first by the start time of the time slot and then by operatory. However, we do not recommend using this method in most cases, as it requires the dental office to be signed up for our WebSched eServices and requires additional setup. We recom...
by SLeon
Thu Aug 18, 2022 9:53 am
Forum: API
Topic: API Performance Suggestions
Replies: 13
Views: 3978

Re: API Performance Suggestions

It sounds like you are using our Remote API (the api.opendental.com endpoint) mode. And while it has obvious advantages, this is our slowest API mode due to the sheer travel time. Additional layers like Middle Tier and a GCP VM could increase these times. There are two other API modes that I would r...
by SLeon
Thu Aug 11, 2022 12:46 pm
Forum: API
Topic: Python Connector
Replies: 1
Views: 1344

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: 5
Views: 2239

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: 1179

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: 1736

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: 4176

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: 4176

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: 1292

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: 2291

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: 2291

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: 9
Views: 3196

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: 9
Views: 3196

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: 4176

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: 5549

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: 5549

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: 4176

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: 4176

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: 5549

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: 5549

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: 5549

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: 9
Views: 3196

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: 1341

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: 4176

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: 1520

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: 4708

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: 2146

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: 2146

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: 2112

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: 2146

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: 2112

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: 2112

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: 3049

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: 9
Views: 3196

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: 3049

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: 1754

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: 1919

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: 2316

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: 1919

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: 14
Views: 3926

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: 14
Views: 3926

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: 14
Views: 3926

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: 1754

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: 1693

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: 1385

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: 3049

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: 1693

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: 3049

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: 21
Views: 5814

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: 2654

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: 2316

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: 21
Views: 5814

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: 21
Views: 5814

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: 21
Views: 5814

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: 21
Views: 5814

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: 2101

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: 1838

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: 3315

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: 2879

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: 2654

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: 3686

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: 2879

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: 2654

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: 3686

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: 8571

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: 2258

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: 2258

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: 8555

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: 3686

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: 4611

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: 3082

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: 3686

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: 4470

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: 8555

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: 4470

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: 4330

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: 4470

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: 4470

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: 3686

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: 3082

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: 4470

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: 8555

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: 4246

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: 4611

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: 1637

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: 4330

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: 4611

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: 3315

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: 15900

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: 1666

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: 8555

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: 1788

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: 4611

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: 4330

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: 3082

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: 15900

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: 4246

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 11:47 am
Forum: API
Topic: API Demo Dental Office offline for maintenance
Replies: 1
Views: 1704

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 12:49 pm
Forum: API
Topic: API Demo Dental Office offline for maintenance
Replies: 1
Views: 1704

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 3:55 pm
Forum: Developers
Topic: Where is ODApi.dll (opendental 22.1)?
Replies: 3
Views: 4527

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 12:53 pm
Forum: Developers
Topic: Where is ODApi.dll (opendental 22.1)?
Replies: 3
Views: 4527

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 9:33 am
Forum: API
Topic: Document Category clarification
Replies: 12
Views: 4611

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 8:24 am
Forum: API
Topic: Document Category clarification
Replies: 12
Views: 4611

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 2:32 pm
Forum: API
Topic: Requests for new API endpoints and new fields for an existing endpoint
Replies: 21
Views: 8555

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 2:29 pm
Forum: API
Topic: API Request
Replies: 19
Views: 8571

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 3:48 pm
Forum: API
Topic: API: high/duplicate AptNum returned by Appointments GET (multiple)
Replies: 4
Views: 3016

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 11:09 am
Forum: API
Topic: API Request
Replies: 19
Views: 8571

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 9:53 am
Forum: API
Topic: Requests for new API endpoints and new fields for an existing endpoint
Replies: 21
Views: 8555

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 8:01 am
Forum: API
Topic: ASAP and Appointments GET (multiple)
Replies: 2
Views: 2361

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 2:08 pm
Forum: API
Topic: Short Query - Possible Bug
Replies: 3
Views: 2466

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 11:28 am
Forum: API
Topic: Short Query - Possible Bug
Replies: 3
Views: 2466

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 5:30 pm
Forum: API
Topic: Tier 4 API Key - "Developer API key does not have permission for ApiReadAll."
Replies: 1
Views: 1837

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 11:36 am
Forum: API
Topic: Does the patientNotes PUT endpoint allow setting the `Service` column of the `patientnote` table?
Replies: 5
Views: 3479

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 10:46 am
Forum: API
Topic: GET - OpenDental DB name and images path
Replies: 1
Views: 1758

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 8:51 am
Forum: API
Topic: Requests for new API endpoints and new fields for an existing endpoint
Replies: 21
Views: 8555

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 3:01 pm
Forum: API
Topic: API Issue - Slots
Replies: 11
Views: 5090

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 2:50 pm
Forum: API
Topic: API Issue - Slots
Replies: 11
Views: 5090

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 2:21 pm
Forum: API
Topic: Postman Response - "The server has encountered an error."
Replies: 3
Views: 2576

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 12:11 pm
Forum: API
Topic: API Issue - Slots
Replies: 11
Views: 5090

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 10:29 am
Forum: API
Topic: API Features Requested
Replies: 25
Views: 15900

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 2:51 pm
Forum: API
Topic: Does the patientNotes PUT endpoint allow setting the `Service` column of the `patientnote` table?
Replies: 5
Views: 3479

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 2:07 pm
Forum: API
Topic: New API Request
Replies: 9
Views: 4246

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 8:17 am
Forum: API
Topic: ShortQuery help
Replies: 3
Views: 2289

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...