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

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

userIdstringrequired

User unique identifier (UUID)

Bodyapplication/jsonrequired
codestringrequired

Practice-specific short code or identifier for the user.

displayNamestringrequired

Human-readable display name for the user.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the user is active and can be used in workflows.

isSalespersonbooleanrequired

Whether the user is a salesperson.

isVeterinarianbooleanrequired

Whether the user is a veterinarian.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/user/{userId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string",
    "displayName": "string",
    "extensions": {},
    "isActive": true,
    "isSalesperson": true,
    "isVeterinarian": true
  }'

Responses

User replaced successfully

Bodyapplication/json
codestringrequired

Practice-specific short code or identifier for the user.

createdAtstring(date-time)required

Timestamp when the user record was created.

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

Human-readable display name for the user.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the user is active and can be used in workflows.

isSalespersonbooleanrequired

Whether the user is a salesperson.

isVeterinarianbooleanrequired

Whether the user is a veterinarian.

updatedAtstring(date-time)required

Timestamp when the user record was last updated.

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

Canonical unique identifier for the user.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{ "code": "string", "createdAt": "2025-01-01T00:00:00.000Z", "displayName": "string", "extensions": {}, "isActive": true, "isSalesperson": true, "isVeterinarian": true, "updatedAt": "2025-01-01T00:00:00.000Z", "userId": "123e4567-e89b-12d3-a456-426614174000" }

Request

Permanently deletes a User record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

userIdstringrequired

User unique identifier (UUID)

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

Responses

User deleted successfully

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