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/

Animal

Operations

Animal Colour

Operations

Breed

Operations

Update breed

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

breedIdstringrequired

Breed unique identifier (UUID)

Bodyapplication/jsonrequired
extensionsobject

Vendor- or practice-specific extensions. Keys SHOULD be namespaced (e.g., vendorName.extensionName) to avoid collisions. Values SHOULD be primitive JSON types or small nested objects that do not duplicate core AHDS fields.

isActiveboolean

Whether this breed is currently active and can be selected for new records in the system. Inactive breeds should remain for historical/reference purposes but should not be used for new assignments.

Example: true
namestring

Human-readable name of the breed.

Example: "Example Name"
speciesIdstring

Reference to the species this breed belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
codeobject
breedCodeobject
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/breed/{breedId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "extensions": {},
    "isActive": true,
    "name": "Example Name",
    "speciesId": "123e4567-e89b-12d3-a456-426614174000",
    "code": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    },
    "breedCode": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    }
  }'

Responses

Breed updated successfully

Bodyapplication/json
breedIdstringrequired

Canonical unique identifier for the breed.

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

Timestamp when the breed record was created.

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

Vendor- or practice-specific extensions. Keys SHOULD be namespaced (e.g., vendorName.extensionName) to avoid collisions. Values SHOULD be primitive JSON types or small nested objects that do not duplicate core AHDS fields.

isActivebooleanrequired

Whether this breed is currently active and can be selected for new records in the system. Inactive breeds should remain for historical/reference purposes but should not be used for new assignments.

Example: true
namestringrequired

Human-readable name of the breed.

Example: "Example Name"
speciesIdstringrequired

Reference to the species this breed belongs to.

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

Timestamp when the breed record was last updated.

Example: "2025-01-01T00:00:00.000Z"
codeobjectrequired
code.​codestringrequired

Code value

Example: "12345"
code.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
code.​displaystring

Human-readable display

Example: "Example Display Name"
breedCodeobjectrequired
breedCode.​codestringrequired

Code value

Example: "12345"
breedCode.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
breedCode.​displaystring

Human-readable display

Example: "Example Display Name"
Response
application/json
{
  "breedId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "name": "Example Name",
  "speciesId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "code": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  },
  "breedCode": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  }
}

Replace breed

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

breedIdstringrequired

Breed unique identifier (UUID)

Bodyapplication/jsonrequired
extensionsobjectrequired

Vendor- or practice-specific extensions. Keys SHOULD be namespaced (e.g., vendorName.extensionName) to avoid collisions. Values SHOULD be primitive JSON types or small nested objects that do not duplicate core AHDS fields.

isActivebooleanrequired

Whether this breed is currently active and can be selected for new records in the system. Inactive breeds should remain for historical/reference purposes but should not be used for new assignments.

Example: true
namestringrequired

Human-readable name of the breed.

Example: "Example Name"
speciesIdstringrequired

Reference to the species this breed belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
codeobjectrequired
code.​codestringrequired

Code value

Example: "12345"
code.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
code.​displaystring

Human-readable display

Example: "Example Display Name"
breedCodeobjectrequired
breedCode.​codestringrequired

Code value

Example: "12345"
breedCode.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
breedCode.​displaystring

Human-readable display

Example: "Example Display Name"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/breed/{breedId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "extensions": {},
    "isActive": true,
    "name": "Example Name",
    "speciesId": "123e4567-e89b-12d3-a456-426614174000",
    "code": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    },
    "breedCode": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    }
  }'

Responses

Breed replaced successfully

Bodyapplication/json
breedIdstringrequired

Canonical unique identifier for the breed.

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

Timestamp when the breed record was created.

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

Vendor- or practice-specific extensions. Keys SHOULD be namespaced (e.g., vendorName.extensionName) to avoid collisions. Values SHOULD be primitive JSON types or small nested objects that do not duplicate core AHDS fields.

isActivebooleanrequired

Whether this breed is currently active and can be selected for new records in the system. Inactive breeds should remain for historical/reference purposes but should not be used for new assignments.

Example: true
namestringrequired

Human-readable name of the breed.

Example: "Example Name"
speciesIdstringrequired

Reference to the species this breed belongs to.

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

Timestamp when the breed record was last updated.

Example: "2025-01-01T00:00:00.000Z"
codeobjectrequired
code.​codestringrequired

Code value

Example: "12345"
code.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
code.​displaystring

Human-readable display

Example: "Example Display Name"
breedCodeobjectrequired
breedCode.​codestringrequired

Code value

Example: "12345"
breedCode.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
breedCode.​displaystring

Human-readable display

Example: "Example Display Name"
Response
application/json
{
  "breedId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "name": "Example Name",
  "speciesId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "code": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  },
  "breedCode": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  }
}

Delete breed

Request

Permanently deletes a Breed record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

breedIdstringrequired

Breed unique identifier (UUID)

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

Responses

Breed deleted successfully

Health Status

Operations

Herd

Operations

Sex

Operations

Shelter Animal Booking

Operations

Species

Operations

Assessment

Operations

Consult

Operations

History

Operations

Physical Exam

Operations

Presentingproblem

Operations

Standardofcare

Operations

Therapeutic

Operations

Vaccination

Operations

Diagnostic

Operations

Diagnostic Code

Operations

Diagnostic Request

Operations

Diagnostic Result

Operations

Diagnostic Result Item

Operations

Integrated Diagnostic

Operations

Modality

Operations

Standard Diagnostic Lab Report

Operations

External Prescription

Operations

Prescription

Operations

Prescription Item

Operations

Appointment

Operations

Appointment Status

Operations

Appointment Type

Operations

Availability

Operations

Availability Slot

Operations

Booking

Operations

Billing Credit

Operations

Billing Line

Operations

Estimate

Operations

Insurance

Operations

Invoice

Operations

Invoiceline

Operations

Ledger Account

Operations

Linked Payment

Operations

Payment

Operations

Paymentmethod

Operations

Plan

Operations

Price Adjustment

Operations

Receive Invoice

Operations

Taxrate

Operations

Barcode

Operations

Batch

Operations

Inventory Message

Operations

Inventory Product

Operations

Inventory Requirement

Operations

Inventory Supplied Product

Operations

Product

Operations

Product Minimum Stock

Operations

Product Pricing

Operations

Product Supplier

Operations

Productgroup

Operations

Purchaseorder

Operations

Purchaseorderitem

Operations

Receive Invoice Item

Operations

Stock Adjustment

Operations

Stock Adjustment Item

Operations

Stock Transaction

Operations

Supplied

Operations

With Primary Inventory Location

Operations

Address

Operations

Contact

Operations

Contact Association

Operations

Contact Detail

Operations

Communication

Operations

Message

Operations

Template

Operations

User

Operations

Webhook

Operations

Webhook Event

Operations

Attachment

Operations

Country

Operations

Facility

Operations

File

Operations

File Upload

Operations

Location

Operations

Practitioner

Operations

Wellness Resource

Operations

Eventgroup

Operations

Operation

Operations

Requisition Form

Operations

Resource

Operations

Separation

Operations

Site Information

Operations

System Setting

Operations

Tag

Operations

Tagcategory

Operations

Tagname

Operations

Transaction

Operations