Delete operation

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/operation' \
  -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,
    "operationId": "123e4567-e89b-12d3-a456-426614174000",
    "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 created 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"
}

List operations

Request

Returns a paginated list of Operations for the specified site. Supports filtering and sorting.

Security

bearer

Path

siteIdnumberrequired

Site identifier

Query

pagenumber>= 0

Page number (0-indexed)

Default 0

pageSizenumber[ 1 .. 100 ]

Number of items per page

Default 10

sortBystring

Field to sort by

Enum"createdAt""updatedAt""outcome""performedAt""specifics"

sortOrderstring

Sort order

Default "asc"

Enum"asc""desc"

animalIdstring

Reference to the animal on which the operation was performed.

Example: animalId=123e4567-e89b-12d3-a456-426614174000

consultIdstring

Reference to the consult associated with this operation.

Example: consultId=123e4567-e89b-12d3-a456-426614174000

isActiveboolean

Whether this operation record is currently active.

outcomestring

Free-text description of the outcome of the operation.

specificsstring

Free-text details or notes about the operation.

therapeuticIdstring

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

Example: therapeuticId=123e4567-e89b-12d3-a456-426614174000

vetIdstring

Reference to the veterinarian responsible for the operation.

Example: vetId=123e4567-e89b-12d3-a456-426614174000

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/operation?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&animalId=123e4567-e89b-12d3-a456-426614174000&consultId=123e4567-e89b-12d3-a456-426614174000&isActive=true&outcome=string&specifics=string&therapeuticId=123e4567-e89b-12d3-a456-426614174000&vetId=123e4567-e89b-12d3-a456-426614174000' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Operations

Get operation

Request

Returns a single Operation by its unique identifier.

Security

bearer

Path

siteIdnumberrequired

Site identifier

operationIdstringrequired

Operation unique identifier (UUID)

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

Responses

Operation found

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"
}

Update operation

Request

Partially updates an existing Operation. Only provided fields will be updated.

Security

bearer

Path

siteIdnumberrequired

Site identifier

operationIdstringrequired

Operation unique identifier (UUID)

Bodyapplication/jsonrequired

animalIdstring

Reference to the animal on which the operation was performed.

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

consultIdstring

Reference to the consult associated with this operation.

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

extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Whether this operation record is currently active.

outcomestring

Free-text description of the outcome of the operation.

performedAtstring

Date and time when the operation was performed.

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

specificsstring

Free-text details or notes about the operation.

therapeuticIdstring

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

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

vetIdstring

Reference to the veterinarian responsible for the operation.

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

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

Responses

Operation updated 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"
}

Replace operation

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"
}