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 contact this detail belongs to.
Example: "123e4567-e89b-12d3-a456-426614174000"
Whether this is the preferred contact detail of its type for the contact.
Example: true
Label or type name for the contact detail (e.g. 'Home phone', 'Email').
Example: "Example Name"
Identifiers of communication subscription groups associated with this contact detail.
Raw value of the contact detail (e.g. phone number, email address).
Example: "user@example.com"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/contact-detail/{contactDetailId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/contact-detail/{contactDetailId}
- 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/contact-detail/{contactDetailId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"contactDetailType": {
"code": "12345",
"system": "http://example.com/codesystem",
"display": "Example Display Name"
},
"contactId": "123e4567-e89b-12d3-a456-426614174000",
"extensions": {},
"isActive": true,
"isPreferred": true,
"name": "Example Name",
"subscriptionGroups": [
"string"
],
"value": "user@example.com",
"valueCleaned": "example"
}'Contact Detail replaced successfully
Canonical identifier for this contact detail.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the contact this detail belongs to.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when this contact detail was created.
Example: "2025-01-01T00:00:00.000Z"
Whether this is the preferred contact detail of its type for the contact.
Example: true
Label or type name for the contact detail (e.g. 'Home phone', 'Email').
Example: "Example Name"
Identifiers of communication subscription groups associated with this contact detail.
Timestamp when this contact detail was last updated.
Example: "2025-01-01T00:00:00.000Z"
Raw value of the contact detail (e.g. phone number, email address).
Example: "user@example.com"
Response
application/json
{ "contactDetailId": "123e4567-e89b-12d3-a456-426614174000", "contactDetailType": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "contactId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "isPreferred": true, "name": "Example Name", "subscriptionGroups": [ "string" ], "updatedAt": "2025-01-01T00:00:00.000Z", "value": "user@example.com", "valueCleaned": "example" }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/contact-detail/{contactDetailId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/contact-detail/{contactDetailId}
- 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/contact-detail/{contactDetailId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'