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

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

modalityIdstringrequired

Modality unique identifier (UUID)

Bodyapplication/jsonrequired
codestringrequired

Practice- or system-specific code for the modality (e.g., 'XR', 'US').

Example: "CODE-001"
descriptionstring or null

Optional description of the modality.

Example: "Example description"
extensionsobjectrequired

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Indicates whether this modality is active and can be used.

Example: true
namestringrequired

Human-readable name of the modality.

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

Responses

Modality replaced successfully

Bodyapplication/json
codestringrequired

Practice- or system-specific code for the modality (e.g., 'XR', 'US').

Example: "CODE-001"
descriptionstring or nullrequired

Optional description of the modality.

Example: "Example description"
extensionsobjectrequired

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Indicates whether this modality is active and can be used.

Example: true
modalityIdstringrequired

Canonical unique identifier for the modality.

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

Human-readable name of the modality.

Example: "Example Name"
Response
application/json
{ "code": "CODE-001", "description": "Example description", "extensions": {}, "isActive": true, "modalityId": "123e4567-e89b-12d3-a456-426614174000", "name": "Example Name" }

Request

Permanently deletes a Modality record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

modalityIdstringrequired

Modality unique identifier (UUID)

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

Responses

Modality deleted successfully

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