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
Reference to the animal on which the operation was performed.
Example: "123e4567-e89b-12d3-a456-426614174000"
Reference to the consult associated with this operation.
Example: "123e4567-e89b-12d3-a456-426614174000"
Date and time when the operation was performed.
Example: "2025-01-01T00:00:00.000Z"
Reference to a therapeutic or procedure definition associated with this operation.
Example: "123e4567-e89b-12d3-a456-426614174000"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/operation/{operationId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/operation/{operationId}
- 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/operation/{operationId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"animalId": "123e4567-e89b-12d3-a456-426614174000",
"consultId": "123e4567-e89b-12d3-a456-426614174000",
"extensions": {},
"isActive": true,
"outcome": "string",
"performedAt": "2025-01-01T00:00:00.000Z",
"specifics": "string",
"therapeuticId": "123e4567-e89b-12d3-a456-426614174000",
"vetId": "123e4567-e89b-12d3-a456-426614174000"
}'Operation updated successfully
Reference to the animal on which the operation was performed.
Example: "123e4567-e89b-12d3-a456-426614174000"
Reference to the consult associated with this operation.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the operation record was created.
Example: "2025-01-01T00:00:00.000Z"
Canonical identifier for the operation record.
Example: "123e4567-e89b-12d3-a456-426614174000"
Date and time when the operation was performed.
Example: "2025-01-01T00:00:00.000Z"
Reference to a therapeutic or procedure definition associated with this operation.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the operation record was last updated.
Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "consultId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "operationId": "123e4567-e89b-12d3-a456-426614174000", "outcome": "string", "performedAt": "2025-01-01T00:00:00.000Z", "specifics": "string", "therapeuticId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z", "vetId": "123e4567-e89b-12d3-a456-426614174000" }
Bodyapplication/jsonrequired
Reference to the animal on which the operation was performed.
Example: "123e4567-e89b-12d3-a456-426614174000"
Reference to the consult associated with this operation.
Example: "123e4567-e89b-12d3-a456-426614174000"
Date and time when the operation was performed.
Example: "2025-01-01T00:00:00.000Z"
Reference to a therapeutic or procedure definition associated with this operation.
Example: "123e4567-e89b-12d3-a456-426614174000"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/operation/{operationId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/operation/{operationId}
- 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/operation/{operationId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"animalId": "123e4567-e89b-12d3-a456-426614174000",
"consultId": "123e4567-e89b-12d3-a456-426614174000",
"extensions": {},
"isActive": true,
"outcome": "string",
"performedAt": "2025-01-01T00:00:00.000Z",
"specifics": "string",
"therapeuticId": "123e4567-e89b-12d3-a456-426614174000",
"vetId": "123e4567-e89b-12d3-a456-426614174000"
}'Operation replaced successfully
Reference to the animal on which the operation was performed.
Example: "123e4567-e89b-12d3-a456-426614174000"
Reference to the consult associated with this operation.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the operation record was created.
Example: "2025-01-01T00:00:00.000Z"
Canonical identifier for the operation record.
Example: "123e4567-e89b-12d3-a456-426614174000"
Date and time when the operation was performed.
Example: "2025-01-01T00:00:00.000Z"
Reference to a therapeutic or procedure definition associated with this operation.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the operation record was last updated.
Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "consultId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "operationId": "123e4567-e89b-12d3-a456-426614174000", "outcome": "string", "performedAt": "2025-01-01T00:00:00.000Z", "specifics": "string", "therapeuticId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z", "vetId": "123e4567-e89b-12d3-a456-426614174000" }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/operation/{operationId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/operation/{operationId}
- 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/operation/{operationId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'