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

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
extensionsobject

Vendor- or practice-specific extensions.

systemSettingIdstring

Canonical identifier for this system setting record.

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

System timezone configuration.

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

Responses

System Setting created successfully

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when this setting record was created.

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

Vendor- or practice-specific extensions.

systemSettingIdstringrequired

Canonical identifier for this system setting record.

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

System timezone configuration.

updatedAtstring(date-time)required

Timestamp when this setting record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "systemSettingId": "123e4567-e89b-12d3-a456-426614174000", "timezone": {}, "updatedAt": "2025-01-01T00:00:00.000Z" }

Request

Returns a paginated list of System Settings 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"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/system-setting?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of System Settings

Request

Returns a single System Setting by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

systemSettingIdstringrequired

System Setting unique identifier (UUID)

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

Responses

System Setting found

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when this setting record was created.

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

Vendor- or practice-specific extensions.

systemSettingIdstringrequired

Canonical identifier for this system setting record.

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

System timezone configuration.

updatedAtstring(date-time)required

Timestamp when this setting record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "systemSettingId": "123e4567-e89b-12d3-a456-426614174000", "timezone": {}, "updatedAt": "2025-01-01T00:00:00.000Z" }
Operations
Operations
Operations
Operations