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
Operations
Operations
Operations
Operations

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

tagnameIdstringrequired

Tagname unique identifier (UUID)

Bodyapplication/jsonrequired
categoryIdstringrequired

Identifier of the category this tag belongs to.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the tag is currently active and usable.

namestringrequired

Human-readable name of the tag.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/tagname/{tagnameId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "categoryId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "name": "string"
  }'

Responses

Tagname replaced successfully

Bodyapplication/json
categoryIdstringrequired

Identifier of the category this tag belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)required

Timestamp when the tag was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the tag is currently active and usable.

namestringrequired

Human-readable name of the tag.

tagnameIdstringrequired

Canonical identifier for the tagname.

Example: "123e4567-e89b-12d3-a456-426614174000"
updatedAtstring(date-time)required

Timestamp when the tag was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "categoryId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "name": "string", "tagnameId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z" }

Request

Permanently deletes a Tagname record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

tagnameIdstringrequired

Tagname unique identifier (UUID)

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

Responses

Tagname deleted successfully

Operations