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

Request

Fully replaces an existing Site Information. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

siteInformationIdstringrequired

Site Information unique identifier (UUID)

Bodyapplication/jsonrequired
extensionsobjectrequired

Vendor- or practice-specific extensions to the canonical SiteInformation resource.

practiceTypestringrequired

Free-text description of the practice type.

prefixstringrequired

Short code or subdomain prefix used to identify the site in URLs or integrations.

timezoneobjectrequired

Timezone configuration for the site.

versionnumberrequired

System or schema version associated with the site.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/site-information/{siteInformationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "extensions": {},
    "practiceType": "string",
    "prefix": "string",
    "timezone": {},
    "version": 0
  }'

Responses

Site Information replaced successfully

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when the site record was created in the AHDS system.

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

Vendor- or practice-specific extensions to the canonical SiteInformation resource.

practiceTypestringrequired

Free-text description of the practice type.

prefixstringrequired

Short code or subdomain prefix used to identify the site in URLs or integrations.

siteInformationIdstringrequired

Canonical identifier for the site.g. 'site_jkjBWPng4gFTqRxYkomWU').

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

Timezone configuration for the site.

updatedAtstring(date-time)required

Timestamp when the site record was last updated in the AHDS system.

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

System or schema version associated with the site.

Response
application/json
{ "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "practiceType": "string", "prefix": "string", "siteInformationId": "123e4567-e89b-12d3-a456-426614174000", "timezone": {}, "updatedAt": "2025-01-01T00:00:00.000Z", "version": 0 }

Request

Permanently deletes a Site Information record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

siteInformationIdstringrequired

Site Information unique identifier (UUID)

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

Responses

Site Information deleted successfully

Operations
Operations
Operations
Operations
Operations