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

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

Create wellness resource

Request

Creates a new Wellness Resource record. Canonical read model for a wellness resource (e.g., wellness plan, program, or package) within the Animal Health Data Standard.

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
descriptionstring

Detailed description of the wellness resource.

extensionsobject

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether the wellness resource is currently active and available for use.

namestringrequired

Human-readable name of the wellness resource.

resourceIdstringrequired

Stable, opaque identifier for the wellness resource.

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

High-level classification of the wellness resource.

Enum"wellnessPlan""wellnessProgram""wellnessPackage""preventiveCareBundle""other"
statusstringrequired

Lifecycle status of the wellness resource.

Enum"draft""active""inactive""retired"
validFromDatestring

Date from which the wellness resource is valid.

Example: "2025-01-01"
validToDatestring

Date until which the wellness resource is valid, if applicable.

Example: "2025-01-01"
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/wellness-resource' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "string",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "resourceId": "123e4567-e89b-12d3-a456-426614174000",
    "resourceType": "wellnessPlan",
    "status": "draft",
    "validFromDate": "2025-01-01",
    "validToDate": "2025-01-01"
  }'

Responses

Wellness Resource created successfully

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when the wellness resource was created.

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

Detailed description of the wellness resource.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether the wellness resource is currently active and available for use.

namestringrequired

Human-readable name of the wellness resource.

resourceIdstringrequired

Stable, opaque identifier for the wellness resource.

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

High-level classification of the wellness resource.

Enum"wellnessPlan""wellnessProgram""wellnessPackage""preventiveCareBundle""other"
statusstringrequired

Lifecycle status of the wellness resource.

Enum"draft""active""inactive""retired"
updatedAtstring(date-time)required

Timestamp when the wellness resource was last updated.

Example: "2025-01-01T00:00:00.000Z"
validFromDatestring(date-time)required

Date from which the wellness resource is valid.

Example: "2025-01-01T00:00:00Z"
validToDatestring(date-time)required

Date until which the wellness resource is valid, if applicable.

Example: "2025-01-01T00:00:00Z"
Response
application/json
{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "resourceId": "123e4567-e89b-12d3-a456-426614174000",
  "resourceType": "wellnessPlan",
  "status": "draft",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "validFromDate": "2025-01-01T00:00:00Z",
  "validToDate": "2025-01-01T00:00:00Z"
}

List wellness resources

Request

Returns a paginated list of Wellness Resources 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""description""name""validFromDate""validToDate"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
descriptionstring

Detailed description of the wellness resource.

isActiveboolean

Indicates whether the wellness resource is currently active and available for use.

namestring

Human-readable name of the wellness resource.

resourceTypestring

High-level classification of the wellness resource.

Enum"wellnessPlan""wellnessProgram""wellnessPackage""preventiveCareBundle""other"
statusstring

Lifecycle status of the wellness resource.

Enum"draft""active""inactive""retired"
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/wellness-resource?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&description=string&isActive=true&name=string&resourceType=wellnessPlan&status=draft' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Wellness Resources

Get wellness resource

Request

Returns a single Wellness Resource by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

resourceIdstringrequired

Wellness Resource unique identifier (UUID)

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

Responses

Wellness Resource found

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when the wellness resource was created.

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

Detailed description of the wellness resource.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether the wellness resource is currently active and available for use.

namestringrequired

Human-readable name of the wellness resource.

resourceIdstringrequired

Stable, opaque identifier for the wellness resource.

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

High-level classification of the wellness resource.

Enum"wellnessPlan""wellnessProgram""wellnessPackage""preventiveCareBundle""other"
statusstringrequired

Lifecycle status of the wellness resource.

Enum"draft""active""inactive""retired"
updatedAtstring(date-time)required

Timestamp when the wellness resource was last updated.

Example: "2025-01-01T00:00:00.000Z"
validFromDatestring(date-time)required

Date from which the wellness resource is valid.

Example: "2025-01-01T00:00:00Z"
validToDatestring(date-time)required

Date until which the wellness resource is valid, if applicable.

Example: "2025-01-01T00:00:00Z"
Response
application/json
{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "resourceId": "123e4567-e89b-12d3-a456-426614174000",
  "resourceType": "wellnessPlan",
  "status": "draft",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "validFromDate": "2025-01-01T00:00:00Z",
  "validToDate": "2025-01-01T00:00:00Z"
}

Update wellness resource

Request

Partially updates an existing Wellness Resource. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

resourceIdstringrequired

Wellness Resource unique identifier (UUID)

