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/
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/sex
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/sex
- 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/sex?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&abbreviation=string&isActive=true&isDesexed=true&name=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/sex/{sexId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/sex/{sexId}
- 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/sex/{sexId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Sex found
Short code or abbreviation for the sex (e.g., M, F, U).
Example: "CODE-001"
Timestamp when this sex record was created.
Example: "2025-01-01T00:00:00.000Z"
Whether this sex option is active and should be available for selection.
Example: true
Indicates whether this sex classification implies desexing (e.g., neutered male).
Example: true
Human-readable name of the sex (e.g., Male, Female, Unknown).
Example: "Example Name"
Stable, opaque identifier for the sex record.
Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{ "abbreviation": "CODE-001", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "isDesexed": true, "name": "Example Name", "sexId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z" }
Bodyapplication/jsonrequired
Whether this sex option is active and should be available for selection.
Example: true
Indicates whether this sex classification implies desexing (e.g., neutered male).
Example: true
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/sex/{sexId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/sex/{sexId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/sex/{sexId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"abbreviation": "CODE-001",
"extensions": {},
"isActive": true,
"isDesexed": true,
"name": "Example Name"
}'Sex updated successfully
Short code or abbreviation for the sex (e.g., M, F, U).
Example: "CODE-001"
Timestamp when this sex record was created.
Example: "2025-01-01T00:00:00.000Z"
Whether this sex option is active and should be available for selection.
Example: true
Indicates whether this sex classification implies desexing (e.g., neutered male).
Example: true
Human-readable name of the sex (e.g., Male, Female, Unknown).
Example: "Example Name"
Stable, opaque identifier for the sex record.
Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{ "abbreviation": "CODE-001", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "isDesexed": true, "name": "Example Name", "sexId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z" }