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/wellness-resource/{resourceId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/wellness-resource/{resourceId}
- 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/wellness-resource/{resourceId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Wellness Resource found
Timestamp when the wellness resource was created.
Example: "2025-01-01T00:00:00.000Z"
Indicates whether the wellness resource is currently active and available for use.
Stable, opaque identifier for the wellness resource.
Example: "123e4567-e89b-12d3-a456-426614174000"
High-level classification of the wellness resource.
Enum"wellnessPlan""wellnessProgram""wellnessPackage""preventiveCareBundle""other"
Lifecycle status of the wellness resource.
Enum"draft""active""inactive""retired"
Timestamp when the wellness resource was last updated.
Example: "2025-01-01T00:00:00.000Z"
Date from which the wellness resource is valid.
Example: "2025-01-01T00:00:00Z"
Response
application/json
{ "createdAt": "2025-01-01T00:00:00.000Z", "description": "string", "extensions": {}, "isActive": true, "name": "string", "resourceId": "123e4567-e89b-12d3-a456-426614174000", "resourceType": "wellnessPlan", "status": "draft", "updatedAt": "2025-01-01T00:00:00.000Z", "validFromDate": "2025-01-01T00:00:00Z", "validToDate": "2025-01-01T00:00:00Z" }
Bodyapplication/jsonrequired
High-level classification of the wellness resource.
Enum"wellnessPlan""wellnessProgram""wellnessPackage""preventiveCareBundle""other"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/wellness-resource/{resourceId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/wellness-resource/{resourceId}
- 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/wellness-resource/{resourceId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"description": "string",
"extensions": {},
"isActive": true,
"name": "string",
"resourceType": "wellnessPlan",
"status": "draft",
"validFromDate": "2025-01-01",
"validToDate": "2025-01-01"
}'Wellness Resource updated successfully
Timestamp when the wellness resource was created.
Example: "2025-01-01T00:00:00.000Z"
Indicates whether the wellness resource is currently active and available for use.
Stable, opaque identifier for the wellness resource.
Example: "123e4567-e89b-12d3-a456-426614174000"
High-level classification of the wellness resource.
Enum"wellnessPlan""wellnessProgram""wellnessPackage""preventiveCareBundle""other"
Lifecycle status of the wellness resource.
Enum"draft""active""inactive""retired"
Timestamp when the wellness resource was last updated.
Example: "2025-01-01T00:00:00.000Z"
Date from which the wellness resource is valid.
Example: "2025-01-01T00:00:00Z"
Response
application/json
{ "createdAt": "2025-01-01T00:00:00.000Z", "description": "string", "extensions": {}, "isActive": true, "name": "string", "resourceId": "123e4567-e89b-12d3-a456-426614174000", "resourceType": "wellnessPlan", "status": "draft", "updatedAt": "2025-01-01T00:00:00.000Z", "validFromDate": "2025-01-01T00:00:00Z", "validToDate": "2025-01-01T00:00:00Z" }
Bodyapplication/jsonrequired
Indicates whether the wellness resource is currently active and available for use.
High-level classification of the wellness resource.
Enum"wellnessPlan""wellnessProgram""wellnessPackage""preventiveCareBundle""other"
Lifecycle status of the wellness resource.
Enum"draft""active""inactive""retired"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/wellness-resource/{resourceId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/wellness-resource/{resourceId}
- 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/wellness-resource/{resourceId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"description": "string",
"extensions": {},
"isActive": true,
"name": "string",
"resourceType": "wellnessPlan",
"status": "draft",
"validFromDate": "2025-01-01",
"validToDate": "2025-01-01"
}'Wellness Resource replaced successfully
Timestamp when the wellness resource was created.
Example: "2025-01-01T00:00:00.000Z"
Indicates whether the wellness resource is currently active and available for use.
Stable, opaque identifier for the wellness resource.
Example: "123e4567-e89b-12d3-a456-426614174000"
High-level classification of the wellness resource.
Enum"wellnessPlan""wellnessProgram""wellnessPackage""preventiveCareBundle""other"
Lifecycle status of the wellness resource.
Enum"draft""active""inactive""retired"
Timestamp when the wellness resource was last updated.
Example: "2025-01-01T00:00:00.000Z"
Date from which the wellness resource is valid.
Example: "2025-01-01T00:00:00Z"
Response
application/json
{ "createdAt": "2025-01-01T00:00:00.000Z", "description": "string", "extensions": {}, "isActive": true, "name": "string", "resourceId": "123e4567-e89b-12d3-a456-426614174000", "resourceType": "wellnessPlan", "status": "draft", "updatedAt": "2025-01-01T00:00:00.000Z", "validFromDate": "2025-01-01T00:00:00Z", "validToDate": "2025-01-01T00:00:00Z" }