Animal Health Data Store - V1 API Documentation
AHDS Store API (1.0)
Overview
Languages
Servers
Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/
Local Development
http://localhost:8083/
Bodyapplication/jsonrequired
Identifier of the child separation, if any.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the associated contact entity, if any.
Example: "123e4567-e89b-12d3-a456-426614174000"
Human-readable name of the separation (e.g., clinic or department name).
Example: "Example Name"
Identifier of the parent separation, if any.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the primary inventory location associated with this separation.
Example: "123e4567-e89b-12d3-a456-426614174000"
High-level category of the separation (e.g., division, department).
Enum"division""department""location""other"
Example: "division"
Canonical identifier for the separation (e.g., division, department).
Example: "123e4567-e89b-12d3-a456-426614174000"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/with-primary-inventory-location
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/with-primary-inventory-location
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/with-primary-inventory-location' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"childSeparationId": "123e4567-e89b-12d3-a456-426614174000",
"contactId": "123e4567-e89b-12d3-a456-426614174000",
"extensions": {},
"isActive": true,
"name": "Example Name",
"parentSeparationId": "123e4567-e89b-12d3-a456-426614174000",
"primaryInventoryLocationId": "123e4567-e89b-12d3-a456-426614174000",
"separationCategory": "division",
"separationId": "123e4567-e89b-12d3-a456-426614174000",
"separationType": "example"
}'With Primary Inventory Location created successfully
Identifier of the child separation, if any.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the associated contact entity, if any.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the separation record was created.
Example: "2025-01-01T00:00:00.000Z"
Human-readable name of the separation (e.g., clinic or department name).
Example: "Example Name"
Identifier of the parent separation, if any.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the primary inventory location associated with this separation.
Example: "123e4567-e89b-12d3-a456-426614174000"
High-level category of the separation (e.g., division, department).
Enum"division""department""location""other"
Example: "division"
Canonical identifier for the separation (e.g., division, department).
Example: "123e4567-e89b-12d3-a456-426614174000"
Free-text type or classification of the separation as used in the source system.
Example: "example"
Response
application/json
{ "childSeparationId": "123e4567-e89b-12d3-a456-426614174000", "contactId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "name": "Example Name", "parentSeparationId": "123e4567-e89b-12d3-a456-426614174000", "primaryInventoryLocationId": "123e4567-e89b-12d3-a456-426614174000", "separationCategory": "division", "separationId": "123e4567-e89b-12d3-a456-426614174000", "separationType": "example", "updatedAt": "2025-01-01T00:00:00.000Z" }
Query
Identifier of the child separation, if any.
Example: childSeparationId=123e4567-e89b-12d3-a456-426614174000
Identifier of the associated contact entity, if any.
Example: contactId=123e4567-e89b-12d3-a456-426614174000
Identifier of the parent separation, if any.
Example: parentSeparationId=123e4567-e89b-12d3-a456-426614174000
Identifier of the primary inventory location associated with this separation.
Example: primaryInventoryLocationId=123e4567-e89b-12d3-a456-426614174000
High-level category of the separation (e.g., division, department).
Enum"division""department""location""other"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/with-primary-inventory-location
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/with-primary-inventory-location
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/with-primary-inventory-location?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&childSeparationId=123e4567-e89b-12d3-a456-426614174000&contactId=123e4567-e89b-12d3-a456-426614174000&isActive=true&name=string&parentSeparationId=123e4567-e89b-12d3-a456-426614174000&primaryInventoryLocationId=123e4567-e89b-12d3-a456-426614174000&separationCategory=division&separationType=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/with-primary-inventory-location/{separationId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/with-primary-inventory-location/{separationId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/with-primary-inventory-location/{separationId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'With Primary Inventory Location found
Identifier of the child separation, if any.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the associated contact entity, if any.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the separation record was created.
Example: "2025-01-01T00:00:00.000Z"
Human-readable name of the separation (e.g., clinic or department name).
Example: "Example Name"
Identifier of the parent separation, if any.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the primary inventory location associated with this separation.
Example: "123e4567-e89b-12d3-a456-426614174000"
High-level category of the separation (e.g., division, department).
Enum"division""department""location""other"
Example: "division"
Canonical identifier for the separation (e.g., division, department).
Example: "123e4567-e89b-12d3-a456-426614174000"
Free-text type or classification of the separation as used in the source system.
Example: "example"
Response
application/json
{ "childSeparationId": "123e4567-e89b-12d3-a456-426614174000", "contactId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "name": "Example Name", "parentSeparationId": "123e4567-e89b-12d3-a456-426614174000", "primaryInventoryLocationId": "123e4567-e89b-12d3-a456-426614174000", "separationCategory": "division", "separationId": "123e4567-e89b-12d3-a456-426614174000", "separationType": "example", "updatedAt": "2025-01-01T00:00:00.000Z" }