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
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 Operation. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

operationIdstringrequired

Operation unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstringrequired

Reference to the animal on which the operation was performed.

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

Reference to the consult associated with this operation.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this operation record is currently active.

outcomestringrequired

Free-text description of the outcome of the operation.

performedAtstringrequired

Date and time when the operation was performed.

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

Free-text details or notes about the operation.

therapeuticIdstringrequired

Reference to a therapeutic or procedure definition associated with this operation.

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

Reference to the veterinarian responsible for the operation.

Example: "123e4567-e89b-12d3-a456-426614174000"
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"
  }'

Responses

Operation replaced successfully

Bodyapplication/json
animalIdstringrequired

Reference to the animal on which the operation was performed.

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

Reference to the consult associated with this operation.

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

Timestamp when the operation record was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this operation record is currently active.

operationIdstringrequired

Canonical identifier for the operation record.

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

Free-text description of the outcome of the operation.

performedAtstring(date-time)required

Date and time when the operation was performed.

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

Free-text details or notes about the operation.

therapeuticIdstringrequired

Reference to a therapeutic or procedure definition associated with this operation.

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

Timestamp when the operation record was last updated.

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

Reference to the veterinarian responsible for the operation.

Example: "123e4567-e89b-12d3-a456-426614174000"
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" }

Request

Permanently deletes a Operation record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

operationIdstringrequired

Operation unique identifier (UUID)

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>'

Responses

Operation deleted successfully

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations