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
Associated/related contact.
Example: "123e4567-e89b-12d3-a456-426614174000"
Classification of the relationship between the contacts.
Enum"family""other"
Canonical identifier for this contact association.
Example: "123e4567-e89b-12d3-a456-426614174000"
Primary contact in the association.
Example: "123e4567-e89b-12d3-a456-426614174000"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/contact-association
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/contact-association
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/contact-association' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"associatedContactId": "123e4567-e89b-12d3-a456-426614174000",
"associationClass": "family",
"contactAssociationId": "123e4567-e89b-12d3-a456-426614174000",
"contactId": "123e4567-e89b-12d3-a456-426614174000",
"extensions": {},
"isActive": true,
"associationType": {
"code": "string",
"system": "string",
"display": "string"
}
}'Contact Association created successfully
Associated/related contact.
Example: "123e4567-e89b-12d3-a456-426614174000"
Classification of the relationship between the contacts.
Enum"family""other"
Canonical identifier for this contact association.
Example: "123e4567-e89b-12d3-a456-426614174000"
Primary contact in the association.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the association was created.
Example: "2025-01-01T00:00:00.000Z"
Timestamp when the association was last updated.
Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "associatedContactId": "123e4567-e89b-12d3-a456-426614174000", "associationClass": "family", "contactAssociationId": "123e4567-e89b-12d3-a456-426614174000", "contactId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "updatedAt": "2025-01-01T00:00:00.000Z", "associationType": { "code": "string", "system": "string", "display": "string" } }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/contact-association
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/contact-association
- 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/contact-association?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&associatedContactId=123e4567-e89b-12d3-a456-426614174000&associationClass=family&contactId=123e4567-e89b-12d3-a456-426614174000&isActive=true' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/contact-association/{contactAssociationId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/contact-association/{contactAssociationId}
- 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/contact-association/{contactAssociationId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Contact Association found
Associated/related contact.
Example: "123e4567-e89b-12d3-a456-426614174000"
Classification of the relationship between the contacts.
Enum"family""other"
Canonical identifier for this contact association.
Example: "123e4567-e89b-12d3-a456-426614174000"
Primary contact in the association.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the association was created.
Example: "2025-01-01T00:00:00.000Z"
Timestamp when the association was last updated.
Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "associatedContactId": "123e4567-e89b-12d3-a456-426614174000", "associationClass": "family", "contactAssociationId": "123e4567-e89b-12d3-a456-426614174000", "contactId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "updatedAt": "2025-01-01T00:00:00.000Z", "associationType": { "code": "string", "system": "string", "display": "string" } }