Skip to content

AHDS Store API (1.0)

Animal Health Data Store - V1 API Documentation

Overview
Languages
Servers
Mock server

https://docs.heydonto.com/_mock/apis/animal-health/openapi/

Local Development

http://localhost:8083/

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Request

Creates a new Communication record. Communication resource in the Animal Health Data Store

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
associatedResourceIdstringrequired

Identifier of the resource this communication is associated with.

Example: "123e4567-e89b-12d3-a456-426614174000"
associatedResourceTypestringrequired

Type of resource this communication is associated with (e.g. Contact, Animal, Consult).

communicatingResourceIdstring

Identifier of the communicating party when different from associatedResourceId.

Example: "123e4567-e89b-12d3-a456-426614174000"
communicatingResourceTypestring

Type of the communicating party (e.g. Contact, Animal) when different from associatedResourceType.

communicationIdstringrequired

Canonical identifier for the communication.

Example: "123e4567-e89b-12d3-a456-426614174000"
contactDetailTypeIdstringrequired

Identifier of the ContactDetailType used to send the communication.

Example: "123e4567-e89b-12d3-a456-426614174000"
contentstringrequired

Body/content of the communication.

contentFormatstringrequired

Format of the communication content.

Enum"SMS""PLAINTEXT""HTML"
destinationstringrequired

Destination address/identifier for the communication, format defined by contactDetailTypeId.

directionstringrequired

Direction of the communication relative to the practice.

Enum"OUTGOING""INCOMING"
extensionsobject

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the communication record is active.

originstring

Origin address/identifier for the communication, if available.

readAtstring or null

When the communication was marked as read, if applicable.

Example: "2025-01-01T00:00:00.000Z"
sentAsUserobject

User on whose behalf the communication was sent.

statusstringrequired

Delivery or processing status of the communication.

Enum"PENDING""DONE""SENDING""FAILED"
subjectstring

Subject or title of the communication.

templateobject

Template used to generate this communication, if any.

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/communication' \
  -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",
    "communicationId": "123e4567-e89b-12d3-a456-426614174000",
    "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": {}
  }'

Responses

Communication created successfully

Bodyapplication/json
associatedResourceIdstringrequired

Identifier of the resource this communication is associated with.

Example: "123e4567-e89b-12d3-a456-426614174000"
associatedResourceTypestringrequired

Type of resource this communication is associated with (e.g. Contact, Animal, Consult).

communicatingResourceIdstringrequired

Identifier of the communicating party when different from associatedResourceId.

Example: "123e4567-e89b-12d3-a456-426614174000"
communicatingResourceTypestringrequired

Type of the communicating party (e.g. Contact, Animal) when different from associatedResourceType.

communicationIdstringrequired

Canonical identifier for the communication.

Example: "123e4567-e89b-12d3-a456-426614174000"
contactDetailTypeIdstringrequired

Identifier of the ContactDetailType used to send the communication.

Example: "123e4567-e89b-12d3-a456-426614174000"
contentstringrequired

Body/content of the communication.

contentFormatstringrequired

Format of the communication content.

Enum"SMS""PLAINTEXT""HTML"
createdAtstring(date-time)required

When the communication record was created.

Example: "2025-01-01T00:00:00.000Z"
destinationstringrequired

Destination address/identifier for the communication, format defined by contactDetailTypeId.

directionstringrequired

Direction of the communication relative to the practice.

Enum"OUTGOING""INCOMING"
extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the communication record is active.

originstringrequired

Origin address/identifier for the communication, if available.

readAtstring or null(date-time)required

When the communication was marked as read, if applicable.

Example: "2025-01-01T00:00:00.000Z"
sentAsUserobjectrequired

User on whose behalf the communication was sent.

statusstringrequired

Delivery or processing status of the communication.

Enum"PENDING""DONE""SENDING""FAILED"
subjectstringrequired

Subject or title of the communication.

templateobjectrequired

Template used to generate this communication, if any.

updatedAtstring(date-time)required

When the communication record was last updated.

Example: "2025-01-01T00:00:00.000Z"
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" }

Request

Returns a paginated list of Communications for the specified site. Supports filtering and sorting.

Security
bearer
Path
siteIdnumberrequired

Site identifier

Query
pagenumber>= 0

Page number (0-indexed)

Default 0
pageSizenumber[ 1 .. 100 ]

Number of items per page

Default 10
sortBystring

Field to sort by

Enum"createdAt""updatedAt""associatedResourceType""communicatingResourceType""content""destination""origin""readAt""subject"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
associatedResourceIdstring

Identifier of the resource this communication is associated with.

Example: associatedResourceId=123e4567-e89b-12d3-a456-426614174000
associatedResourceTypestring

Type of resource this communication is associated with (e.g. Contact, Animal, Consult).

communicatingResourceIdstring

Identifier of the communicating party when different from associatedResourceId.

Example: communicatingResourceId=123e4567-e89b-12d3-a456-426614174000
communicatingResourceTypestring

Type of the communicating party (e.g. Contact, Animal) when different from associatedResourceType.

contactDetailTypeIdstring

Identifier of the ContactDetailType used to send the communication.

