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
Identifier of the resource this communication is associated with.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type of resource this communication is associated with (e.g. Contact, Animal, Consult).
Identifier of the communicating party when different from associatedResourceId.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type of the communicating party (e.g. Contact, Animal) when different from associatedResourceType.
Identifier of the ContactDetailType used to send the communication.
Example: "123e4567-e89b-12d3-a456-426614174000"
Destination address/identifier for the communication, format defined by contactDetailTypeId.
Direction of the communication relative to the practice.
Enum"OUTGOING""INCOMING"
When the communication was marked as read, if applicable.
Example: "2025-01-01T00:00:00.000Z"
Delivery or processing status of the communication.
Enum"PENDING""DONE""SENDING""FAILED"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/communication/{communicationId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/communication/{communicationId}
- 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/communication/{communicationId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"associatedResourceId": "123e4567-e89b-12d3-a456-426614174000",
"associatedResourceType": "string",
"communicatingResourceId": "123e4567-e89b-12d3-a456-426614174000",
"communicatingResourceType": "string",
"contactDetailTypeId": "123e4567-e89b-12d3-a456-426614174000",
"content": "string",
"contentFormat": "SMS",
"destination": "string",
"direction": "OUTGOING",
"extensions": {},
"isActive": true,
"origin": "string",
"readAt": "2025-01-01T00:00:00.000Z",
"sentAsUser": {},
"status": "PENDING",
"subject": "string",
"template": {}
}'Communication replaced successfully
Identifier of the resource this communication is associated with.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type of resource this communication is associated with (e.g. Contact, Animal, Consult).
Identifier of the communicating party when different from associatedResourceId.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type of the communicating party (e.g. Contact, Animal) when different from associatedResourceType.
Canonical identifier for the communication.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the ContactDetailType used to send the communication.
Example: "123e4567-e89b-12d3-a456-426614174000"
When the communication record was created.
Example: "2025-01-01T00:00:00.000Z"
Destination address/identifier for the communication, format defined by contactDetailTypeId.
Direction of the communication relative to the practice.
Enum"OUTGOING""INCOMING"
When the communication was marked as read, if applicable.
Example: "2025-01-01T00:00:00.000Z"
Delivery or processing status of the communication.
Enum"PENDING""DONE""SENDING""FAILED"
Response
application/json
{ "associatedResourceId": "123e4567-e89b-12d3-a456-426614174000", "associatedResourceType": "string", "communicatingResourceId": "123e4567-e89b-12d3-a456-426614174000", "communicatingResourceType": "string", "communicationId": "123e4567-e89b-12d3-a456-426614174000", "contactDetailTypeId": "123e4567-e89b-12d3-a456-426614174000", "content": "string", "contentFormat": "SMS", "createdAt": "2025-01-01T00:00:00.000Z", "destination": "string", "direction": "OUTGOING", "extensions": {}, "isActive": true, "origin": "string", "readAt": "2025-01-01T00:00:00.000Z", "sentAsUser": {}, "status": "PENDING", "subject": "string", "template": {}, "updatedAt": "2025-01-01T00:00:00.000Z" }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/communication/{communicationId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/communication/{communicationId}
- 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/communication/{communicationId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'