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/
Bodyapplication/jsonrequired
Reference to the insured animal.
Example: "123e4567-e89b-12d3-a456-426614174000"
Reference to the policy holder contact.
Example: "123e4567-e89b-12d3-a456-426614174000"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/insurance/{insuranceId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/insurance/{insuranceId}
- 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/insurance/{insuranceId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"policyNumber": "string",
"provider": {
"code": "string",
"system": "string",
"display": "string"
},
"animalId": "123e4567-e89b-12d3-a456-426614174000",
"contactId": "123e4567-e89b-12d3-a456-426614174000",
"coverageType": {
"code": "string",
"system": "string",
"display": "string"
},
"effectiveDate": "2025-01-01",
"expiryDate": "2025-01-01",
"isActive": true,
"extensions": {}
}'Insurance replaced successfully
Canonical unique identifier for the insurance record.
Example: "123e4567-e89b-12d3-a456-426614174000"
Reference to the insured animal.
Example: "123e4567-e89b-12d3-a456-426614174000"
Reference to the policy holder contact.
Example: "123e4567-e89b-12d3-a456-426614174000"
Date the policy becomes effective.
Example: "2025-01-01T00:00:00Z"
Timestamp when the insurance record was created.
Example: "2025-01-01T00:00:00.000Z"
Timestamp when the insurance record was last updated.
Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "insuranceId": "123e4567-e89b-12d3-a456-426614174000", "policyNumber": "string", "provider": { "code": "string", "system": "string", "display": "string" }, "animalId": "123e4567-e89b-12d3-a456-426614174000", "contactId": "123e4567-e89b-12d3-a456-426614174000", "coverageType": { "code": "string", "system": "string", "display": "string" }, "effectiveDate": "2025-01-01T00:00:00Z", "expiryDate": "2025-01-01T00:00:00Z", "isActive": true, "createdAt": "2025-01-01T00:00:00.000Z", "updatedAt": "2025-01-01T00:00:00.000Z", "extensions": {} }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/insurance/{insuranceId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/insurance/{insuranceId}
- 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/insurance/{insuranceId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'