22.11 Release - API Change: Concurrent request errors for changed endpoints changed from 5xx to 4xx errors

Summary

With the 22.11 tri-annual release, when too many concurrent requests are made for changed endpoints, a 429 error will be returned, alerting you that the API calls being made should not be called at the current rate and must be resolved within your apps’ code. Previously a 503 error was returned, indicating that athenahealth’s services are down. This change will alert you of actions needed on your end to resolve the error.   

Products

athenaCollector, athenaClinicals

Roles

Management/Technical

Available

November 11th, 2022 (22.11 tri-annual release)

Highlights

Concurrent request errors for changed endpoints to return a 429 error instead of a 503 to alert users of actions needed within their app to resolve the error 

Setup

  • N/A

Is this a breaking change

YES

Endpoints affected

  • N/A

New Endpoints

  • N/A

Resources

Refer to the following resources for more information:

What is changing

Today, when too many concurrent requests for changed endpoints are made, a 503 error is returned, indicating that athenahealth’s services are unavailable due to a server-side problem. However, concurrent requests must be resolved within the app itself. Thus, concurrent requests for changed endpoints will now return a 429 error message to alert you specifically of actions needed by you and your team. 

Why we’re making the change

While athenahealth’s services become unavailable to customers when too many requests are made, this can be resolved by making changes to your API calls. To alert users of this and provide more granular troubleshooting abilities for changed endpoints, concurrent requests will now return a 4xx error to alert you that your API calls should not be called at the current rate and the issue must be resolved within your apps’ code 

What will current users of the endpoint need to update in their code

Nothing 

What will happen if users of the endpoint do not update their code

No changes are needed to specific endpoints. However, this is a breaking change. You should review your code to determine if the change from a 503 to a 429 error for your changed endpoints will impact your code strategy for handling errors.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

On this Page