Preview Create work order (dry-run)

POST

/v1/actions/hospitality.action.create_work_order/preview

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.create_work_order/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "allow_duplicate": true, "asset_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "category": "hvac", "description": "example", "element": "light", "fault_type_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "from_triage_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "out_of_order_end": "2026-04-15", "out_of_order_start": "2026-04-15", "return_status": "dirty", "severity": "cosmetic", "staff_member_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "stay_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "title": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.room" } }'

• Production API

Scenario preview of apply_hospitality_action_create_work_order — 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.create_work_order: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

allow_duplicate

Raise it even when an order with the same title or fault type is already open on the room

boolean

asset_id

The equipment that failed, when the order is for one — it need not stand in the target room (no hot water in 101, the boiler in the plant room); same house, not retired. Linked (work_order_for_asset) and carried on the order as asset_id

string format: uuid

category

Category (defaults to the fault type's, else the element's trade)

string

Allowed values: hvac plumbing electrical furniture fixtures networking audio_visual structural exterior safety other

description

Description

string

element

The room element the fault is in (defaults to the fault type's)

string

Allowed values: light air_conditioning curtain safe door television phone wardrobe shower mirror toilet pipework minibar electrical other

fault_type_id

The catalogue entry the fault is — the house's or its brand's, active; fills what the call does not state

string format: uuid

from_triage_id

The triaged guest report that raised this, if one did — the fault as the guest phrased it, and the edge the closing reply walks back to the conversation

string format: uuid

out_of_order_end

Last out-of-order night (inclusive through-date; the night audit returns the room when it closes)

string format: date

out_of_order_start

First night the room is out of order (with out_of_order_end and return_status, or not at all)

string format: date

return_status

Housekeeping status the room re-enters on release

string

Allowed values: dirty pickup clean inspected

severity

Severity (defaults to the fault type's)

string

Allowed values: cosmetic minor major blocking safety

staff_member_id

Engineer to assign on creation

string format: uuid

stay_id

The guest stay that reported the fault; the order then reads reported_by_guest without carrying the guest

string format: uuid

title

Title (defaults to the fault type's, else the element's name)

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

target

required

object

id

required

string format: uuid

object_type

required

Allowed value: hospitality.room

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.work_order_from_triage hospitality.link.work_order_for_room hospitality.link.work_order_assigned_to hospitality.link.room_status_block_for_room hospitality.link.work_order_holds_block hospitality.link.work_order_for_asset hospitality.link.work_order_reported_by_stay hospitality.link.work_order_of_fault_type hospitality.link.work_order_for_area

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 modified

object_type

required

Allowed values: hospitality.work_order hospitality.room_status_block hospitality.availability_day

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

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.