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

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

facilityIdstringrequired

Facility unique identifier (UUID)

Bodyapplication/jsonrequired
namestringrequired

Human-readable name of the facility.

Example: "Example Name"
facilityTypeobjectrequired
facilityType.​codestringrequired

Code value

Example: "12345"
facilityType.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
facilityType.​displaystring

Human-readable display

Example: "Example Display Name"
addressobjectrequired

Physical address of the facility.

phonestringrequired

Primary contact phone number.

Example: "example"
emailstringrequired

Primary contact email.

Example: "user@example.com"
isActivebooleanrequired

Whether the facility is currently operational.

Example: true
extensionsobjectrequired

Vendor- or practice-specific extensions.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/facility/{facilityId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Example Name",
    "facilityType": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    },
    "address": {},
    "phone": "example",
    "email": "user@example.com",
    "isActive": true,
    "extensions": {}
  }'

Responses

Facility replaced successfully

Bodyapplication/json
facilityIdstringrequired

Canonical unique identifier for the facility.

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

Human-readable name of the facility.

Example: "Example Name"
facilityTypeobjectrequired
facilityType.​codestringrequired

Code value

Example: "12345"
facilityType.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
facilityType.​displaystring

Human-readable display

Example: "Example Display Name"
addressobjectrequired

Physical address of the facility.

phonestringrequired

Primary contact phone number.

Example: "example"
emailstringrequired

Primary contact email.

Example: "user@example.com"
isActivebooleanrequired

Whether the facility is currently operational.

Example: true
createdAtstring(date-time)required

Timestamp when the facility record was created.

Example: "2025-01-01T00:00:00.000Z"
updatedAtstring(date-time)required

Timestamp when the facility record was last updated.

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

Vendor- or practice-specific extensions.

Response
application/json
{ "facilityId": "123e4567-e89b-12d3-a456-426614174000", "name": "Example Name", "facilityType": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "address": {}, "phone": "example", "email": "user@example.com", "isActive": true, "createdAt": "2025-01-01T00:00:00.000Z", "updatedAt": "2025-01-01T00:00:00.000Z", "extensions": {} }

Request

Permanently deletes a Facility record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

facilityIdstringrequired

Facility unique identifier (UUID)

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

Responses

Facility deleted successfully

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations