Skip to content

AHDS Store API (1.0)

Animal Health Data Store - V1 API Documentation

Overview
Languages
Servers
Mock server

https://docs.heydonto.com/_mock/apis/animal-health/openapi/

Local Development

http://localhost:8083/

Address

Operations

Create address

Request

Creates a new Address record. Address resource in the Animal Health Data Store

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
addressIdstringrequired

Canonical unique identifier for the address.

Example: "123e4567-e89b-12d3-a456-426614174000"
citystring

City, town, or locality.

contactIdstringrequired

Identifier of the contact this address belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
countryCodestring

ISO 3166-1 alpha-2 country code when available; otherwise a system-specific country identifier.

distanceobject
extensionsobject

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the address is currently active/usable.

latitudenumber

Latitude in decimal degrees (WGS84).

line1string

First line of the street address.

line2string

Second line of the street address.

longitudenumber

Longitude in decimal degrees (WGS84).

namestring

Optional label or name for the address (e.g., 'Home', 'Work').

postalCodestring

Postal or ZIP code.

regionstring

Region, province, or county.

statestring

State or territory (where applicable).

suburbstring

Suburb, neighborhood, or village.

countryobjectrequired
country.​codestringrequired

Code value

country.​systemstringrequired

Code system URI

country.​displaystring

Human-readable display

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/address' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "addressId": "123e4567-e89b-12d3-a456-426614174000",
    "city": "string",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "countryCode": "string",
    "distance": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "extensions": {},
    "isActive": true,
    "latitude": 0,
    "line1": "string",
    "line2": "string",
    "longitude": 0,
    "name": "string",
    "postalCode": "string",
    "region": "string",
    "state": "string",
    "suburb": "string",
    "country": {
      "code": "string",
      "system": "string",
      "display": "string"
    }
  }'

Responses

Address created successfully

Bodyapplication/json
addressIdstringrequired

Canonical unique identifier for the address.

Example: "123e4567-e89b-12d3-a456-426614174000"
citystringrequired

City, town, or locality.

contactIdstringrequired

Identifier of the contact this address belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
countryCodestringrequired

ISO 3166-1 alpha-2 country code when available; otherwise a system-specific country identifier.

createdAtstring(date-time)required

Timestamp when the address was created.

Example: "2025-01-01T00:00:00.000Z"
distanceobjectrequired
distance.​valuenumberrequired

Numeric value

distance.​unitstringrequired

Unit of measure

distance.​systemstring

Unit system URI

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the address is currently active/usable.

latitudenumberrequired

Latitude in decimal degrees (WGS84).

line1stringrequired

First line of the street address.

line2stringrequired

Second line of the street address.

longitudenumberrequired

Longitude in decimal degrees (WGS84).

namestringrequired

Optional label or name for the address (e.g., 'Home', 'Work').

postalCodestringrequired

Postal or ZIP code.

regionstringrequired

Region, province, or county.

statestringrequired

State or territory (where applicable).

suburbstringrequired

Suburb, neighborhood, or village.

updatedAtstring(date-time)required

Timestamp when the address was last updated.

Example: "2025-01-01T00:00:00.000Z"
countryobjectrequired
country.​codestringrequired

Code value

country.​systemstringrequired

Code system URI

country.​displaystring

Human-readable display

Response
application/json
{
  "addressId": "123e4567-e89b-12d3-a456-426614174000",
  "city": "string",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "countryCode": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "distance": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "extensions": {},
  "isActive": true,
  "latitude": 0,
  "line1": "string",
  "line2": "string",
  "longitude": 0,
  "name": "string",
  "postalCode": "string",
  "region": "string",
  "state": "string",
  "suburb": "string",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "country": {
    "code": "string",
    "system": "string",
    "display": "string"
  }
}

List addresses

Request

Returns a paginated list of Addresses for the specified site. Supports filtering and sorting.

Security
bearer
Path
siteIdnumberrequired

Site identifier

Query
pagenumber>= 0

Page number (0-indexed)

Default 0
pageSizenumber[ 1 .. 100 ]

Number of items per page

Default 10
sortBystring

Field to sort by

