Skip to content

Record service recovery

POST
/v1/actions/hospitality.action.record_service_recovery/apply
curl --request POST \
--url https://api.aerandil.com/v1/actions/hospitality.action.record_service_recovery/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "comp_amount": { "amount": "example", "currency": "example" }, "comp_authority_snapshot": { "comp_categories_allowed_at_recovery": [ "room_night" ], "flat_universal_per_incident_limit_at_recovery": { "amount": "example", "currency": "example" }, "per_incident_limit_at_recovery": { "amount": "example", "currency": "example" }, "per_shift_cumulative_at_recovery": { "amount": "example", "currency": "example" }, "policy_kind_at_recovery": "example", "role_code_at_recovery": "example" }, "comp_category": "room_night", "failure_category": "staff_interaction", "failure_subject_text": "example", "follow_up_due_at": "2026-04-15T12:00:00Z", "happened_at": "2026-04-15T12:00:00Z", "interactional_quality": "failed", "person_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "recovery_action_category": "apology_only", "recovery_authoriser": "example", "recovery_process_stages_completed": [ "aware" ], "severity": "minor", "time_to_first_response_seconds": 1, "time_to_resolution_seconds": 1 }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.venue" } }'

Log a service-recovery event against the target venue. The comp_authority_snapshot freezes the toolkit’s role rules at recovery time so a later toolkit edit doesn’t retroactively re-evaluate authorisation. Soft validators warn on over-limit comp but never block — over-limit recoveries are the data the operator most needs and would otherwise hide.

Effects: create hospitality.service_recovery_event; link hospitality.link.recovery_event_for_person; link hospitality.link.recovery_event_in_venue.

Media typeapplication/json
object
branch

Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).

string format: uuid
params
required
object
comp_amount
Comp amount
object
amount
required
string format: decimal
currency
required
string format: iso-4217
comp_authority_snapshot
required
Frozen comp authority snapshot
object
comp_categories_allowed_at_recovery
Array<string>
Allowed values: room_night food_beverage spa retail parking other
flat_universal_per_incident_limit_at_recovery
object
amount
required
string format: decimal
currency
required
string format: iso-4217
per_incident_limit_at_recovery
object
amount
required
string format: decimal
currency
required
string format: iso-4217
per_shift_cumulative_at_recovery
object
amount
required
string format: decimal
currency
required
string format: iso-4217
policy_kind_at_recovery
required
string
role_code_at_recovery
string
comp_category
Comp category
string
Allowed values: room_night food_beverage spa retail parking other
failure_category
required
Failure category
string
Allowed values: staff_interaction room_condition fnb_quality fnb_service_pace billing allergy_dietary security_safety check_in_out maintenance recognition_failure anticipation_miss noise temperature other
failure_subject_text
required
What went wrong
string
follow_up_due_at
Follow-up due
string format: date-time
happened_at
required
When the failure happened
string format: date-time
interactional_quality
How the recovery landed
string
Allowed values: failed adequate genuine excellent
person_id
required
Person who experienced the failure
string format: uuid
recovery_action_category
required
Recovery action category
string
Allowed values: apology_only apology_plus_gesture apology_plus_comp apology_plus_upgrade complaint_handling_only gesture_declined_with_dignity escalated_unresolved
recovery_authoriser
required
Authoriser principal identifier
string
recovery_process_stages_completed
required
USHG 5 As stages completed
Array<string>
Allowed values: aware acknowledge apologise act additional_generosity
severity
required
Severity
string
Allowed values: minor moderate significant severe safety_health
time_to_first_response_seconds
Seconds until first response
integer
time_to_resolution_seconds
Seconds until resolved
integer
return_modified

When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.

boolean
target
required
object
id
required
string format: uuid
object_type
required
Allowed value: hospitality.venue

Action applied. modified_objects and modified_links populated when return_modified: true was supplied.

Media typeapplication/json
ApplyActionResponse

Envelope returned by the Aerandil action engine. correlation_id ties every event emitted by this invocation; modified_objects and modified_links project the events the handler emitted (per the action’s declared effects); warnings carries any non-blocking soft-validator observations.

object
correlation_id
required

Per-invocation correlation id; matches events.correlation_id for every event this action appended.

string format: uuid
modified_links
required

Links established or removed by this invocation. Empty when the caller did not request return_modified.

Array<object>
object
from_id
required
string format: uuid
from_type
required
string
kind
required
Allowed values: linked
link_type
required
Allowed values: hospitality.link.recovery_event_for_person hospitality.link.recovery_event_in_venue
to_id
required
string format: uuid
to_type
required
string
modified_objects
required

Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.

Array<object>
object
id
required
string format: uuid
kind
required
Allowed values: created
object_type
required
Allowed values: hospitality.service_recovery_event
warnings

Non-blocking soft-validator observations emitted during this invocation (e.g. comp-authority over-limit, recipe pour-cost over sell-price). Absent when no warnings were emitted.

Array<object>
object
message
required

Human-readable summary, suitable for logging or operator-UI surfacing.

string
object_type
required

Object type the warning was raised against.

string
property

Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.

string
rule
required

Stable kebab-case rule identifier (e.g. comp-authority-over-limit).

string
Example
{
"modified_links": [
{
"kind": "linked",
"link_type": "hospitality.link.recovery_event_for_person"
}
],
"modified_objects": [
{
"kind": "created",
"object_type": "hospitality.service_recovery_event"
}
]
}

Conflict — concurrent modification or unique constraint violation.

Validation error — parameter validation or business-rule violation.