Skip to content

AHDS Store API (1.0)

Animal Health Data Store - V1 API Documentation

Overview
Languages
Servers
Mock server

https://docs.heydonto.com/_mock/apis/animal-health/openapi/

Local Development

http://localhost:8083/

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Request

Fully replaces an existing Barcode. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

barcodeIdstringrequired

Barcode unique identifier (UUID)

Bodyapplication/jsonrequired
extensionsobjectrequired

Vendor- or practice-specific extensions.

forIdstringrequired

Identifier of the resource this barcode is associated with. Type depends on forType.

Example: "123e4567-e89b-12d3-a456-426614174000"
forTypestringrequired

Type of resource this barcode is associated with (e.g., item, batch, patient).

formatstringrequired

Barcode symbology/format (e.g., CODE128, EAN13, QR).

isActivebooleanrequired

Whether the barcode is currently active and usable.

valuestringrequired

The encoded barcode value as a string.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/barcode/{barcodeId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "extensions": {},
    "forId": "123e4567-e89b-12d3-a456-426614174000",
    "forType": "string",
    "format": "string",
    "isActive": true,
    "value": "string"
  }'

Responses

Barcode replaced successfully

Bodyapplication/json
barcodeIdstringrequired

Canonical unique identifier for the barcode.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)required

Timestamp when the barcode record was created.

Example: "2025-01-01T00:00:00.000Z"
extensionsobjectrequired

Vendor- or practice-specific extensions.

forIdstringrequired

Identifier of the resource this barcode is associated with. Type depends on forType.

Example: "123e4567-e89b-12d3-a456-426614174000"
forTypestringrequired

Type of resource this barcode is associated with (e.g., item, batch, patient).

formatstringrequired

Barcode symbology/format (e.g., CODE128, EAN13, QR).

isActivebooleanrequired

Whether the barcode is currently active and usable.

updatedAtstring(date-time)required

Timestamp when the barcode record was last updated.

Example: "2025-01-01T00:00:00.000Z"
valuestringrequired

The encoded barcode value as a string.

Response
application/json
{ "barcodeId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "forId": "123e4567-e89b-12d3-a456-426614174000", "forType": "string", "format": "string", "isActive": true, "updatedAt": "2025-01-01T00:00:00.000Z", "value": "string" }

Request

Permanently deletes a Barcode record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

barcodeIdstringrequired

Barcode unique identifier (UUID)

curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/barcode/{barcodeId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Barcode deleted successfully

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations