Preview Waitlist reservation request (dry-run)

POST

/v1/actions/hospitality.action.waitlist_reservation_request/preview

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.waitlist_reservation_request/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "adults": 1, "arrival_date": "2026-04-15", "children": 1, "departure_date": "2026-04-15", "guest_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "notes": "example", "priority": "high", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "quoted_rate": { "amount": "example", "currency": "example" }, "rate_plan_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "reason": "sold_out", "requested_at": "2026-04-15T12:00:00Z", "room_type_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "telephone": "example" }, "return_modified": false }'

• Production API

Scenario preview of apply_hospitality_action_waitlist_reservation_request — runs the action exactly as apply would (validation, handler dispatch, modified-object projection, commit-time cross-link validation) then rolls the transaction back. Returns the modified_objects / modified_links / warnings the apply would have produced without persisting anything or firing any outward effect. Requires the same actions:hospitality.action.waitlist_reservation_request:apply scope as apply. No Idempotency-Key.

Authorizations

• aerandil_oauth

Request Body^required

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

adults

required

Adults

integer

arrival_date

required

Requested arrival

string format: date

children

Children

integer

departure_date

required

Requested departure

string format: date

guest_id

required

Guest

string format: uuid

notes

Desk notes on the request

string

priority

Priority tier (defaults to normal; FIFO applies within a tier)

string

Allowed values: high normal low

property_id

required

Property

string format: uuid

quoted_rate

Rate quoted when the request was taken (indicative only)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

rate_plan_id

required

Rate plan quoted against

string format: uuid

reason

required

Why the request could not be booked

string

Allowed values: sold_out room_type_unavailable rate_unavailable restriction guest_request

requested_at

When the guest asked (defaults to now; must not be in the future)

string format: date-time

room_type_id

required

Room type asked for

string format: uuid

telephone

Number to call when the room frees

string

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

Responses

200

Preview computed and rolled back. modified_objects and modified_links carry the effect set the apply would produce; preview is always true.

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.waitlist_entry_for_property hospitality.link.waitlist_entry_for_guest hospitality.link.waitlist_entry_for_room_type hospitality.link.waitlist_entry_for_rate_plan

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.waitlist_entry

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.waitlist_entry_for_property"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.waitlist_entry"
    }
  ]
}

Headers

Cache-Control

string

Allowed value: no-store

Always no-store — uncommitted live data.

409

Conflict — concurrent modification or unique constraint violation the apply would hit.

422

Validation error — the apply would be rejected.