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

Request

Fully replaces an existing Eventgroup. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

eventgroupIdstringrequired

Eventgroup unique identifier (UUID)

Bodyapplication/jsonrequired
categorystringrequired

High-level category or type of event group (e.g., workflow, reminder-set, campaign).

descriptionstringrequired

Detailed description of the event group.

extensionsobjectrequired

Vendor- or practice-specific extensions.

locationIdstringrequired

Primary location associated with this event group, if applicable.

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

Human-readable name or label for the event group.

organizationIdstringrequired

Owning organization or practice for this event group.

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

Lifecycle status of the event group.

Enum"active""inactive""archived"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/eventgroup/{eventgroupId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "category": "string",
    "description": "string",
    "extensions": {},
    "locationId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "string",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "active"
  }'

Responses

Eventgroup replaced successfully

Bodyapplication/json
categorystringrequired

High-level category or type of event group (e.g., workflow, reminder-set, campaign).

createdAtstring(date-time)required

Timestamp when the event group was created.

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

Detailed description of the event group.

eventgroupIdstringrequired

Stable, opaque identifier for the event group.

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

Vendor- or practice-specific extensions.

locationIdstringrequired

Primary location associated with this event group, if applicable.

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

Human-readable name or label for the event group.

organizationIdstringrequired

Owning organization or practice for this event group.

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

Lifecycle status of the event group.

Enum"active""inactive""archived"
updatedAtstring(date-time)required

Timestamp when the event group was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "category": "string", "createdAt": "2025-01-01T00:00:00.000Z", "description": "string", "eventgroupId": "123e4567-e89b-12d3-a456-426614174000", "extensions": {}, "locationId": "123e4567-e89b-12d3-a456-426614174000", "name": "string", "organizationId": "123e4567-e89b-12d3-a456-426614174000", "status": "active", "updatedAt": "2025-01-01T00:00:00.000Z" }

Request

Permanently deletes a Eventgroup record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

eventgroupIdstringrequired

Eventgroup unique identifier (UUID)

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

Responses

Eventgroup deleted successfully

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations