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

Health Status

Operations

Herd

Operations

Sex

Operations

Shelter Animal Booking

Operations

Update shelter animal booking

Request

Partially updates an existing Shelter Animal Booking. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

shelterAnimalBookingIdstringrequired

Shelter Animal Booking unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstring

Reference to the animal associated with this booking.

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

Free-text notes about the booking.

Example: "Example description"
consultIdstring or null

Optional reference to a related consult/visit.

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

Reference to the primary contact associated with this booking (e.g., adopter, foster, organization).

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

End date and time of the booking.

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

Vendor- or practice-specific extensions.

isActiveboolean

Whether this booking is currently active.

Example: true
shelterResourceIdstring

Reference to the shelter resource (e.g., kennel, run, room) being booked.

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

Human-readable name of the shelter resource at the time of booking.

Example: "Example Name"
shelterResourceOwnershipIdstring

Reference to the ownership record of the shelter resource, if applicable.

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

Reference to the shelter place/location associated with this booking.

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

Start date and time of the booking.

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

Current status of the shelter animal booking.

Enum"planned""in-progress""completed""cancelled""no-show""on-hold""unknown"
Example: "planned"
bookingTypeobject
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/shelter-animal-booking/{shelterAnimalBookingId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "comment": "Example description",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "endAt": "2025-01-01T00:00:00.000Z",
    "extensions": {},
    "isActive": true,
    "shelterResourceId": "123e4567-e89b-12d3-a456-426614174000",
    "shelterResourceName": "Example Name",
    "shelterResourceOwnershipId": "123e4567-e89b-12d3-a456-426614174000",
    "shelterResourcePlaceId": "123e4567-e89b-12d3-a456-426614174000",
    "startAt": "2025-01-01T00:00:00.000Z",
    "status": "planned",
    "bookingType": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    }
  }'

Responses

Shelter Animal Booking updated successfully

Bodyapplication/json
animalIdstringrequired

Reference to the animal associated with this booking.

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

Free-text notes about the booking.

Example: "Example description"
consultIdstring or nullrequired

Optional reference to a related consult/visit.

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

Reference to the primary contact associated with this booking (e.g., adopter, foster, organization).

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

Timestamp when the booking record was created.

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

End date and time of the booking.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this booking is currently active.

Example: true
shelterAnimalBookingIdstringrequired

Canonical identifier for this shelter animal booking.

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

Reference to the shelter resource (e.g., kennel, run, room) being booked.

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

Human-readable name of the shelter resource at the time of booking.

Example: "Example Name"
shelterResourceOwnershipIdstringrequired

Reference to the ownership record of the shelter resource, if applicable.

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

Reference to the shelter place/location associated with this booking.

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

Start date and time of the booking.

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

Current status of the shelter animal booking.

Enum"planned""in-progress""completed""cancelled""no-show""on-hold""unknown"
Example: "planned"
updatedAtstring(date-time)required

Timestamp when the booking record was last modified.

Example: "2025-01-01T00:00:00.000Z"
bookingTypeobjectrequired
bookingType.​codestringrequired

Code value

Example: "12345"
bookingType.​systemstringrequired

Code system URI

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

Human-readable display

Example: "Example Display Name"
Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "comment": "Example description",
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "endAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "shelterAnimalBookingId": "123e4567-e89b-12d3-a456-426614174000",
  "shelterResourceId": "123e4567-e89b-12d3-a456-426614174000",
  "shelterResourceName": "Example Name",
  "shelterResourceOwnershipId": "123e4567-e89b-12d3-a456-426614174000",
  "shelterResourcePlaceId": "123e4567-e89b-12d3-a456-426614174000",
  "startAt": "2025-01-01T00:00:00.000Z",
  "status": "planned",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "bookingType": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  }
}

Replace shelter animal booking

Request

Fully replaces an existing Shelter Animal Booking. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

shelterAnimalBookingIdstringrequired

Shelter Animal Booking unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstringrequired

Reference to the animal associated with this booking.

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

Free-text notes about the booking.

Example: "Example description"
consultIdstring or null

Optional reference to a related consult/visit.

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

Reference to the primary contact associated with this booking (e.g., adopter, foster, organization).

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

End date and time of the booking.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this booking is currently active.

Example: true
shelterResourceIdstringrequired

Reference to the shelter resource (e.g., kennel, run, room) being booked.

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

Human-readable name of the shelter resource at the time of booking.

Example: "Example Name"
shelterResourceOwnershipIdstringrequired

Reference to the ownership record of the shelter resource, if applicable.

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

Reference to the shelter place/location associated with this booking.

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

Start date and time of the booking.

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

Current status of the shelter animal booking.

Enum"planned""in-progress""completed""cancelled""no-show""on-hold""unknown"
Example: "planned"
bookingTypeobjectrequired
bookingType.​codestringrequired

Code value

Example: "12345"
bookingType.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
bookingType.​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/shelter-animal-booking/{shelterAnimalBookingId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "comment": "Example description",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "endAt": "2025-01-01T00:00:00.000Z",
    "extensions": {},
    "isActive": true,
    "shelterResourceId": "123e4567-e89b-12d3-a456-426614174000",
    "shelterResourceName": "Example Name",
    "shelterResourceOwnershipId": "123e4567-e89b-12d3-a456-426614174000",
    "shelterResourcePlaceId": "123e4567-e89b-12d3-a456-426614174000",
    "startAt": "2025-01-01T00:00:00.000Z",
    "status": "planned",
    "bookingType": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    }
  }'

Responses

Shelter Animal Booking replaced successfully

Bodyapplication/json
animalIdstringrequired

Reference to the animal associated with this booking.

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

Free-text notes about the booking.

Example: "Example description"
consultIdstring or nullrequired

Optional reference to a related consult/visit.

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

Reference to the primary contact associated with this booking (e.g., adopter, foster, organization).

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

Timestamp when the booking record was created.

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

End date and time of the booking.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this booking is currently active.

Example: true
shelterAnimalBookingIdstringrequired

Canonical identifier for this shelter animal booking.

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

Reference to the shelter resource (e.g., kennel, run, room) being booked.

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

Human-readable name of the shelter resource at the time of booking.

Example: "Example Name"
shelterResourceOwnershipIdstringrequired

Reference to the ownership record of the shelter resource, if applicable.

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

Reference to the shelter place/location associated with this booking.

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

Start date and time of the booking.

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

Current status of the shelter animal booking.

Enum"planned""in-progress""completed""cancelled""no-show""on-hold""unknown"
Example: "planned"
updatedAtstring(date-time)required

Timestamp when the booking record was last modified.

Example: "2025-01-01T00:00:00.000Z"
bookingTypeobjectrequired
bookingType.​codestringrequired

Code value

Example: "12345"
bookingType.​systemstringrequired

Code system URI

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

Human-readable display

Example: "Example Display Name"
Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "comment": "Example description",
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "endAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "shelterAnimalBookingId": "123e4567-e89b-12d3-a456-426614174000",
  "shelterResourceId": "123e4567-e89b-12d3-a456-426614174000",
  "shelterResourceName": "Example Name",
  "shelterResourceOwnershipId": "123e4567-e89b-12d3-a456-426614174000",
  "shelterResourcePlaceId": "123e4567-e89b-12d3-a456-426614174000",
  "startAt": "2025-01-01T00:00:00.000Z",
  "status": "planned",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "bookingType": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  }
}

Delete shelter animal booking

Request

Permanently deletes a Shelter Animal Booking record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

shelterAnimalBookingIdstringrequired

Shelter Animal Booking unique identifier (UUID)

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

Responses

Shelter Animal Booking deleted successfully

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