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/
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/availability-slot
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/availability-slot
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/availability-slot?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&isActive=true&isBooked=true&locationId=123e4567-e89b-12d3-a456-426614174000¬es=string&resourceId=123e4567-e89b-12d3-a456-426614174000' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/availability-slot/{availabilitySlotId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/availability-slot/{availabilitySlotId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/availability-slot/{availabilitySlotId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Availability Slot found
Canonical identifier for this availability slot.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when this slot record was created.
Example: "2025-01-01T00:00:00.000Z"
End date and time of the availability slot (RFC 3339, with timezone).
Example: "2025-01-01T00:00:00.000Z"
Indicates whether this slot is active and can be used for scheduling.
Example: true
Location (clinic/branch) where this slot occurs.
Example: "123e4567-e89b-12d3-a456-426614174000"
Primary resource for this slot (e.g., veterinarian, room).
Example: "123e4567-e89b-12d3-a456-426614174000"
Start date and time of the availability slot (RFC 3339, with timezone).
Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "availabilitySlotId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "endAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "isBooked": true, "locationId": "123e4567-e89b-12d3-a456-426614174000", "notes": "Example description", "resourceId": "123e4567-e89b-12d3-a456-426614174000", "serviceType": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "startAt": "2025-01-01T00:00:00.000Z", "updatedAt": "2025-01-01T00:00:00.000Z" }
Bodyapplication/jsonrequired
End date and time of the availability slot (RFC 3339, with timezone).
Example: "2025-01-01T00:00:00.000Z"
Location (clinic/branch) where this slot occurs.
Example: "123e4567-e89b-12d3-a456-426614174000"
Primary resource for this slot (e.g., veterinarian, room).
Example: "123e4567-e89b-12d3-a456-426614174000"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/availability-slot/{availabilitySlotId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/availability-slot/{availabilitySlotId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/availability-slot/{availabilitySlotId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"endAt": "2025-01-01T00:00:00.000Z",
"extensions": {},
"isActive": true,
"isBooked": true,
"locationId": "123e4567-e89b-12d3-a456-426614174000",
"notes": "Example description",
"resourceId": "123e4567-e89b-12d3-a456-426614174000",
"serviceType": {
"code": "12345",
"system": "http://example.com/codesystem",
"display": "Example Display Name"
},
"startAt": "2025-01-01T00:00:00.000Z"
}'Availability Slot updated successfully
Canonical identifier for this availability slot.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when this slot record was created.
Example: "2025-01-01T00:00:00.000Z"
End date and time of the availability slot (RFC 3339, with timezone).
Example: "2025-01-01T00:00:00.000Z"
Indicates whether this slot is active and can be used for scheduling.
Example: true
Location (clinic/branch) where this slot occurs.
Example: "123e4567-e89b-12d3-a456-426614174000"
Primary resource for this slot (e.g., veterinarian, room).
Example: "123e4567-e89b-12d3-a456-426614174000"
Start date and time of the availability slot (RFC 3339, with timezone).
Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "availabilitySlotId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "endAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "isBooked": true, "locationId": "123e4567-e89b-12d3-a456-426614174000", "notes": "Example description", "resourceId": "123e4567-e89b-12d3-a456-426614174000", "serviceType": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "startAt": "2025-01-01T00:00:00.000Z", "updatedAt": "2025-01-01T00:00:00.000Z" }