Skip to content
aerandil.com
GitHub

Validate Create work order (dry-run)

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

Dry-run of apply_hospitality_action_create_work_order’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
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

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"
}