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

Create contact detail

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
contactDetailIdstringrequired

Canonical identifier for this contact detail.

Example: "123e4567-e89b-12d3-a456-426614174000"
contactDetailTypeobjectrequired
contactDetailType.​codestringrequired

Code value

contactDetailType.​systemstringrequired

Code system URI

contactDetailType.​displaystring

Human-readable display

contactIdstringrequired

Identifier of the contact this detail belongs to.

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

Vendor- or practice-specific extensions.

isActiveboolean

Whether this contact detail is currently active.

isPreferredboolean

Whether this is the preferred contact detail of its type for the contact.

namestringrequired

Label or type name for the contact detail (e.g. 'Home phone', 'Email').

subscriptionGroupsArray of strings

Identifiers of communication subscription groups associated with this contact detail.

valuestringrequired

Raw value of the contact detail (e.g. phone number, email address).

valueCleanedstring or null

System-normalized representation of the value, if available.

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/contact-detail' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contactDetailId": "123e4567-e89b-12d3-a456-426614174000",
    "contactDetailType": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "isPreferred": true,
    "name": "string",
    "subscriptionGroups": [
      "string"
    ],
    "value": "string",
    "valueCleaned": "string"
  }'

Responses

Contact Detail created successfully

Bodyapplication/json
contactDetailIdstringrequired

Canonical identifier for this contact detail.

Example: "123e4567-e89b-12d3-a456-426614174000"
contactDetailTypeobjectrequired
contactDetailType.​codestringrequired

Code value

contactDetailType.​systemstringrequired

Code system URI

contactDetailType.​displaystring

Human-readable display

contactIdstringrequired

Identifier of the contact this detail belongs to.

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

Timestamp when this contact detail was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this contact detail is currently active.

isPreferredbooleanrequired

Whether this is the preferred contact detail of its type for the contact.

namestringrequired

Label or type name for the contact detail (e.g. 'Home phone', 'Email').

subscriptionGroupsArray of stringsrequired

Identifiers of communication subscription groups associated with this contact detail.

updatedAtstring(date-time)required

Timestamp when this contact detail was last updated.

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

Raw value of the contact detail (e.g. phone number, email address).

valueCleanedstring or nullrequired

System-normalized representation of the value, if available.

Response
application/json
{
  "contactDetailId": "123e4567-e89b-12d3-a456-426614174000",
  "contactDetailType": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "isPreferred": true,
  "name": "string",
  "subscriptionGroups": [
    "string"
  ],
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "value": "string",
  "valueCleaned": "string"
}

List contact details

Request

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

Sort order

Default "asc"
Enum"asc""desc"
contactIdstring

Identifier of the contact this detail belongs to.

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

Whether this contact detail is currently active.

isPreferredboolean

Whether this is the preferred contact detail of its type for the contact.

namestring

Label or type name for the contact detail (e.g. 'Home phone', 'Email').

valuestring

Raw value of the contact detail (e.g. phone number, email address).

valueCleanedstring

System-normalized representation of the value, if available.

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

Responses

Paginated list of Contact Details

Get contact detail

Request

Returns a single Contact Detail by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

contactDetailIdstringrequired

Contact Detail unique identifier (UUID)

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

Responses

Contact Detail found

Bodyapplication/json
contactDetailIdstringrequired

Canonical identifier for this contact detail.

Example: "123e4567-e89b-12d3-a456-426614174000"
contactDetailTypeobjectrequired
contactDetailType.​codestringrequired

Code value

contactDetailType.​systemstringrequired

Code system URI

contactDetailType.​displaystring

Human-readable display

contactIdstringrequired

Identifier of the contact this detail belongs to.

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

Timestamp when this contact detail was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this contact detail is currently active.

isPreferredbooleanrequired

Whether this is the preferred contact detail of its type for the contact.

namestringrequired

Label or type name for the contact detail (e.g. 'Home phone', 'Email').

subscriptionGroupsArray of stringsrequired

Identifiers of communication subscription groups associated with this contact detail.

updatedAtstring(date-time)required

Timestamp when this contact detail was last updated.

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

Raw value of the contact detail (e.g. phone number, email address).

valueCleanedstring or nullrequired

System-normalized representation of the value, if available.

Response
application/json
{
  "contactDetailId": "123e4567-e89b-12d3-a456-426614174000",
  "contactDetailType": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "isPreferred": true,
  "name": "string",
  "subscriptionGroups": [
    "string"
  ],
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "value": "string",
  "valueCleaned": "string"
}

Update contact detail

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

contactDetailIdstringrequired

Contact Detail unique identifier (UUID)

Bodyapplication/jsonrequired
contactDetailTypeobject
contactIdstring

