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/appointment-status/{appointmentStatusId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/appointment-status/{appointmentStatusId}
- 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/appointment-status/{appointmentStatusId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"extensions": {},
"isActive": true,
"name": "Example Name"
}'Appointment Status updated successfully
Canonical identifier for the appointment status.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when this appointment status was created.
Example: "2025-01-01T00:00:00.000Z"
Whether this appointment status is currently active and can be used.
Example: true
Human-readable name of the appointment status (e.g., 'Booked', 'Checked In').
Example: "Example Name"
Response
application/json
{ "appointmentStatusId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "name": "Example Name", "updatedAt": "2025-01-01T00:00:00.000Z" }
Bodyapplication/jsonrequired
Whether this appointment status is currently active and can be used.
Example: true
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/appointment-status/{appointmentStatusId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/appointment-status/{appointmentStatusId}
- 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/appointment-status/{appointmentStatusId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"extensions": {},
"isActive": true,
"name": "Example Name"
}'Appointment Status replaced successfully
Canonical identifier for the appointment status.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when this appointment status was created.
Example: "2025-01-01T00:00:00.000Z"
Whether this appointment status is currently active and can be used.
Example: true
Human-readable name of the appointment status (e.g., 'Booked', 'Checked In').
Example: "Example Name"
Response
application/json
{ "appointmentStatusId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "name": "Example Name", "updatedAt": "2025-01-01T00:00:00.000Z" }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/appointment-status/{appointmentStatusId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/appointment-status/{appointmentStatusId}
- 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/appointment-status/{appointmentStatusId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'