Example: contactDetailTypeId=123e4567-e89b-12d3-a456-426614174000
contentstring

Body/content of the communication.

contentFormatstring

Format of the communication content.

Enum"SMS""PLAINTEXT""HTML"
destinationstring

Destination address/identifier for the communication, format defined by contactDetailTypeId.

directionstring

Direction of the communication relative to the practice.

Enum"OUTGOING""INCOMING"
isActiveboolean

Whether the communication record is active.

originstring

Origin address/identifier for the communication, if available.

statusstring

Delivery or processing status of the communication.

Enum"PENDING""DONE""SENDING""FAILED"
subjectstring

Subject or title of the communication.

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/communication?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&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&isActive=true&origin=string&status=PENDING&subject=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Communications

Request

Returns a single Communication by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

communicationIdstringrequired

Communication unique identifier (UUID)

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/communication/{communicationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Communication found

Bodyapplication/json
associatedResourceIdstringrequired

Identifier of the resource this communication is associated with.

Example: "123e4567-e89b-12d3-a456-426614174000"
associatedResourceTypestringrequired

Type of resource this communication is associated with (e.g. Contact, Animal, Consult).

communicatingResourceIdstringrequired

Identifier of the communicating party when different from associatedResourceId.

Example: "123e4567-e89b-12d3-a456-426614174000"
communicatingResourceTypestringrequired

Type of the communicating party (e.g. Contact, Animal) when different from associatedResourceType.

communicationIdstringrequired

Canonical identifier for the communication.

Example: "123e4567-e89b-12d3-a456-426614174000"
contactDetailTypeIdstringrequired

Identifier of the ContactDetailType used to send the communication.

Example: "123e4567-e89b-12d3-a456-426614174000"
contentstringrequired

Body/content of the communication.

contentFormatstringrequired

Format of the communication content.

Enum"SMS""PLAINTEXT""HTML"
createdAtstring(date-time)required

When the communication record was created.

Example: "2025-01-01T00:00:00.000Z"
destinationstringrequired

Destination address/identifier for the communication, format defined by contactDetailTypeId.

directionstringrequired

Direction of the communication relative to the practice.

Enum"OUTGOING""INCOMING"
extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the communication record is active.

originstringrequired

Origin address/identifier for the communication, if available.

readAtstring or null(date-time)required

When the communication was marked as read, if applicable.

Example: "2025-01-01T00:00:00.000Z"
sentAsUserobjectrequired

User on whose behalf the communication was sent.

statusstringrequired

Delivery or processing status of the communication.

Enum"PENDING""DONE""SENDING""FAILED"
subjectstringrequired

Subject or title of the communication.

templateobjectrequired

Template used to generate this communication, if any.

updatedAtstring(date-time)required

When the communication record was last updated.

Example: "2025-01-01T00:00:00.000Z"
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" }

Request

Partially updates an existing Communication. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

communicationIdstringrequired

Communication unique identifier (UUID)

Bodyapplication/jsonrequired
associatedResourceIdstring

Identifier of the resource this communication is associated with.

Example: "123e4567-e89b-12d3-a456-426614174000"
associatedResourceTypestring

Type of resource this communication is associated with (e.g. Contact, Animal, Consult).

communicatingResourceIdstring

Identifier of the communicating party when different from associatedResourceId.

Example: "123e4567-e89b-12d3-a456-426614174000"
communicatingResourceTypestring

Type of the communicating party (e.g. Contact, Animal) when different from associatedResourceType.

contactDetailTypeIdstring

Identifier of the ContactDetailType used to send the communication.

Example: "123e4567-e89b-12d3-a456-426614174000"
contentstring

Body/content of the communication.

contentFormatstring

Format of the communication content.

Enum"SMS""PLAINTEXT""HTML"
destinationstring

Destination address/identifier for the communication, format defined by contactDetailTypeId.

directionstring

Direction of the communication relative to the practice.

Enum"OUTGOING""INCOMING"
extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Whether the communication record is active.

originstring

Origin address/identifier for the communication, if available.

readAtstring or null

When the communication was marked as read, if applicable.

Example: "2025-01-01T00:00:00.000Z"
sentAsUserobject

User on whose behalf the communication was sent.

statusstring

Delivery or processing status of the communication.

Enum"PENDING""DONE""SENDING""FAILED"
subjectstring

Subject or title of the communication.

templateobject

Template used to generate this communication, if any.

curl -i -X PATCH \
  '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": {}
  }'

Responses

Communication updated successfully

Bodyapplication/json
associatedResourceIdstringrequired

Identifier of the resource this communication is associated with.

Example: "123e4567-e89b-12d3-a456-426614174000"
associatedResourceTypestringrequired

Type of resource this communication is associated with (e.g. Contact, Animal, Consult).

communicatingResourceIdstringrequired

Identifier of the communicating party when different from associatedResourceId.

Example: "123e4567-e89b-12d3-a456-426614174000"
communicatingResourceTypestringrequired

Type of the communicating party (e.g. Contact, Animal) when different from associatedResourceType.

communicationIdstringrequired

Canonical identifier for the communication.

