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

Create external hotlink

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
descriptionstring

Human-readable description or label for the hotlink.

extensionsobject

Vendor- or practice-specific extensions.

externalHotlinkIdstringrequired

Canonical identifier for this external hotlink.

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

Identifier of the resource this hotlink is associated with.

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

Type of resource this hotlink is associated with (e.g., animal, contact, invoice).

statusstring

Lifecycle status of the external hotlink.

Enum"active""inactive"
urlstringrequired

Target URL of the external hotlink.

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/external-hotlink' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "string",
    "extensions": {},
    "externalHotlinkId": "123e4567-e89b-12d3-a456-426614174000",
    "resourceId": "123e4567-e89b-12d3-a456-426614174000",
    "resourceType": "string",
    "status": "active",
    "url": "string"
  }'

Responses

External Hotlink created successfully

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when this hotlink was created.

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

Human-readable description or label for the hotlink.

extensionsobjectrequired

Vendor- or practice-specific extensions.

externalHotlinkIdstringrequired

Canonical identifier for this external hotlink.

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

Identifier of the resource this hotlink is associated with.

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

Type of resource this hotlink is associated with (e.g., animal, contact, invoice).

statusstringrequired

Lifecycle status of the external hotlink.

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

Timestamp when this hotlink was last updated.

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

Target URL of the external hotlink.

Response
application/json
{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "externalHotlinkId": "123e4567-e89b-12d3-a456-426614174000",
  "resourceId": "123e4567-e89b-12d3-a456-426614174000",
  "resourceType": "string",
  "status": "active",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "url": "string"
}

List external hotlinks

Request

Returns a paginated list of External Hotlinks 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""resourceType""url"
sortOrderstring

Sort order

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

Human-readable description or label for the hotlink.

resourceIdstring

Identifier of the resource this hotlink is associated with.

Example: resourceId=123e4567-e89b-12d3-a456-426614174000
resourceTypestring

Type of resource this hotlink is associated with (e.g., animal, contact, invoice).

statusstring

Lifecycle status of the external hotlink.

Enum"active""inactive"
urlstring

Target URL of the external hotlink.

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/external-hotlink?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&description=string&resourceId=123e4567-e89b-12d3-a456-426614174000&resourceType=string&status=active&url=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of External Hotlinks

Get external hotlink

Request

Returns a single External Hotlink by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

externalHotlinkIdstringrequired

External Hotlink unique identifier (UUID)

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

Responses

External Hotlink found

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when this hotlink was created.

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

Human-readable description or label for the hotlink.

extensionsobjectrequired

Vendor- or practice-specific extensions.

externalHotlinkIdstringrequired

Canonical identifier for this external hotlink.

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

Identifier of the resource this hotlink is associated with.

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

Type of resource this hotlink is associated with (e.g., animal, contact, invoice).

statusstringrequired

Lifecycle status of the external hotlink.

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

Timestamp when this hotlink was last updated.

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

Target URL of the external hotlink.

Response
application/json
{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "externalHotlinkId": "123e4567-e89b-12d3-a456-426614174000",
  "resourceId": "123e4567-e89b-12d3-a456-426614174000",
  "resourceType": "string",
  "status": "active",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "url": "string"
}

Update external hotlink

Request

Partially updates an existing External Hotlink. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

externalHotlinkIdstringrequired

External Hotlink unique identifier (UUID)

Bodyapplication/jsonrequired
descriptionstring

Human-readable description or label for the hotlink.

extensionsobject

Vendor- or practice-specific extensions.

resourceIdstring

Identifier of the resource this hotlink is associated with.

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

Type of resource this hotlink is associated with (e.g., animal, contact, invoice).

statusstring

Lifecycle status of the external hotlink.

Enum"active""inactive"
urlstring

Target URL of the external hotlink.

curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/external-hotlink/{externalHotlinkId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "string",
    "extensions": {},
    "resourceId": "123e4567-e89b-12d3-a456-426614174000",
    "resourceType": "string",
    "status": "active",
    "url": "string"
  }'

Responses

External Hotlink updated successfully

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when this hotlink was created.

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

Human-readable description or label for the hotlink.

extensionsobjectrequired

Vendor- or practice-specific extensions.

externalHotlinkIdstringrequired

Canonical identifier for this external hotlink.

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

Identifier of the resource this hotlink is associated with.

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

Type of resource this hotlink is associated with (e.g., animal, contact, invoice).

statusstringrequired

Lifecycle status of the external hotlink.

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

Timestamp when this hotlink was last updated.

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

Target URL of the external hotlink.

Response
application/json
{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "externalHotlinkId": "123e4567-e89b-12d3-a456-426614174000",
  "resourceId": "123e4567-e89b-12d3-a456-426614174000",
  "resourceType": "string",
  "status": "active",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "url": "string"
}

Replace external hotlink

Request

Fully replaces an existing External Hotlink. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

externalHotlinkIdstringrequired

External Hotlink unique identifier (UUID)

Bodyapplication/jsonrequired
descriptionstringrequired

Human-readable description or label for the hotlink.

extensionsobjectrequired

Vendor- or practice-specific extensions.

resourceIdstringrequired

Identifier of the resource this hotlink is associated with.

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

Type of resource this hotlink is associated with (e.g., animal, contact, invoice).

statusstringrequired

Lifecycle status of the external hotlink.

Enum"active""inactive"
urlstringrequired

Target URL of the external hotlink.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/external-hotlink/{externalHotlinkId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "string",
    "extensions": {},
    "resourceId": "123e4567-e89b-12d3-a456-426614174000",
    "resourceType": "string",
    "status": "active",
    "url": "string"
  }'

Responses

External Hotlink replaced successfully

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when this hotlink was created.

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

Human-readable description or label for the hotlink.

extensionsobjectrequired

Vendor- or practice-specific extensions.

externalHotlinkIdstringrequired

Canonical identifier for this external hotlink.

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

Identifier of the resource this hotlink is associated with.

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

Type of resource this hotlink is associated with (e.g., animal, contact, invoice).

statusstringrequired

Lifecycle status of the external hotlink.

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

Timestamp when this hotlink was last updated.

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

Target URL of the external hotlink.

Response
application/json
{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "externalHotlinkId": "123e4567-e89b-12d3-a456-426614174000",
  "resourceId": "123e4567-e89b-12d3-a456-426614174000",
  "resourceType": "string",
  "status": "active",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "url": "string"
}

Delete external hotlink

Request

Permanently deletes a External Hotlink record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

externalHotlinkIdstringrequired

External Hotlink unique identifier (UUID)

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

Responses

External Hotlink deleted successfully

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