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

Request

Creates a new Presentingproblem record. Presentingproblem resource in the Animal Health Data Store

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
extensionsobject

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this presenting problem is active and can be selected in workflows.

namestringrequired

Human-readable name/label of the presenting problem.

presentingproblemIdstring

Canonical identifier for the presenting problem.

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

Responses

Presentingproblem created successfully

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when this presenting problem record was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this presenting problem is active and can be selected in workflows.

namestringrequired

Human-readable name/label of the presenting problem.

presentingproblemIdstringrequired

Canonical identifier for the presenting problem.

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

Timestamp when this presenting problem record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "name": "string", "presentingproblemId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z" }

Request

Returns a paginated list of Presentingproblems 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"
isActiveboolean

Whether this presenting problem is active and can be selected in workflows.

namestring

Human-readable name/label of the presenting problem.

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

Responses

Paginated list of Presentingproblems

Request

Returns a single Presentingproblem by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

presentingproblemIdstringrequired

Presentingproblem unique identifier (UUID)

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

Responses

Presentingproblem found

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when this presenting problem record was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this presenting problem is active and can be selected in workflows.

namestringrequired

Human-readable name/label of the presenting problem.

presentingproblemIdstringrequired

Canonical identifier for the presenting problem.

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

Timestamp when this presenting problem record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "name": "string", "presentingproblemId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z" }
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