Skip to main content

API R15

· 3 min read
Craig Herrington

Release 15 of the API includes 4 new endpoints and 7 changes to existing endpoints.

We will continue to release new endpoints, if you have any capabilities you want to see, please speak to us.

Release Date

The UAT API will be updated Thursday 21-November-2024.

The Live API release date to be confirmed for Wednesday 27-November-2024 between 20:00 and 00:00 UTC.

Times may change without notice, no downtime of the API is expected.

All Domains​

Framework maintenance across all domains has occured and all services will be updated during this release.

View Billing Spec

Billing​

CHANGE POST /v1/api/payments

  • Updated validation with correct error message when invoice-uuid's supplied are not for the supplied billing-uuid.
View Calendar Spec

Calendar Management​

CHANGE POST
  • Improved validation messages when booking appointments, tasks or unavailability for clarity.

CHANGE POST /v1/api/availability

  • Added a payload field for unavailability-reason, which when provided will block the entire availability range with unavailble blocks upon creation.

CHANGE DELETE /v1/api/availability

  • Added a payload field for delete-unavailability, when true this will delete all blocks at the time of deletion; If false and an unavailability block is present the request will fail.

NEW POST /v1/api/availability/blocks

  • New endpoint allow blocking availbility slots to block from usage in appointment booking.

NEW DELETE /v1/api/availability/blocks

  • New endpoint allow deletion of availability blocking.

CHANGE POST /v1/api/appointments

  • Added a payload field for booked-by
View Clinical Spec

Clinical​

CHANGE GET /v1/api/vital-metric/weight

  • Added handling of a internal server error.
View Communications Spec

Communications and Documents​

CHANGE POST /v1/api/communication-logs

  • Resolved internal server error occured when linking an uploaded document to the communication log.

CHANGE POST /v1/api/documents/upload

  • Incorrectly returned internal server error will now show correct validation message when unsupported characters are found in the file name.
View Contact Spec

Contact Management​

NEW GET /v1/api/contact/addresses

  • This new endpoint will allow searching of client's by their mailing addresses.
  • All query parameters are STARTSWITH operations while searching.

NEW PATCH /v1/api/contact/addresses

  • This new endpoint will allow searching of client's by their mailing addresses.
  • All query parameters are STARTSWITH operations while searching.

If you have any questions please contact us.