Replace therapeutic

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/therapeutic' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "defaultTemplateId": "123e4567-e89b-12d3-a456-426614174000",
    "departmentIds": [
      "string"
    ],
    "extensions": {},
    "isActive": true,
    "name": "string",
    "therapeuticId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Therapeutic created successfully

Bodyapplication/json

createdAtstring(date-time)required

Timestamp when the therapeutic was created.

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

defaultTemplateIdstringrequired

Identifier of the default template associated with this therapeutic, if any.

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

departmentIdsArray of stringsrequired

Departments with which this therapeutic is associated.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the therapeutic is active and available for use.

namestringrequired

Human-readable name of the therapeutic.

therapeuticIdstringrequired

Canonical unique identifier for the therapeutic.

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

updatedAtstring(date-time)required

Timestamp when the therapeutic was last updated.

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

Response

application/json

{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "defaultTemplateId": "123e4567-e89b-12d3-a456-426614174000",
  "departmentIds": [
    "string"
  ],
  "extensions": {},
  "isActive": true,
  "name": "string",
  "therapeuticId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

List therapeutics

Request

Returns a paginated list of Therapeutics 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""name"

sortOrderstring

Sort order

Default "asc"

Enum"asc""desc"

defaultTemplateIdstring

Identifier of the default template associated with this therapeutic, if any.

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

isActiveboolean

Whether the therapeutic is active and available for use.

namestring

Human-readable name of the therapeutic.

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

Responses

Paginated list of Therapeutics

Get therapeutic

Request

Returns a single Therapeutic by its unique identifier.

Security

bearer

Path

siteIdnumberrequired

Site identifier

therapeuticIdstringrequired

Therapeutic unique identifier (UUID)

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

Responses

Therapeutic found

Bodyapplication/json

createdAtstring(date-time)required

Timestamp when the therapeutic was created.

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

defaultTemplateIdstringrequired

Identifier of the default template associated with this therapeutic, if any.

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

departmentIdsArray of stringsrequired

Departments with which this therapeutic is associated.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the therapeutic is active and available for use.

namestringrequired

Human-readable name of the therapeutic.

therapeuticIdstringrequired

Canonical unique identifier for the therapeutic.

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

updatedAtstring(date-time)required

Timestamp when the therapeutic was last updated.

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

Response

application/json

{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "defaultTemplateId": "123e4567-e89b-12d3-a456-426614174000",
  "departmentIds": [
    "string"
  ],
  "extensions": {},
  "isActive": true,
  "name": "string",
  "therapeuticId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Update therapeutic

Request

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

Security

bearer

Path

siteIdnumberrequired

Site identifier

therapeuticIdstringrequired

Therapeutic unique identifier (UUID)

Bodyapplication/jsonrequired

defaultTemplateIdstring

Identifier of the default template associated with this therapeutic, if any.

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

departmentIdsArray of strings

Departments with which this therapeutic is associated.

extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Whether the therapeutic is active and available for use.

namestring

Human-readable name of the therapeutic.

curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/therapeutic/{therapeuticId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "defaultTemplateId": "123e4567-e89b-12d3-a456-426614174000",
    "departmentIds": [
      "string"
    ],
    "extensions": {},
    "isActive": true,
    "name": "string"
  }'

Responses

Therapeutic updated successfully

Bodyapplication/json

createdAtstring(date-time)required

Timestamp when the therapeutic was created.

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

defaultTemplateIdstringrequired

Identifier of the default template associated with this therapeutic, if any.

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

departmentIdsArray of stringsrequired

Departments with which this therapeutic is associated.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the therapeutic is active and available for use.

namestringrequired

Human-readable name of the therapeutic.

therapeuticIdstringrequired

Canonical unique identifier for the therapeutic.

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

updatedAtstring(date-time)required

Timestamp when the therapeutic was last updated.

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

Response

application/json

{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "defaultTemplateId": "123e4567-e89b-12d3-a456-426614174000",
  "departmentIds": [
    "string"
  ],
  "extensions": {},
  "isActive": true,
  "name": "string",
  "therapeuticId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}