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/plan/{planId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/plan/{planId}
- 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/plan/{planId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Plan found
Identifier of the animal this plan is for.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the consult associated with this plan.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the plan was created.
Example: "2025-01-01T00:00:00.000Z"
Canonical identifier for the plan.
Example: "123e4567-e89b-12d3-a456-426614174000"
Clinical timestamp associated with the plan (e.g., when it was recorded in the consult).
Example: "2025-01-01T00:00:00.000Z"
Timestamp when the plan was last modified.
Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "consultId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "notes": "Example description", "planId": "123e4567-e89b-12d3-a456-426614174000", "recordedAt": "2025-01-01T00:00:00.000Z", "updatedAt": "2025-01-01T00:00:00.000Z", "vetId": "123e4567-e89b-12d3-a456-426614174000" }
Bodyapplication/jsonrequired
Identifier of the animal this plan is for.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the consult associated with this plan.
Example: "123e4567-e89b-12d3-a456-426614174000"
Clinical timestamp associated with the plan (e.g., when it was recorded in the consult).
Example: "2025-01-01T00:00:00.000Z"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/plan/{planId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/plan/{planId}
- 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/plan/{planId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"animalId": "123e4567-e89b-12d3-a456-426614174000",
"consultId": "123e4567-e89b-12d3-a456-426614174000",
"extensions": {},
"isActive": true,
"notes": "Example description",
"recordedAt": "2025-01-01T00:00:00.000Z",
"vetId": "123e4567-e89b-12d3-a456-426614174000"
}'Plan updated successfully
Identifier of the animal this plan is for.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the consult associated with this plan.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the plan was created.
Example: "2025-01-01T00:00:00.000Z"
Canonical identifier for the plan.
Example: "123e4567-e89b-12d3-a456-426614174000"
Clinical timestamp associated with the plan (e.g., when it was recorded in the consult).
Example: "2025-01-01T00:00:00.000Z"
Timestamp when the plan was last modified.
Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "consultId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "notes": "Example description", "planId": "123e4567-e89b-12d3-a456-426614174000", "recordedAt": "2025-01-01T00:00:00.000Z", "updatedAt": "2025-01-01T00:00:00.000Z", "vetId": "123e4567-e89b-12d3-a456-426614174000" }
Bodyapplication/jsonrequired
Identifier of the animal this plan is for.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the consult associated with this plan.
Example: "123e4567-e89b-12d3-a456-426614174000"
Clinical timestamp associated with the plan (e.g., when it was recorded in the consult).
Example: "2025-01-01T00:00:00.000Z"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/plan/{planId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/plan/{planId}
- 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/plan/{planId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"animalId": "123e4567-e89b-12d3-a456-426614174000",
"consultId": "123e4567-e89b-12d3-a456-426614174000",
"extensions": {},
"isActive": true,
"notes": "Example description",
"recordedAt": "2025-01-01T00:00:00.000Z",
"vetId": "123e4567-e89b-12d3-a456-426614174000"
}'Plan replaced successfully
Identifier of the animal this plan is for.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the consult associated with this plan.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the plan was created.
Example: "2025-01-01T00:00:00.000Z"
Canonical identifier for the plan.
Example: "123e4567-e89b-12d3-a456-426614174000"
Clinical timestamp associated with the plan (e.g., when it was recorded in the consult).
Example: "2025-01-01T00:00:00.000Z"
Timestamp when the plan was last modified.
Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "consultId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "notes": "Example description", "planId": "123e4567-e89b-12d3-a456-426614174000", "recordedAt": "2025-01-01T00:00:00.000Z", "updatedAt": "2025-01-01T00:00:00.000Z", "vetId": "123e4567-e89b-12d3-a456-426614174000" }