Enum"createdAt""updatedAt""city""countryCode""latitude""line1""line2""longitude""name""postalCode"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
citystring

City, town, or locality.

contactIdstring

Identifier of the contact this address belongs to.

Example: contactId=123e4567-e89b-12d3-a456-426614174000
countryCodestring

ISO 3166-1 alpha-2 country code when available; otherwise a system-specific country identifier.

isActiveboolean

Whether the address is currently active/usable.

line1string

First line of the street address.

line2string

Second line of the street address.

namestring

Optional label or name for the address (e.g., 'Home', 'Work').

postalCodestring

Postal or ZIP code.

regionstring

Region, province, or county.

statestring

State or territory (where applicable).

suburbstring

Suburb, neighborhood, or village.

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/address?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&city=string&contactId=123e4567-e89b-12d3-a456-426614174000&countryCode=string&isActive=true&line1=string&line2=string&name=string&postalCode=string&region=string&state=string&suburb=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Addresses

Get address

Request

Returns a single Address by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

addressIdstringrequired

Address unique identifier (UUID)

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/address/{addressId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Address found

Bodyapplication/json
addressIdstringrequired

Canonical unique identifier for the address.

Example: "123e4567-e89b-12d3-a456-426614174000"
citystringrequired

City, town, or locality.

contactIdstringrequired

Identifier of the contact this address belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
countryCodestringrequired

ISO 3166-1 alpha-2 country code when available; otherwise a system-specific country identifier.

createdAtstring(date-time)required

Timestamp when the address was created.

Example: "2025-01-01T00:00:00.000Z"
distanceobjectrequired
distance.​valuenumberrequired

Numeric value

distance.​unitstringrequired

Unit of measure

distance.​systemstring

Unit system URI

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the address is currently active/usable.

latitudenumberrequired

Latitude in decimal degrees (WGS84).

line1stringrequired

First line of the street address.

line2stringrequired

Second line of the street address.

longitudenumberrequired

Longitude in decimal degrees (WGS84).

namestringrequired

Optional label or name for the address (e.g., 'Home', 'Work').

postalCodestringrequired

Postal or ZIP code.

regionstringrequired

Region, province, or county.

statestringrequired

State or territory (where applicable).

suburbstringrequired

Suburb, neighborhood, or village.

updatedAtstring(date-time)required

Timestamp when the address was last updated.

Example: "2025-01-01T00:00:00.000Z"
countryobjectrequired
country.​codestringrequired

Code value

country.​systemstringrequired

Code system URI

country.​displaystring

Human-readable display

Response
application/json
{
  "addressId": "123e4567-e89b-12d3-a456-426614174000",
  "city": "string",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "countryCode": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "distance": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "extensions": {},
  "isActive": true,
  "latitude": 0,
  "line1": "string",
  "line2": "string",
  "longitude": 0,
  "name": "string",
  "postalCode": "string",
  "region": "string",
  "state": "string",
  "suburb": "string",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "country": {
    "code": "string",
    "system": "string",
    "display": "string"
  }
}

Update address

Request

Partially updates an existing Address. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

addressIdstringrequired

Address unique identifier (UUID)

Bodyapplication/jsonrequired
citystring

City, town, or locality.

contactIdstring

Identifier of the contact this address belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
countryCodestring

ISO 3166-1 alpha-2 country code when available; otherwise a system-specific country identifier.

distanceobject
extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Whether the address is currently active/usable.

latitudenumber

Latitude in decimal degrees (WGS84).

line1string

First line of the street address.

line2string

Second line of the street address.

longitudenumber

Longitude in decimal degrees (WGS84).

namestring

Optional label or name for the address (e.g., 'Home', 'Work').

postalCodestring

Postal or ZIP code.

regionstring

Region, province, or county.

statestring

State or territory (where applicable).

suburbstring

Suburb, neighborhood, or village.

countryobject
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/address/{addressId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "city": "string",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "countryCode": "string",
    "distance": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "extensions": {},
    "isActive": true,
    "latitude": 0,
    "line1": "string",
    "line2": "string",
    "longitude": 0,
    "name": "string",
    "postalCode": "string",
    "region": "string",
    "state": "string",
    "suburb": "string",
    "country": {
      "code": "string",
      "system": "string",
      "display": "string"
    }
  }'

Responses

Address updated successfully

Bodyapplication/json
addressIdstringrequired

Canonical unique identifier for the address.

Example: "123e4567-e89b-12d3-a456-426614174000"
citystringrequired

City, town, or locality.

contactIdstringrequired

Identifier of the contact this address belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
countryCodestringrequired

ISO 3166-1 alpha-2 country code when available; otherwise a system-specific country identifier.

createdAtstring(date-time)required

Timestamp when the address was created.

Example: "2025-01-01T00:00:00.000Z"
distanceobjectrequired
distance.​valuenumberrequired

Numeric value

distance.​unitstringrequired

Unit of measure

distance.​systemstring

Unit system URI

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the address is currently active/usable.

latitudenumberrequired

Latitude in decimal degrees (WGS84).

line1stringrequired

First line of the street address.

line2stringrequired

Second line of the street address.

longitudenumberrequired

Longitude in decimal degrees (WGS84).

namestringrequired

Optional label or name for the address (e.g., 'Home', 'Work').

postalCodestringrequired

Postal or ZIP code.

regionstringrequired

Region, province, or county.

statestringrequired

State or territory (where applicable).

suburbstringrequired

Suburb, neighborhood, or village.

updatedAtstring(date-time)required

Timestamp when the address was last updated.

Example: "2025-01-01T00:00:00.000Z"
countryobjectrequired
country.​codestringrequired

Code value

country.​systemstringrequired

Code system URI

country.​displaystring

Human-readable display

Response
application/json
{
  "addressId": "123e4567-e89b-12d3-a456-426614174000",
  "city": "string",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "countryCode": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "distance": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "extensions": {},
  "isActive": true,
  "latitude": 0,
  "line1": "string",
  "line2": "string",
  "longitude": 0,
  "name": "string",
  "postalCode": "string",
  "region": "string",
  "state": "string",
  "suburb": "string",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "country": {
    "code": "string",
    "system": "string",
    "display": "string"
  }
}

Replace address

Request

Fully replaces an existing Address. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

addressIdstringrequired

Address unique identifier (UUID)

Bodyapplication/jsonrequired
citystringrequired

City, town, or locality.

contactIdstringrequired

Identifier of the contact this address belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
countryCodestringrequired

ISO 3166-1 alpha-2 country code when available; otherwise a system-specific country identifier.

distanceobjectrequired
distance.​valuenumberrequired

Numeric value

distance.​unitstringrequired

Unit of measure

distance.​systemstring

Unit system URI

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the address is currently active/usable.

latitudenumberrequired

Latitude in decimal degrees (WGS84).

line1stringrequired

First line of the street address.

line2stringrequired

Second line of the street address.

longitudenumberrequired

Longitude in decimal degrees (WGS84).

namestringrequired

Optional label or name for the address (e.g., 'Home', 'Work').

postalCodestringrequired

Postal or ZIP code.

regionstringrequired

Region, province, or county.

statestringrequired

State or territory (where applicable).

suburbstringrequired

Suburb, neighborhood, or village.

countryobjectrequired
country.​codestringrequired

Code value

country.​systemstringrequired

Code system URI

country.​displaystring

Human-readable display

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/address/{addressId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "city": "string",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "countryCode": "string",
    "distance": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "extensions": {},
    "isActive": true,
    "latitude": 0,
    "line1": "string",
    "line2": "string",
    "longitude": 0,
    "name": "string",
    "postalCode": "string",
    "region": "string",
    "state": "string",
    "suburb": "string",
    "country": {
      "code": "string",
      "system": "string",
      "display": "string"
    }
  }'

Responses

Address replaced successfully

Bodyapplication/json
addressIdstringrequired

Canonical unique identifier for the address.

Example: "123e4567-e89b-12d3-a456-426614174000"
citystringrequired

City, town, or locality.

contactIdstringrequired

Identifier of the contact this address belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
countryCodestringrequired

ISO 3166-1 alpha-2 country code when available; otherwise a system-specific country identifier.

createdAtstring(date-time)required

Timestamp when the address was created.

Example: "2025-01-01T00:00:00.000Z"
distanceobjectrequired
distance.​valuenumberrequired

Numeric value

distance.​unitstringrequired

Unit of measure

distance.​systemstring

Unit system URI

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the address is currently active/usable.

latitudenumberrequired

Latitude in decimal degrees (WGS84).

line1stringrequired

First line of the street address.

line2stringrequired

Second line of the street address.

longitudenumberrequired

Longitude in decimal degrees (WGS84).

namestringrequired

Optional label or name for the address (e.g., 'Home', 'Work').

postalCodestringrequired

Postal or ZIP code.

regionstringrequired

Region, province, or county.

statestringrequired

State or territory (where applicable).

suburbstringrequired

Suburb, neighborhood, or village.

updatedAtstring(date-time)required

Timestamp when the address was last updated.

Example: "2025-01-01T00:00:00.000Z"
countryobjectrequired
country.​codestringrequired

Code value

country.​systemstringrequired

Code system URI

country.​displaystring

Human-readable display

Response
application/json
{
  "addressId": "123e4567-e89b-12d3-a456-426614174000",
  "city": "string",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "countryCode": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "distance": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "extensions": {},
  "isActive": true,
  "latitude": 0,
  "line1": "string",
  "line2": "string",
  "longitude": 0,
  "name": "string",
  "postalCode": "string",
  "region": "string",
  "state": "string",
  "suburb": "string",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "country": {
    "code": "string",
    "system": "string",
    "display": "string"
  }
}

Delete address

Request

Permanently deletes a Address record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

addressIdstringrequired

Address unique identifier (UUID)

curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/address/{addressId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Address deleted successfully

Animal

Operations

Animal Colour

Operations

Appointment

Operations

Appointment Status

Operations

Appointment Type

Operations

Assessment

Operations

Attachment

Operations

Availability

Operations

Availability Slot

Operations

Barcode

Operations

Batch

Operations

Billing Credit

Operations

Billing Line

Operations

Booking

Operations

Breed

Operations

Communication

Operations

Consult

Operations

Contact

Operations

Contact Association

Operations

Contact Detail

Operations

Country

Operations

Diagnostic

Operations

Diagnostic Code

Operations

Diagnostic Request

Operations

Diagnostic Result

Operations

Diagnostic Result Item

Operations

Estimate

Operations

Eventgroup

Operations

External Prescription

Operations

Facility

Operations

File

Operations

File Upload

Operations

Health Status

Operations

Herd

Operations

History

Operations

Insurance

Operations

Integrated Diagnostic

Operations

Inventory Message

Operations

Inventory Product

Operations

Inventory Requirement

Operations

Inventory Supplied Product

Operations

Invoice

Operations

Invoiceline

Operations

Ledger Account

Operations

Linked Payment

Operations

Location

Operations

Message

Operations

Modality

Operations

Operation

Operations

Payment

Operations

Paymentmethod

Operations

Physical Exam

Operations

Plan

Operations

Practitioner

Operations

Prescription

Operations

Prescription Item

Operations

Presentingproblem

Operations

Price Adjustment

Operations

Product

Operations

Product Minimum Stock

Operations

Product Pricing

Operations

Product Supplier

Operations

Productgroup

Operations

Purchaseorder

Operations

Purchaseorderitem

Operations

Receive Invoice

Operations

Receive Invoice Item

Operations

Requisition Form

Operations

Resource

Operations

Separation

Operations

Sex

Operations

Shelter Animal Booking

Operations

Site Information

Operations

Species

Operations

Standard Diagnostic Lab Report

Operations

Standardofcare

Operations

Stock Adjustment

Operations

Stock Adjustment Item

Operations

Stock Transaction

Operations

Supplied

Operations

System Setting

Operations

Tag

Operations

Tagcategory

Operations

Tagname

Operations

Taxrate

Operations

Template

Operations

Therapeutic

Operations

Transaction

Operations

User

Operations

Vaccination

Operations

Webhook

Operations

Webhook Event

Operations

Wellness Resource

Operations

With Primary Inventory Location

Operations