Delete integrated diagnostic

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

Responses

Integrated Diagnostic created successfully

Bodyapplication/json

codestringrequired

Practice- or vendor-specific code for the integrated diagnostic.

createdAtstring(date-time)required

Timestamp when this integrated diagnostic record was created.

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

descriptionstringrequired

Free-text description of the integrated diagnostic.

extensionsobjectrequired

Vendor- or practice-specific extensions.

integratedDiagnosticIdstringrequired

Canonical identifier for the integrated diagnostic.

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

isActivebooleanrequired

Whether this integrated diagnostic is active and available for use.

namestringrequired

Human-readable name of the integrated diagnostic.

supplierPriceobjectrequired

Supplier price for this diagnostic.

updatedAtstring(date-time)required

Timestamp when this integrated diagnostic record was last updated.

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

Response

application/json

{
  "code": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "integratedDiagnosticId": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "name": "string",
  "supplierPrice": {},
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

List integrated diagnostics

Request

Returns a paginated list of Integrated Diagnostics 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""code""description""name"

sortOrderstring

Sort order

Default "asc"

Enum"asc""desc"

codestring

Practice- or vendor-specific code for the integrated diagnostic.

descriptionstring

Free-text description of the integrated diagnostic.

isActiveboolean

Whether this integrated diagnostic is active and available for use.

namestring

Human-readable name of the integrated diagnostic.

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/integrated-diagnostic?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&code=string&description=string&isActive=true&name=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Integrated Diagnostics

Get integrated diagnostic

Request

Returns a single Integrated Diagnostic by its unique identifier.

Security

bearer

Path

siteIdnumberrequired

Site identifier

integratedDiagnosticIdstringrequired

Integrated Diagnostic unique identifier (UUID)

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

Responses

Integrated Diagnostic found

Bodyapplication/json

codestringrequired

Practice- or vendor-specific code for the integrated diagnostic.

createdAtstring(date-time)required

Timestamp when this integrated diagnostic record was created.

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

descriptionstringrequired

Free-text description of the integrated diagnostic.

extensionsobjectrequired

Vendor- or practice-specific extensions.

integratedDiagnosticIdstringrequired

Canonical identifier for the integrated diagnostic.

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

isActivebooleanrequired

Whether this integrated diagnostic is active and available for use.

namestringrequired

Human-readable name of the integrated diagnostic.

supplierPriceobjectrequired

Supplier price for this diagnostic.

updatedAtstring(date-time)required

Timestamp when this integrated diagnostic record was last updated.

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

Response

application/json

{
  "code": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "integratedDiagnosticId": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "name": "string",
  "supplierPrice": {},
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Update integrated diagnostic

Request

Partially updates an existing Integrated Diagnostic. Only provided fields will be updated.

Security

bearer

Path

siteIdnumberrequired

Site identifier

integratedDiagnosticIdstringrequired

Integrated Diagnostic unique identifier (UUID)

Bodyapplication/jsonrequired

codestring

Practice- or vendor-specific code for the integrated diagnostic.

descriptionstring

Free-text description of the integrated diagnostic.

extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Whether this integrated diagnostic is active and available for use.

namestring

Human-readable name of the integrated diagnostic.

supplierPriceobject

Supplier price for this diagnostic.

curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/integrated-diagnostic/{integratedDiagnosticId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string",
    "description": "string",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "supplierPrice": {}
  }'

Responses

Integrated Diagnostic updated successfully

Bodyapplication/json

codestringrequired

Practice- or vendor-specific code for the integrated diagnostic.

createdAtstring(date-time)required

Timestamp when this integrated diagnostic record was created.

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

descriptionstringrequired

Free-text description of the integrated diagnostic.

extensionsobjectrequired

Vendor- or practice-specific extensions.

integratedDiagnosticIdstringrequired

Canonical identifier for the integrated diagnostic.

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

isActivebooleanrequired

Whether this integrated diagnostic is active and available for use.

namestringrequired

Human-readable name of the integrated diagnostic.

supplierPriceobjectrequired

Supplier price for this diagnostic.

updatedAtstring(date-time)required

Timestamp when this integrated diagnostic record was last updated.

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

Response

application/json

{
  "code": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "integratedDiagnosticId": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "name": "string",
  "supplierPrice": {},
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Replace integrated diagnostic

Request

Fully replaces an existing Integrated Diagnostic. All fields must be provided.

Security

bearer

Path

siteIdnumberrequired

Site identifier

integratedDiagnosticIdstringrequired

Integrated Diagnostic unique identifier (UUID)

Bodyapplication/jsonrequired

codestringrequired

Practice- or vendor-specific code for the integrated diagnostic.

descriptionstringrequired

Free-text description of the integrated diagnostic.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this integrated diagnostic is active and available for use.

namestringrequired

Human-readable name of the integrated diagnostic.

supplierPriceobjectrequired

Supplier price for this diagnostic.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/integrated-diagnostic/{integratedDiagnosticId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string",
    "description": "string",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "supplierPrice": {}
  }'

Responses

Integrated Diagnostic replaced successfully

Bodyapplication/json

codestringrequired

Practice- or vendor-specific code for the integrated diagnostic.

createdAtstring(date-time)required

Timestamp when this integrated diagnostic record was created.

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

descriptionstringrequired

Free-text description of the integrated diagnostic.

extensionsobjectrequired

Vendor- or practice-specific extensions.

integratedDiagnosticIdstringrequired

Canonical identifier for the integrated diagnostic.

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

isActivebooleanrequired

Whether this integrated diagnostic is active and available for use.

namestringrequired

Human-readable name of the integrated diagnostic.

supplierPriceobjectrequired

Supplier price for this diagnostic.

updatedAtstring(date-time)required

Timestamp when this integrated diagnostic record was last updated.

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

Response

application/json

{
  "code": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "integratedDiagnosticId": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "name": "string",
  "supplierPrice": {},
  "updatedAt": "2025-01-01T00:00:00.000Z"
}