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
Canonical unique identifier for the barcode.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the resource this barcode is associated with. Type depends on forType.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type of resource this barcode is associated with (e.g., item, batch, patient).
Example: "CODE-001"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/barcode
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/barcode
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/barcode' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"barcodeId": "123e4567-e89b-12d3-a456-426614174000",
"extensions": {},
"forId": "123e4567-e89b-12d3-a456-426614174000",
"forType": "CODE-001",
"format": "CODE-001",
"isActive": true,
"value": "CODE-001"
}'Barcode created successfully
Canonical unique identifier for the barcode.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the barcode record was created.
Example: "2025-01-01T00:00:00.000Z"
Identifier of the resource this barcode is associated with. Type depends on forType.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type of resource this barcode is associated with (e.g., item, batch, patient).
Example: "CODE-001"
Timestamp when the barcode record was last updated.
Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "barcodeId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "forId": "123e4567-e89b-12d3-a456-426614174000", "forType": "CODE-001", "format": "CODE-001", "isActive": true, "updatedAt": "2025-01-01T00:00:00.000Z", "value": "CODE-001" }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/barcode
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/barcode
- 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/barcode?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&forId=123e4567-e89b-12d3-a456-426614174000&forType=string&format=string&isActive=true&value=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/barcode/{barcodeId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/barcode/{barcodeId}
- 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/barcode/{barcodeId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Barcode found
Canonical unique identifier for the barcode.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the barcode record was created.
Example: "2025-01-01T00:00:00.000Z"
Identifier of the resource this barcode is associated with. Type depends on forType.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type of resource this barcode is associated with (e.g., item, batch, patient).
Example: "CODE-001"
Timestamp when the barcode record was last updated.
Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "barcodeId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "forId": "123e4567-e89b-12d3-a456-426614174000", "forType": "CODE-001", "format": "CODE-001", "isActive": true, "updatedAt": "2025-01-01T00:00:00.000Z", "value": "CODE-001" }