Skip to content
aerandil.com
GitHub

Validate Record service recovery (dry-run)

POST
/v1/actions/hospitality.action.record_service_recovery/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.record_service_recovery/validate \
  --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" } }'

Dry-run of apply_hospitality_action_record_service_recovery’s parameter checks. No side effects, no idempotency reservation, no handler dispatch — just the schema pass plus action-level shape (target presence, target type, unknown-parameter rejection). return_modified is meaningless here and ignored.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
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

Responses

Section titled “Responses”

200

Section titled “200”

Validation outcome. result is valid or invalid; per-parameter diagnostics are always populated for every declared parameter so a UI can render the action’s full surface.

Media typeapplication/json
object
action
required
string
errors

Action-level errors not tied to a single parameter (missing target, target type mismatch, unknown parameter names). Absent when empty.

Array<string>
parameters
required

Per-parameter diagnostics keyed by api_name.

object
key
additional properties
object
errors
Array<string>
result
required
Allowed values: valid invalid
value
required

The serialised value the server interpreted, or null if the parameter was not supplied.

result
required
Allowed values: valid invalid
Example
{
  "parameters": {
    "additionalProperty": {
      "result": "valid"
    }
  },
  "result": "valid"
}