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/
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/integrated-diagnostic/{integratedDiagnosticId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/integrated-diagnostic/{integratedDiagnosticId}
- 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/integrated-diagnostic/{integratedDiagnosticId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"code": "CODE-001",
"description": "Example description",
"extensions": {},
"isActive": true,
"name": "Example Name",
"supplierPrice": {}
}'Integrated Diagnostic updated successfully
Practice- or vendor-specific code for the integrated diagnostic.
Example: "CODE-001"
Timestamp when this integrated diagnostic record was created.
Example: "2025-01-01T00:00:00.000Z"
Free-text description of the integrated diagnostic.
Example: "Example description"
Canonical identifier for the integrated diagnostic.
Example: "123e4567-e89b-12d3-a456-426614174000"
Whether this integrated diagnostic is active and available for use.
Example: true
Response
application/json
{ "code": "CODE-001", "createdAt": "2025-01-01T00:00:00.000Z", "description": "Example description", "extensions": {}, "integratedDiagnosticId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "name": "Example Name", "supplierPrice": {}, "updatedAt": "2025-01-01T00:00:00.000Z" }
Bodyapplication/jsonrequired
Practice- or vendor-specific code for the integrated diagnostic.
Example: "CODE-001"
Free-text description of the integrated diagnostic.
Example: "Example description"
Whether this integrated diagnostic is active and available for use.
Example: true
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/integrated-diagnostic/{integratedDiagnosticId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/integrated-diagnostic/{integratedDiagnosticId}
- 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/integrated-diagnostic/{integratedDiagnosticId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"code": "CODE-001",
"description": "Example description",
"extensions": {},
"isActive": true,
"name": "Example Name",
"supplierPrice": {}
}'Integrated Diagnostic replaced successfully
Practice- or vendor-specific code for the integrated diagnostic.
Example: "CODE-001"
Timestamp when this integrated diagnostic record was created.
Example: "2025-01-01T00:00:00.000Z"
Free-text description of the integrated diagnostic.
Example: "Example description"
Canonical identifier for the integrated diagnostic.
Example: "123e4567-e89b-12d3-a456-426614174000"
Whether this integrated diagnostic is active and available for use.
Example: true
Response
application/json
{ "code": "CODE-001", "createdAt": "2025-01-01T00:00:00.000Z", "description": "Example description", "extensions": {}, "integratedDiagnosticId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "name": "Example Name", "supplierPrice": {}, "updatedAt": "2025-01-01T00:00:00.000Z" }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/integrated-diagnostic/{integratedDiagnosticId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/integrated-diagnostic/{integratedDiagnosticId}
- 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/integrated-diagnostic/{integratedDiagnosticId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'