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

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

Create separation

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
categorystring

High-level category of separation.

Enum"ownership""location""grouping""other"
childEntityIdstring

Identifier of the child entity in the separation relationship (e.g., separated animal, destination group).

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

Optional client-supplied identifier for idempotency or cross-system correlation.

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

Reference to the associated contact, if applicable.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this separation record is currently active.

namestring

Human-readable name or label for the separation.

parentEntityIdstring

Identifier of the parent entity in the separation relationship (e.g., owner, source group).

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

Canonical identifier for this separation relationship.

Example: "123e4567-e89b-12d3-a456-426614174000"
separationTypeobject
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/separation' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "category": "ownership",
    "childEntityId": "123e4567-e89b-12d3-a456-426614174000",
    "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "parentEntityId": "123e4567-e89b-12d3-a456-426614174000",
    "separationId": "123e4567-e89b-12d3-a456-426614174000",
    "separationType": {
      "code": "string",
      "system": "string",
      "display": "string"
    }
  }'

Responses

Separation created successfully

Bodyapplication/json
categorystringrequired

High-level category of separation.

Enum"ownership""location""grouping""other"
childEntityIdstringrequired

Identifier of the child entity in the separation relationship (e.g., separated animal, destination group).

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

Optional client-supplied identifier for idempotency or cross-system correlation.

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

Reference to the associated contact, if applicable.

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

Timestamp when this separation record was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this separation record is currently active.

namestringrequired

Human-readable name or label for the separation.

parentEntityIdstringrequired

Identifier of the parent entity in the separation relationship (e.g., owner, source group).

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

Canonical identifier for this separation relationship.

Example: "123e4567-e89b-12d3-a456-426614174000"
separationTypeobjectrequired
separationType.​codestringrequired

Code value

separationType.​systemstringrequired

Code system URI

separationType.​displaystring

Human-readable display

updatedAtstring(date-time)required

Timestamp when this separation record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "category": "ownership",
  "childEntityId": "123e4567-e89b-12d3-a456-426614174000",
  "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "parentEntityId": "123e4567-e89b-12d3-a456-426614174000",
  "separationId": "123e4567-e89b-12d3-a456-426614174000",
  "separationType": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

List separations

Request

Returns a paginated list of Separations 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""name"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
categorystring

High-level category of separation.

Enum"ownership""location""grouping""other"
childEntityIdstring

Identifier of the child entity in the separation relationship (e.g., separated animal, destination group).

Example: childEntityId=123e4567-e89b-12d3-a456-426614174000
clientProvidedIdstring

Optional client-supplied identifier for idempotency or cross-system correlation.

Example: clientProvidedId=123e4567-e89b-12d3-a456-426614174000
contactIdstring

Reference to the associated contact, if applicable.

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

Whether this separation record is currently active.

namestring

Human-readable name or label for the separation.

parentEntityIdstring

Identifier of the parent entity in the separation relationship (e.g., owner, source group).

Example: parentEntityId=123e4567-e89b-12d3-a456-426614174000
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/separation?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&category=ownership&childEntityId=123e4567-e89b-12d3-a456-426614174000&clientProvidedId=123e4567-e89b-12d3-a456-426614174000&contactId=123e4567-e89b-12d3-a456-426614174000&isActive=true&name=string&parentEntityId=123e4567-e89b-12d3-a456-426614174000' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Separations

Get separation

Request

Returns a single Separation by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

separationIdstringrequired

Separation unique identifier (UUID)

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

Responses

Separation found

Bodyapplication/json
categorystringrequired

High-level category of separation.

Enum"ownership""location""grouping""other"
childEntityIdstringrequired

Identifier of the child entity in the separation relationship (e.g., separated animal, destination group).

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

Optional client-supplied identifier for idempotency or cross-system correlation.

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

Reference to the associated contact, if applicable.

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

Timestamp when this separation record was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this separation record is currently active.

namestringrequired

Human-readable name or label for the separation.

parentEntityIdstringrequired

Identifier of the parent entity in the separation relationship (e.g., owner, source group).

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

Canonical identifier for this separation relationship.

Example: "123e4567-e89b-12d3-a456-426614174000"
separationTypeobjectrequired
separationType.​codestringrequired

Code value

separationType.​systemstringrequired

Code system URI

separationType.​displaystring

Human-readable display

updatedAtstring(date-time)required

Timestamp when this separation record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "category": "ownership",
  "childEntityId": "123e4567-e89b-12d3-a456-426614174000",
  "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "parentEntityId": "123e4567-e89b-12d3-a456-426614174000",
  "separationId": "123e4567-e89b-12d3-a456-426614174000",
  "separationType": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Update separation

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

separationIdstringrequired

