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

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

Create contact association

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
associatedContactIdstringrequired

Associated/related contact.

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

Classification of the relationship between the contacts.

Enum"family""other"
contactAssociationIdstringrequired

Canonical identifier for this contact association.

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

Primary contact in the association.

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

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Whether this association is currently active.

associationTypeobjectrequired
associationType.​codestringrequired

Code value

associationType.​systemstringrequired

Code system URI

associationType.​displaystring

Human-readable display

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/contact-association' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "associatedContactId": "123e4567-e89b-12d3-a456-426614174000",
    "associationClass": "family",
    "contactAssociationId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "associationType": {
      "code": "string",
      "system": "string",
      "display": "string"
    }
  }'

Responses

Contact Association created successfully

Bodyapplication/json
associatedContactIdstringrequired

Associated/related contact.

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

Classification of the relationship between the contacts.

Enum"family""other"
contactAssociationIdstringrequired

Canonical identifier for this contact association.

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

Primary contact in the association.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)required

Timestamp when the association was created.

Example: "2025-01-01T00:00:00.000Z"
extensionsobjectrequired

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Whether this association is currently active.

updatedAtstring(date-time)required

Timestamp when the association was last updated.

Example: "2025-01-01T00:00:00.000Z"
associationTypeobjectrequired
associationType.​codestringrequired

Code value

associationType.​systemstringrequired

Code system URI

associationType.​displaystring

Human-readable display

Response
application/json
{
  "associatedContactId": "123e4567-e89b-12d3-a456-426614174000",
  "associationClass": "family",
  "contactAssociationId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "associationType": {
    "code": "string",
    "system": "string",
    "display": "string"
  }
}

List contact associations

Request

Returns a paginated list of Contact Associations 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"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
associatedContactIdstring

Associated/related contact.

Example: associatedContactId=123e4567-e89b-12d3-a456-426614174000
associationClassstring

Classification of the relationship between the contacts.

Enum"family""other"
contactIdstring

Primary contact in the association.

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

Whether this association is currently active.

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/contact-association?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&associatedContactId=123e4567-e89b-12d3-a456-426614174000&associationClass=family&contactId=123e4567-e89b-12d3-a456-426614174000&isActive=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Contact Associations

Get contact association

Request

Returns a single Contact Association by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

contactAssociationIdstringrequired

Contact Association unique identifier (UUID)

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

Responses

Contact Association found

Bodyapplication/json
associatedContactIdstringrequired

Associated/related contact.

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

Classification of the relationship between the contacts.

Enum"family""other"
contactAssociationIdstringrequired

Canonical identifier for this contact association.

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

Primary contact in the association.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)required

Timestamp when the association was created.

Example: "2025-01-01T00:00:00.000Z"
extensionsobjectrequired

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Whether this association is currently active.

updatedAtstring(date-time)required

Timestamp when the association was last updated.

Example: "2025-01-01T00:00:00.000Z"
associationTypeobjectrequired
associationType.​codestringrequired

Code value

associationType.​systemstringrequired

Code system URI

associationType.​displaystring

Human-readable display

Response
application/json
{
  "associatedContactId": "123e4567-e89b-12d3-a456-426614174000",
  "associationClass": "family",
  "contactAssociationId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "associationType": {
    "code": "string",
    "system": "string",
    "display": "string"
  }
}

Update contact association

Request

Partially updates an existing Contact Association. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

contactAssociationIdstringrequired

Contact Association unique identifier (UUID)

Bodyapplication/jsonrequired
associatedContactIdstring

Associated/related contact.

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

Classification of the relationship between the contacts.

Enum"family""other"
contactIdstring

Primary contact in the association.

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

Vendor- or practice-specific extension fields.

isActiveboolean

Whether this association is currently active.

associationTypeobject
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/contact-association/{contactAssociationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "associatedContactId": "123e4567-e89b-12d3-a456-426614174000",
    "associationClass": "family",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "associationType": {
      "code": "string",
      "system": "string",
      "display": "string"
    }
  }'

Responses

Contact Association updated successfully

Bodyapplication/json
associatedContactIdstringrequired

Associated/related contact.

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

Classification of the relationship between the contacts.

Enum"family""other"
contactAssociationIdstringrequired

Canonical identifier for this contact association.

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

Primary contact in the association.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)required

Timestamp when the association was created.

Example: "2025-01-01T00:00:00.000Z"
extensionsobjectrequired

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Whether this association is currently active.

updatedAtstring(date-time)required

Timestamp when the association was last updated.

Example: "2025-01-01T00:00:00.000Z"
associationTypeobjectrequired
associationType.​codestringrequired

Code value

associationType.​systemstringrequired

Code system URI

associationType.​displaystring

Human-readable display

Response
application/json
{
  "associatedContactId": "123e4567-e89b-12d3-a456-426614174000",
  "associationClass": "family",
  "contactAssociationId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "associationType": {
    "code": "string",
    "system": "string",
    "display": "string"
  }
}

Replace contact association

Request

Fully replaces an existing Contact Association. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

contactAssociationIdstringrequired

Contact Association unique identifier (UUID)

Bodyapplication/jsonrequired
associatedContactIdstringrequired

Associated/related contact.

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

Classification of the relationship between the contacts.

Enum"family""other"
contactIdstringrequired

Primary contact in the association.

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

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Whether this association is currently active.

associationTypeobjectrequired
associationType.​codestringrequired

Code value

associationType.​systemstringrequired

Code system URI

associationType.​displaystring

Human-readable display

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/contact-association/{contactAssociationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "associatedContactId": "123e4567-e89b-12d3-a456-426614174000",
    "associationClass": "family",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "associationType": {
      "code": "string",
      "system": "string",
      "display": "string"
    }
  }'

Responses

Contact Association replaced successfully

Bodyapplication/json
associatedContactIdstringrequired

Associated/related contact.

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

Classification of the relationship between the contacts.

Enum"family""other"
contactAssociationIdstringrequired

Canonical identifier for this contact association.

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

Primary contact in the association.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)required

Timestamp when the association was created.

Example: "2025-01-01T00:00:00.000Z"
extensionsobjectrequired

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Whether this association is currently active.

updatedAtstring(date-time)required

Timestamp when the association was last updated.

Example: "2025-01-01T00:00:00.000Z"
associationTypeobjectrequired
associationType.​codestringrequired

Code value

associationType.​systemstringrequired

Code system URI

associationType.​displaystring

Human-readable display

Response
application/json
{
  "associatedContactId": "123e4567-e89b-12d3-a456-426614174000",
  "associationClass": "family",
  "contactAssociationId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "associationType": {
    "code": "string",
    "system": "string",
    "display": "string"
  }
}

Delete contact association

Request

Permanently deletes a Contact Association record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

contactAssociationIdstringrequired

Contact Association unique identifier (UUID)

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

Responses

Contact Association deleted successfully

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