Animal Health Data Store - V1 API Documentation
AHDS Store API (1.0)
https://docs.heydonto.com/_mock/apis/animal-health/openapi/
http://localhost:8083/
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/animal/{animalId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/animal/{animalId}
- 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/animal/{animalId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Animal found
Canonical unique identifier for the animal.
Timestamp when the animal record was created.
Date the animal was desexed (spayed/neutered). No time component is required.
True if notes contain important or highlighted information.
Whether the animal is deceased. Should be consistent with deathDate when present.
True if the date of birth is estimated rather than exact.
General clinical or administrative notes about the animal.
Canonical identifier of the primary owner contact.
Rabies vaccination certificate or tag number.
Date of last rabies vaccination.
Canonical identifier of the referring clinic.
Canonical identifier of the referring veterinarian.
Canonical identifier of the residence contact (if different from owner).
Resuscitation preference for the animal.
Timestamp when the animal record was last updated.
Optional herd identifier for production animals.
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "breed": {}, "code": "ANIMAL-001", "colour": {}, "createdAt": "2025-01-01T00:00:00.000Z", "deathReason": "Old age", "desexDate": "2025-01-01T00:00:00Z", "extensions": {}, "hasImportantNotes": false, "isActive": true, "isDead": false, "isEstimatedDateOfBirth": false, "isHostile": false, "microchipNumber": "982000123456789", "name": "Fluffy", "notes": "Friendly and well-behaved", "ownerContactId": "123e4567-e89b-12d3-a456-426614174000", "rabiesNumber": "RAB-2024-001", "rabiesVaccinationDate": "2025-01-01T00:00:00Z", "referringClinicId": "123e4567-e89b-12d3-a456-426614174000", "referringVetId": "123e4567-e89b-12d3-a456-426614174000", "residenceContactId": "123e4567-e89b-12d3-a456-426614174000", "resuscitationStatus": "full", "sex": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "species": {}, "updatedAt": "2025-01-01T00:00:00.000Z", "weight": { "value": 1.5, "unit": "km", "system": "http://unitsofmeasure.org" }, "herdId": "123e4567-e89b-12d3-a456-426614174000", "birthDate": "2025-01-01T00:00:00Z", "deathDate": "2025-01-01T00:00:00Z" }
Date the animal was desexed (spayed/neutered). No time component is required.
Whether the animal is deceased. Should be consistent with deathDate when present.
True if the date of birth is estimated rather than exact.
General clinical or administrative notes about the animal.
Canonical identifier of the primary owner contact.
Canonical identifier of the referring clinic.
Canonical identifier of the referring veterinarian.
Canonical identifier of the residence contact (if different from owner).
Resuscitation preference for the animal.
Optional herd identifier for production animals.
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/animal/{animalId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/animal/{animalId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/animal/{animalId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"breed": {},
"code": "ANIMAL-001",
"colour": {},
"deathReason": "Old age",
"desexDate": "2025-01-01",
"extensions": {},
"hasImportantNotes": false,
"isActive": true,
"isDead": false,
"isEstimatedDateOfBirth": false,
"isHostile": false,
"microchipNumber": "982000123456789",
"name": "Fluffy",
"notes": "Friendly and well-behaved",
"ownerContactId": "123e4567-e89b-12d3-a456-426614174000",
"rabiesNumber": "RAB-2024-001",
"rabiesVaccinationDate": "2025-01-01",
"referringClinicId": "123e4567-e89b-12d3-a456-426614174000",
"referringVetId": "123e4567-e89b-12d3-a456-426614174000",
"residenceContactId": "123e4567-e89b-12d3-a456-426614174000",
"resuscitationStatus": "full",
"sex": {
"code": "12345",
"system": "http://example.com/codesystem",
"display": "Example Display Name"
},
"species": {},
"weight": {
"value": 1.5,
"unit": "km",
"system": "http://unitsofmeasure.org"
},
"herdId": "123e4567-e89b-12d3-a456-426614174000",
"birthDate": "2025-01-01",
"deathDate": "2025-01-01"
}'Animal updated successfully
Canonical unique identifier for the animal.
Timestamp when the animal record was created.
Date the animal was desexed (spayed/neutered). No time component is required.
True if notes contain important or highlighted information.
Whether the animal is deceased. Should be consistent with deathDate when present.
True if the date of birth is estimated rather than exact.
General clinical or administrative notes about the animal.
Canonical identifier of the primary owner contact.
Rabies vaccination certificate or tag number.
Date of last rabies vaccination.
Canonical identifier of the referring clinic.
Canonical identifier of the referring veterinarian.
Canonical identifier of the residence contact (if different from owner).
Resuscitation preference for the animal.
Timestamp when the animal record was last updated.
Optional herd identifier for production animals.
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "breed": {}, "code": "ANIMAL-001", "colour": {}, "createdAt": "2025-01-01T00:00:00.000Z", "deathReason": "Old age", "desexDate": "2025-01-01T00:00:00Z", "extensions": {}, "hasImportantNotes": false, "isActive": true, "isDead": false, "isEstimatedDateOfBirth": false, "isHostile": false, "microchipNumber": "982000123456789", "name": "Fluffy", "notes": "Friendly and well-behaved", "ownerContactId": "123e4567-e89b-12d3-a456-426614174000", "rabiesNumber": "RAB-2024-001", "rabiesVaccinationDate": "2025-01-01T00:00:00Z", "referringClinicId": "123e4567-e89b-12d3-a456-426614174000", "referringVetId": "123e4567-e89b-12d3-a456-426614174000", "residenceContactId": "123e4567-e89b-12d3-a456-426614174000", "resuscitationStatus": "full", "sex": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "species": {}, "updatedAt": "2025-01-01T00:00:00.000Z", "weight": { "value": 1.5, "unit": "km", "system": "http://unitsofmeasure.org" }, "herdId": "123e4567-e89b-12d3-a456-426614174000", "birthDate": "2025-01-01T00:00:00Z", "deathDate": "2025-01-01T00:00:00Z" }
Date the animal was desexed (spayed/neutered). No time component is required.
True if notes contain important or highlighted information.
Whether the animal is deceased. Should be consistent with deathDate when present.
True if the date of birth is estimated rather than exact.
General clinical or administrative notes about the animal.
Canonical identifier of the primary owner contact.
Canonical identifier of the referring clinic.
Canonical identifier of the referring veterinarian.
Canonical identifier of the residence contact (if different from owner).
Resuscitation preference for the animal.
Optional herd identifier for production animals.
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/animal/{animalId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/animal/{animalId}
- 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/animal/{animalId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"breed": {},
"code": "ANIMAL-001",
"colour": {},
"deathReason": "Old age",
"desexDate": "2025-01-01",
"extensions": {},
"hasImportantNotes": false,
"isActive": true,
"isDead": false,
"isEstimatedDateOfBirth": false,
"isHostile": false,
"microchipNumber": "982000123456789",
"name": "Fluffy",
"notes": "Friendly and well-behaved",
"ownerContactId": "123e4567-e89b-12d3-a456-426614174000",
"rabiesNumber": "RAB-2024-001",
"rabiesVaccinationDate": "2025-01-01",
"referringClinicId": "123e4567-e89b-12d3-a456-426614174000",
"referringVetId": "123e4567-e89b-12d3-a456-426614174000",
"residenceContactId": "123e4567-e89b-12d3-a456-426614174000",
"resuscitationStatus": "full",
"sex": {
"code": "12345",
"system": "http://example.com/codesystem",
"display": "Example Display Name"
},
"species": {},
"weight": {
"value": 1.5,
"unit": "km",
"system": "http://unitsofmeasure.org"
},
"herdId": "123e4567-e89b-12d3-a456-426614174000",
"birthDate": "2025-01-01",
"deathDate": "2025-01-01"
}'Animal replaced successfully
Canonical unique identifier for the animal.
Timestamp when the animal record was created.
Date the animal was desexed (spayed/neutered). No time component is required.
True if notes contain important or highlighted information.
Whether the animal is deceased. Should be consistent with deathDate when present.
True if the date of birth is estimated rather than exact.
General clinical or administrative notes about the animal.
Canonical identifier of the primary owner contact.
Rabies vaccination certificate or tag number.
Date of last rabies vaccination.
Canonical identifier of the referring clinic.
Canonical identifier of the referring veterinarian.
Canonical identifier of the residence contact (if different from owner).
Resuscitation preference for the animal.
Timestamp when the animal record was last updated.
Optional herd identifier for production animals.
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "breed": {}, "code": "ANIMAL-001", "colour": {}, "createdAt": "2025-01-01T00:00:00.000Z", "deathReason": "Old age", "desexDate": "2025-01-01T00:00:00Z", "extensions": {}, "hasImportantNotes": false, "isActive": true, "isDead": false, "isEstimatedDateOfBirth": false, "isHostile": false, "microchipNumber": "982000123456789", "name": "Fluffy", "notes": "Friendly and well-behaved", "ownerContactId": "123e4567-e89b-12d3-a456-426614174000", "rabiesNumber": "RAB-2024-001", "rabiesVaccinationDate": "2025-01-01T00:00:00Z", "referringClinicId": "123e4567-e89b-12d3-a456-426614174000", "referringVetId": "123e4567-e89b-12d3-a456-426614174000", "residenceContactId": "123e4567-e89b-12d3-a456-426614174000", "resuscitationStatus": "full", "sex": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "species": {}, "updatedAt": "2025-01-01T00:00:00.000Z", "weight": { "value": 1.5, "unit": "km", "system": "http://unitsofmeasure.org" }, "herdId": "123e4567-e89b-12d3-a456-426614174000", "birthDate": "2025-01-01T00:00:00Z", "deathDate": "2025-01-01T00:00:00Z" }