Skip to main content

API R2

· 3 min read
Craig Herrington

As we progress into delivering more capability of the API we have a large release of related API endpoints across multiple domains.

The following changes will be available in Release 2 of our VIP API's.

Account Management​

  • GET /accounts - account-type-id query parameter added
  • GET /introduced-by-types - moved from /accounts/introduced-by-types
  • POST /accounts - New endpoint
  • POST /introduced-by-types - New endpoint

Calendar Management​

  • POST /appointments - New endpoint
  • DELETE /appointments - New endpoint
  • GET /appointments/:appointment-uuid/statuses - New endpoint
  • GET /appointment-status-types - New endpoint
  • GET /appointment-status-types/:appointment-status-type-uuid - New endpoint
  • GET /availability/:location-uuid/available - New endpoint
  • Changed GET /reasons - Added new query filter ‘active’
  • Changed GET /reasons - Added new query filter ‘search-name’

Clinical​

  • GET /vital-metrics/weight - New endpoint

Communications​

  • GET /communication-channels - New endpoint
  • GET /communication-channels/:channel-uuid - New endpoint
  • POST /communication-logs - New endpoint
  • GET /communication-types - New endpoint
  • GET /communication-types/:type-uuid - New endpoint

Contact-Management​

  • POST /contacts - New endpoint
  • PUT /contacts/:contact-uuid - New endpoint
  • DELETE /contacts/:contact-uuid - New endpoint
  • POST /contacts/:contact-uuid/addresses - New endpoint
  • POST /contacts/:contact-uuid/data-consent - New endpoint
  • POST /contacts/:contact-uuid/emails - New endpoint
  • POST /contacts/:contact-uuid/numbers - New endpoint
  • POST /contacts/:contact-uuid/communication-preferences - New endpoint
  • GET /contacts/emails - New endpoint
  • GET /contacts/numbers - New endpoint
  • GET /titles - New endpoint
  • GET /titles/:title-uuid - New endpoint
  • GET /data-consent-type - New endpoint
  • Changed GET /cities - Added new query filter ‘search-name’
  • Changed GET /contacts/:contact-uuid/addresses - City is now a string from previous uuid from the city library.
  • Changed POST /contacts/:contact-uuid/addresses - City is now a string from previous uuid from the city library.
  • Changed GET /practitioners/practitioner-types - No longer includes non-human practitioner types.
  • Changed GET /practitioners - Now includes practitioner name and no longer includes non-human practitioner types.
  • GET /practitioners - New optional query for filtering results (location-uuid)

Patient-Management​

  • POST /patients - New endpoint
  • GET /patient-categories - New query filter for species.
  • GET /colours - New endpoint
  • GET /colours/:colour-uuid - New endpoint
  • GET /species/:species-uuid/breeds - New endpoint
  • GET /species/:species-uuid/genders - New endpoint
  • GET /breeds/:breed-uuid/colours - New endpoint
  • Changed GET /breeds - Added new query filter ‘active’
  • Changed GET /genders - Added new query filter ‘active’
  • Changed GET /breeds - Added new query filter ‘search-name’
  • Changed GET /species - Added new query filter ‘search-name’

Reminders​

  • New Domain for Reminders
  • GET /patient-reminders - New endpoint
  • GET /patient-reminders/reminder-types - New endpoint
  • GET /treatment-reminders - New endpoint

Locations​

  • Changed GET /locations - City is now a string from previous uuid from the city library.

If you have any questions please contact us.