Identifier of the contact this detail belongs to.

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

Vendor- or practice-specific extensions.

isActiveboolean

Whether this contact detail is currently active.

isPreferredboolean

Whether this is the preferred contact detail of its type for the contact.

namestring

Label or type name for the contact detail (e.g. 'Home phone', 'Email').

subscriptionGroupsArray of strings

Identifiers of communication subscription groups associated with this contact detail.

valuestring

Raw value of the contact detail (e.g. phone number, email address).

valueCleanedstring or null

System-normalized representation of the value, if available.

curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/contact-detail/{contactDetailId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contactDetailType": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "isPreferred": true,
    "name": "string",
    "subscriptionGroups": [
      "string"
    ],
    "value": "string",
    "valueCleaned": "string"
  }'

Responses

Contact Detail updated successfully

Bodyapplication/json
contactDetailIdstringrequired

Canonical identifier for this contact detail.

Example: "123e4567-e89b-12d3-a456-426614174000"
contactDetailTypeobjectrequired
contactDetailType.​codestringrequired

Code value

contactDetailType.​systemstringrequired

Code system URI

contactDetailType.​displaystring

Human-readable display

contactIdstringrequired

Identifier of the contact this detail belongs to.

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

Timestamp when this contact detail was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this contact detail is currently active.

isPreferredbooleanrequired

Whether this is the preferred contact detail of its type for the contact.

namestringrequired

Label or type name for the contact detail (e.g. 'Home phone', 'Email').

subscriptionGroupsArray of stringsrequired

Identifiers of communication subscription groups associated with this contact detail.

updatedAtstring(date-time)required

Timestamp when this contact detail was last updated.

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

Raw value of the contact detail (e.g. phone number, email address).

valueCleanedstring or nullrequired

System-normalized representation of the value, if available.

Response
application/json
{
  "contactDetailId": "123e4567-e89b-12d3-a456-426614174000",
  "contactDetailType": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "isPreferred": true,
  "name": "string",
  "subscriptionGroups": [
    "string"
  ],
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "value": "string",
  "valueCleaned": "string"
}

Replace contact detail

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

contactDetailIdstringrequired

Contact Detail unique identifier (UUID)

Bodyapplication/jsonrequired
contactDetailTypeobjectrequired
contactDetailType.​codestringrequired

Code value

contactDetailType.​systemstringrequired

Code system URI

contactDetailType.​displaystring

Human-readable display

contactIdstringrequired

Identifier of the contact this detail belongs to.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this contact detail is currently active.

isPreferredbooleanrequired

Whether this is the preferred contact detail of its type for the contact.

namestringrequired

Label or type name for the contact detail (e.g. 'Home phone', 'Email').

subscriptionGroupsArray of stringsrequired

Identifiers of communication subscription groups associated with this contact detail.

valuestringrequired

Raw value of the contact detail (e.g. phone number, email address).

valueCleanedstring or null

System-normalized representation of the value, if available.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/contact-detail/{contactDetailId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contactDetailType": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "isPreferred": true,
    "name": "string",
    "subscriptionGroups": [
      "string"
    ],
    "value": "string",
    "valueCleaned": "string"
  }'

Responses

Contact Detail replaced successfully

Bodyapplication/json
contactDetailIdstringrequired

Canonical identifier for this contact detail.

Example: "123e4567-e89b-12d3-a456-426614174000"
contactDetailTypeobjectrequired
contactDetailType.​codestringrequired

Code value

contactDetailType.​systemstringrequired

Code system URI

contactDetailType.​displaystring

Human-readable display

contactIdstringrequired

Identifier of the contact this detail belongs to.

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

Timestamp when this contact detail was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this contact detail is currently active.

isPreferredbooleanrequired

Whether this is the preferred contact detail of its type for the contact.

namestringrequired

Label or type name for the contact detail (e.g. 'Home phone', 'Email').

subscriptionGroupsArray of stringsrequired

Identifiers of communication subscription groups associated with this contact detail.

updatedAtstring(date-time)required

Timestamp when this contact detail was last updated.

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

Raw value of the contact detail (e.g. phone number, email address).

valueCleanedstring or nullrequired

System-normalized representation of the value, if available.

Response
application/json
{
  "contactDetailId": "123e4567-e89b-12d3-a456-426614174000",
  "contactDetailType": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "isPreferred": true,
  "name": "string",
  "subscriptionGroups": [
    "string"
  ],
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "value": "string",
  "valueCleaned": "string"
}

Delete contact detail

Request

Permanently deletes a Contact Detail record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

contactDetailIdstringrequired

Contact Detail unique identifier (UUID)

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

Responses

Contact Detail deleted successfully

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