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
Short code or subdomain prefix used to identify the site in URLs or integrations.
Canonical identifier for the site.g. 'site_jkjBWPng4gFTqRxYkomWU').
Example: "123e4567-e89b-12d3-a456-426614174000"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/site-information
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/site-information
- 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/site-information' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"extensions": {},
"practiceType": "string",
"prefix": "string",
"siteInformationId": "123e4567-e89b-12d3-a456-426614174000",
"timezone": {},
"version": 0
}'Site Information created successfully
Timestamp when the site record was created in the AHDS system.
Example: "2025-01-01T00:00:00.000Z"
Vendor- or practice-specific extensions to the canonical SiteInformation resource.
Short code or subdomain prefix used to identify the site in URLs or integrations.
Canonical identifier for the site.g. 'site_jkjBWPng4gFTqRxYkomWU').
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the site record was last updated in the AHDS system.
Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "practiceType": "string", "prefix": "string", "siteInformationId": "123e4567-e89b-12d3-a456-426614174000", "timezone": {}, "updatedAt": "2025-01-01T00:00:00.000Z", "version": 0 }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/site-information
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/site-information
- 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/site-information?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&practiceType=string&prefix=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/site-information/{siteInformationId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/site-information/{siteInformationId}
- 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/site-information/{siteInformationId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Site Information found
Timestamp when the site record was created in the AHDS system.
Example: "2025-01-01T00:00:00.000Z"
Vendor- or practice-specific extensions to the canonical SiteInformation resource.
Short code or subdomain prefix used to identify the site in URLs or integrations.
Canonical identifier for the site.g. 'site_jkjBWPng4gFTqRxYkomWU').
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the site record was last updated in the AHDS system.
Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "practiceType": "string", "prefix": "string", "siteInformationId": "123e4567-e89b-12d3-a456-426614174000", "timezone": {}, "updatedAt": "2025-01-01T00:00:00.000Z", "version": 0 }