Bodyapplication/jsonrequired
descriptionstring

Detailed description of the wellness resource.

extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Indicates whether the wellness resource is currently active and available for use.

namestring

Human-readable name of the wellness resource.

resourceTypestring

High-level classification of the wellness resource.

Enum"wellnessPlan""wellnessProgram""wellnessPackage""preventiveCareBundle""other"
statusstring

Lifecycle status of the wellness resource.

Enum"draft""active""inactive""retired"
validFromDatestring

Date from which the wellness resource is valid.

Example: "2025-01-01"
validToDatestring

Date until which the wellness resource is valid, if applicable.

Example: "2025-01-01"
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/wellness-resource/{resourceId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "string",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "resourceType": "wellnessPlan",
    "status": "draft",
    "validFromDate": "2025-01-01",
    "validToDate": "2025-01-01"
  }'

Responses

Wellness Resource updated successfully

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when the wellness resource was created.

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

Detailed description of the wellness resource.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether the wellness resource is currently active and available for use.

namestringrequired

Human-readable name of the wellness resource.

resourceIdstringrequired

Stable, opaque identifier for the wellness resource.

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

High-level classification of the wellness resource.

Enum"wellnessPlan""wellnessProgram""wellnessPackage""preventiveCareBundle""other"
statusstringrequired

Lifecycle status of the wellness resource.

Enum"draft""active""inactive""retired"
updatedAtstring(date-time)required

Timestamp when the wellness resource was last updated.

Example: "2025-01-01T00:00:00.000Z"
validFromDatestring(date-time)required

Date from which the wellness resource is valid.

Example: "2025-01-01T00:00:00Z"
validToDatestring(date-time)required

Date until which the wellness resource is valid, if applicable.

Example: "2025-01-01T00:00:00Z"
Response
application/json
{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "resourceId": "123e4567-e89b-12d3-a456-426614174000",
  "resourceType": "wellnessPlan",
  "status": "draft",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "validFromDate": "2025-01-01T00:00:00Z",
  "validToDate": "2025-01-01T00:00:00Z"
}

Replace wellness resource

Request

Fully replaces an existing Wellness Resource. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

resourceIdstringrequired

Wellness Resource unique identifier (UUID)

Bodyapplication/jsonrequired
descriptionstringrequired

Detailed description of the wellness resource.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether the wellness resource is currently active and available for use.

namestringrequired

Human-readable name of the wellness resource.

resourceTypestringrequired

High-level classification of the wellness resource.

Enum"wellnessPlan""wellnessProgram""wellnessPackage""preventiveCareBundle""other"
statusstringrequired

Lifecycle status of the wellness resource.

Enum"draft""active""inactive""retired"
validFromDatestringrequired

Date from which the wellness resource is valid.

Example: "2025-01-01"
validToDatestringrequired

Date until which the wellness resource is valid, if applicable.

Example: "2025-01-01"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/wellness-resource/{resourceId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "string",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "resourceType": "wellnessPlan",
    "status": "draft",
    "validFromDate": "2025-01-01",
    "validToDate": "2025-01-01"
  }'

Responses

Wellness Resource replaced successfully

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when the wellness resource was created.

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

Detailed description of the wellness resource.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether the wellness resource is currently active and available for use.

namestringrequired

Human-readable name of the wellness resource.

resourceIdstringrequired

Stable, opaque identifier for the wellness resource.

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

High-level classification of the wellness resource.

Enum"wellnessPlan""wellnessProgram""wellnessPackage""preventiveCareBundle""other"
statusstringrequired

Lifecycle status of the wellness resource.

Enum"draft""active""inactive""retired"
updatedAtstring(date-time)required

Timestamp when the wellness resource was last updated.

Example: "2025-01-01T00:00:00.000Z"
validFromDatestring(date-time)required

Date from which the wellness resource is valid.

Example: "2025-01-01T00:00:00Z"
validToDatestring(date-time)required

Date until which the wellness resource is valid, if applicable.

Example: "2025-01-01T00:00:00Z"
Response
application/json
{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "resourceId": "123e4567-e89b-12d3-a456-426614174000",
  "resourceType": "wellnessPlan",
  "status": "draft",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "validFromDate": "2025-01-01T00:00:00Z",
  "validToDate": "2025-01-01T00:00:00Z"
}

Delete wellness resource

Request

Permanently deletes a Wellness Resource record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

resourceIdstringrequired

Wellness Resource unique identifier (UUID)

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

Responses

Wellness Resource deleted successfully

With Primary Inventory Location

Operations