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/template
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/template
- 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/template?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&isActive=true&name=string&templateSubtype=string&templateType=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/template/{templateId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/template/{templateId}
- 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/template/{templateId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Template found
Timestamp when the template was created.
Example: "2025-01-01T00:00:00.000Z"
Canonical unique identifier for the template.
Example: "123e4567-e89b-12d3-a456-426614174000"
Optional subtype of the template (e.g., reminder, discharge).
Example: "example"
High-level type of the template (e.g., email, sms, document).
Example: "user@example.com"
Response
application/json
{ "additionalInformation": {}, "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "name": "Example Name", "templateId": "123e4567-e89b-12d3-a456-426614174000", "templateSubtype": "example", "templateType": "user@example.com", "updatedAt": "2025-01-01T00:00:00.000Z" }
Bodyapplication/jsonrequired
Optional subtype of the template (e.g., reminder, discharge).
Example: "example"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/template/{templateId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/template/{templateId}
- 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/template/{templateId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"additionalInformation": {},
"extensions": {},
"isActive": true,
"name": "Example Name",
"templateSubtype": "example",
"templateType": "user@example.com"
}'Template updated successfully
Timestamp when the template was created.
Example: "2025-01-01T00:00:00.000Z"
Canonical unique identifier for the template.
Example: "123e4567-e89b-12d3-a456-426614174000"
Optional subtype of the template (e.g., reminder, discharge).
Example: "example"
High-level type of the template (e.g., email, sms, document).
Example: "user@example.com"
Response
application/json
{ "additionalInformation": {}, "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "name": "Example Name", "templateId": "123e4567-e89b-12d3-a456-426614174000", "templateSubtype": "example", "templateType": "user@example.com", "updatedAt": "2025-01-01T00:00:00.000Z" }