Animal Health Data Store - V1 API Documentation
AHDS Store API (1.0)
Overview
Languages
Servers
Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/
Local Development
http://localhost:8083/
Bodyapplication/jsonrequired
Reference to the animal associated with this booking.
Example: "123e4567-e89b-12d3-a456-426614174000"
Optional reference to a related consult/visit.
Example: "123e4567-e89b-12d3-a456-426614174000"
Reference to the primary contact associated with this booking (e.g., adopter, foster, organization).
Example: "123e4567-e89b-12d3-a456-426614174000"
Reference to the shelter resource (e.g., kennel, run, room) being booked.
Example: "123e4567-e89b-12d3-a456-426614174000"
Human-readable name of the shelter resource at the time of booking.
Reference to the ownership record of the shelter resource, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Reference to the shelter place/location associated with this booking.
Example: "123e4567-e89b-12d3-a456-426614174000"
Current status of the shelter animal booking.
Enum"planned""in-progress""completed""cancelled""no-show""on-hold""unknown"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/shelter-animal-booking/{shelterAnimalBookingId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/shelter-animal-booking/{shelterAnimalBookingId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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": "string",
"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": "string",
"shelterResourceOwnershipId": "123e4567-e89b-12d3-a456-426614174000",
"shelterResourcePlaceId": "123e4567-e89b-12d3-a456-426614174000",
"startAt": "2025-01-01T00:00:00.000Z",
"status": "planned",
"bookingType": {
"code": "string",
"system": "string",
"display": "string"
}
}'Shelter Animal Booking replaced successfully
Reference to the animal associated with this booking.
Example: "123e4567-e89b-12d3-a456-426614174000"
Optional reference to a related consult/visit.
Example: "123e4567-e89b-12d3-a456-426614174000"
Reference to the primary contact associated with this booking (e.g., adopter, foster, organization).
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the booking record was created.
Example: "2025-01-01T00:00:00.000Z"
Canonical identifier for this shelter animal booking.
Example: "123e4567-e89b-12d3-a456-426614174000"
Reference to the shelter resource (e.g., kennel, run, room) being booked.
Example: "123e4567-e89b-12d3-a456-426614174000"
Human-readable name of the shelter resource at the time of booking.
Reference to the ownership record of the shelter resource, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Reference to the shelter place/location associated with this booking.
Example: "123e4567-e89b-12d3-a456-426614174000"
Start date and time of the booking.
Example: "2025-01-01T00:00:00.000Z"
Current status of the shelter animal booking.
Enum"planned""in-progress""completed""cancelled""no-show""on-hold""unknown"
Timestamp when the booking record was last modified.
Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "comment": "string", "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": "string", "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": "string", "system": "string", "display": "string" } }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/shelter-animal-booking/{shelterAnimalBookingId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/shelter-animal-booking/{shelterAnimalBookingId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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>'