Example: "123e4567-e89b-12d3-a456-426614174000"
contactDetailTypeIdstringrequired

Identifier of the ContactDetailType used to send the communication.

Example: "123e4567-e89b-12d3-a456-426614174000"
contentstringrequired

Body/content of the communication.

contentFormatstringrequired

Format of the communication content.

Enum"SMS""PLAINTEXT""HTML"
createdAtstring(date-time)required

When the communication record was created.

Example: "2025-01-01T00:00:00.000Z"
destinationstringrequired

Destination address/identifier for the communication, format defined by contactDetailTypeId.

directionstringrequired

Direction of the communication relative to the practice.

Enum"OUTGOING""INCOMING"
extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the communication record is active.

originstringrequired

Origin address/identifier for the communication, if available.

readAtstring or null(date-time)required

When the communication was marked as read, if applicable.

Example: "2025-01-01T00:00:00.000Z"
sentAsUserobjectrequired

User on whose behalf the communication was sent.

statusstringrequired

Delivery or processing status of the communication.

Enum"PENDING""DONE""SENDING""FAILED"
subjectstringrequired

Subject or title of the communication.

templateobjectrequired

Template used to generate this communication, if any.

updatedAtstring(date-time)required

When the communication record was last updated.

Example: "2025-01-01T00:00:00.000Z"
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" }

Request

Fully replaces an existing Communication. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

communicationIdstringrequired

Communication unique identifier (UUID)

Bodyapplication/jsonrequired
associatedResourceIdstringrequired

Identifier of the resource this communication is associated with.

Example: "123e4567-e89b-12d3-a456-426614174000"
associatedResourceTypestringrequired

Type of resource this communication is associated with (e.g. Contact, Animal, Consult).

communicatingResourceIdstringrequired

Identifier of the communicating party when different from associatedResourceId.

Example: "123e4567-e89b-12d3-a456-426614174000"
communicatingResourceTypestringrequired

Type of the communicating party (e.g. Contact, Animal) when different from associatedResourceType.

contactDetailTypeIdstringrequired

Identifier of the ContactDetailType used to send the communication.

Example: "123e4567-e89b-12d3-a456-426614174000"
contentstringrequired

Body/content of the communication.

contentFormatstringrequired

Format of the communication content.

Enum"SMS""PLAINTEXT""HTML"
destinationstringrequired

Destination address/identifier for the communication, format defined by contactDetailTypeId.

directionstringrequired

Direction of the communication relative to the practice.

Enum"OUTGOING""INCOMING"
extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the communication record is active.

originstringrequired

Origin address/identifier for the communication, if available.

readAtstring or null

When the communication was marked as read, if applicable.

Example: "2025-01-01T00:00:00.000Z"
sentAsUserobjectrequired

User on whose behalf the communication was sent.

statusstringrequired

Delivery or processing status of the communication.

Enum"PENDING""DONE""SENDING""FAILED"
subjectstringrequired

Subject or title of the communication.

templateobjectrequired

Template used to generate this communication, if any.

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": {}
  }'

Responses

Communication replaced successfully

Bodyapplication/json
associatedResourceIdstringrequired

Identifier of the resource this communication is associated with.

Example: "123e4567-e89b-12d3-a456-426614174000"
associatedResourceTypestringrequired

Type of resource this communication is associated with (e.g. Contact, Animal, Consult).

communicatingResourceIdstringrequired

Identifier of the communicating party when different from associatedResourceId.

Example: "123e4567-e89b-12d3-a456-426614174000"
communicatingResourceTypestringrequired

Type of the communicating party (e.g. Contact, Animal) when different from associatedResourceType.

communicationIdstringrequired

Canonical identifier for the communication.

Example: "123e4567-e89b-12d3-a456-426614174000"
contactDetailTypeIdstringrequired

Identifier of the ContactDetailType used to send the communication.

Example: "123e4567-e89b-12d3-a456-426614174000"
contentstringrequired

Body/content of the communication.

contentFormatstringrequired

Format of the communication content.

Enum"SMS""PLAINTEXT""HTML"
createdAtstring(date-time)required

When the communication record was created.

Example: "2025-01-01T00:00:00.000Z"
destinationstringrequired

Destination address/identifier for the communication, format defined by contactDetailTypeId.

directionstringrequired

Direction of the communication relative to the practice.

Enum"OUTGOING""INCOMING"
extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the communication record is active.

originstringrequired

Origin address/identifier for the communication, if available.

readAtstring or null(date-time)required

When the communication was marked as read, if applicable.

Example: "2025-01-01T00:00:00.000Z"
sentAsUserobjectrequired

User on whose behalf the communication was sent.

statusstringrequired

Delivery or processing status of the communication.

Enum"PENDING""DONE""SENDING""FAILED"
subjectstringrequired

Subject or title of the communication.

templateobjectrequired

Template used to generate this communication, if any.

updatedAtstring(date-time)required

When the communication record was last updated.

Example: "2025-01-01T00:00:00.000Z"
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" }

Request

Permanently deletes a Communication record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

communicationIdstringrequired

Communication unique identifier (UUID)

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>'

Responses

Communication deleted successfully

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations