Fully replaces an existing Insurance. All fields must be provided.
Security
bearer
Reference to the insured animal.
Example:"123e4567-e89b-12d3-a456-426614174000"
Reference to the policy holder contact.
Example:"123e4567-e89b-12d3-a456-426614174000"
Type of coverage (accident, illness, wellness, comprehensive).
- Mock serverhttps://docs.axiomera.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/insurance/{insuranceId}
- Local Developmenthttp://localhost:8083/site/{siteId}/ahds/v1/insurance/{insuranceId}
curl -i -X PUT \
'https://docs.axiomera.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/insurance/{insuranceId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"policyNumber": "example",
"provider": {
"code": "12345",
"system": "http://example.com/codesystem",
"display": "Example Display Name"
},
"animalId": "123e4567-e89b-12d3-a456-426614174000",
"contactId": "123e4567-e89b-12d3-a456-426614174000",
"coverageType": {
"code": "12345",
"system": "http://example.com/codesystem",
"display": "Example Display Name"
},
"effectiveDate": "2025-01-01",
"expiryDate": "2025-01-01",
"isActive": true,
"extensions": {}
}'Insurance replaced successfully
Canonical unique identifier for the insurance record.
Example:"123e4567-e89b-12d3-a456-426614174000"
Reference to the insured animal.
Example:"123e4567-e89b-12d3-a456-426614174000"
Reference to the policy holder contact.
Example:"123e4567-e89b-12d3-a456-426614174000"
Type of coverage (accident, illness, wellness, comprehensive).
Date the policy becomes effective.
Example:"2025-01-01T00:00:00Z"
Timestamp when the insurance record was created.
Example:"2025-01-01T00:00:00.000Z"
Timestamp when the insurance record was last updated.
Example:"2025-01-01T00:00:00.000Z"
Response
{ "insuranceId": "123e4567-e89b-12d3-a456-426614174000", "policyNumber": "example", "provider": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "animalId": "123e4567-e89b-12d3-a456-426614174000", "contactId": "123e4567-e89b-12d3-a456-426614174000", "coverageType": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "effectiveDate": "2025-01-01T00:00:00Z", "expiryDate": "2025-01-01T00:00:00Z", "isActive": true, "createdAt": "2025-01-01T00:00:00.000Z", "updatedAt": "2025-01-01T00:00:00.000Z", "extensions": {} }