Separation unique identifier (UUID)

Bodyapplication/jsonrequired
categorystring

High-level category of separation.

Enum"ownership""location""grouping""other"
childEntityIdstring

Identifier of the child entity in the separation relationship (e.g., separated animal, destination group).

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

Optional client-supplied identifier for idempotency or cross-system correlation.

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

Reference to the associated contact, if applicable.

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

Vendor- or practice-specific extensions.

isActiveboolean

Whether this separation record is currently active.

namestring

Human-readable name or label for the separation.

parentEntityIdstring

Identifier of the parent entity in the separation relationship (e.g., owner, source group).

Example: "123e4567-e89b-12d3-a456-426614174000"
separationTypeobject
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/separation/{separationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "category": "ownership",
    "childEntityId": "123e4567-e89b-12d3-a456-426614174000",
    "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "parentEntityId": "123e4567-e89b-12d3-a456-426614174000",
    "separationType": {
      "code": "string",
      "system": "string",
      "display": "string"
    }
  }'

Responses

Separation updated successfully

Bodyapplication/json
categorystringrequired

High-level category of separation.

Enum"ownership""location""grouping""other"
childEntityIdstringrequired

Identifier of the child entity in the separation relationship (e.g., separated animal, destination group).

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

Optional client-supplied identifier for idempotency or cross-system correlation.

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

Reference to the associated contact, if applicable.

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

Timestamp when this separation record was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this separation record is currently active.

namestringrequired

Human-readable name or label for the separation.

parentEntityIdstringrequired

Identifier of the parent entity in the separation relationship (e.g., owner, source group).

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

Canonical identifier for this separation relationship.

Example: "123e4567-e89b-12d3-a456-426614174000"
separationTypeobjectrequired
separationType.​codestringrequired

Code value

separationType.​systemstringrequired

Code system URI

separationType.​displaystring

Human-readable display

updatedAtstring(date-time)required

Timestamp when this separation record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "category": "ownership",
  "childEntityId": "123e4567-e89b-12d3-a456-426614174000",
  "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "parentEntityId": "123e4567-e89b-12d3-a456-426614174000",
  "separationId": "123e4567-e89b-12d3-a456-426614174000",
  "separationType": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Replace separation

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

separationIdstringrequired

Separation unique identifier (UUID)

Bodyapplication/jsonrequired
categorystringrequired

High-level category of separation.

Enum"ownership""location""grouping""other"
childEntityIdstringrequired

Identifier of the child entity in the separation relationship (e.g., separated animal, destination group).

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

Optional client-supplied identifier for idempotency or cross-system correlation.

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

Reference to the associated contact, if applicable.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this separation record is currently active.

namestringrequired

Human-readable name or label for the separation.

parentEntityIdstringrequired

Identifier of the parent entity in the separation relationship (e.g., owner, source group).

Example: "123e4567-e89b-12d3-a456-426614174000"
separationTypeobjectrequired
separationType.​codestringrequired

Code value

separationType.​systemstringrequired

Code system URI

separationType.​displaystring

Human-readable display

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/separation/{separationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "category": "ownership",
    "childEntityId": "123e4567-e89b-12d3-a456-426614174000",
    "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "parentEntityId": "123e4567-e89b-12d3-a456-426614174000",
    "separationType": {
      "code": "string",
      "system": "string",
      "display": "string"
    }
  }'

Responses

Separation replaced successfully

Bodyapplication/json
categorystringrequired

High-level category of separation.

Enum"ownership""location""grouping""other"
childEntityIdstringrequired

Identifier of the child entity in the separation relationship (e.g., separated animal, destination group).

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

Optional client-supplied identifier for idempotency or cross-system correlation.

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

Reference to the associated contact, if applicable.

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

Timestamp when this separation record was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this separation record is currently active.

namestringrequired

Human-readable name or label for the separation.

parentEntityIdstringrequired

Identifier of the parent entity in the separation relationship (e.g., owner, source group).

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

Canonical identifier for this separation relationship.

Example: "123e4567-e89b-12d3-a456-426614174000"
separationTypeobjectrequired
separationType.​codestringrequired

Code value

separationType.​systemstringrequired

Code system URI

separationType.​displaystring

Human-readable display

updatedAtstring(date-time)required

Timestamp when this separation record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "category": "ownership",
  "childEntityId": "123e4567-e89b-12d3-a456-426614174000",
  "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "parentEntityId": "123e4567-e89b-12d3-a456-426614174000",
  "separationId": "123e4567-e89b-12d3-a456-426614174000",
  "separationType": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Delete separation

Request

Permanently deletes a Separation record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

separationIdstringrequired

Separation unique identifier (UUID)

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

Responses

Separation deleted successfully

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