Register room

POST

/v1/actions/hospitality.action.register_room/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.register_room/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "bed_configuration": "joined", "code": "example", "floor": "example", "housekeeping_status": "dirty", "number": "example", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "room_type_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "return_modified": false }'

• Production API

Register a physical room at property_id in room_type_id under its vendor-alignment code, with its number (what the house calls it) and optionally its floor. Upsert by code: the same code again restates the room in place — a renumbered room updates, a re-categorised room moves to the new type (room_type_has_room is re-pointed), an identical restatement writes nothing. The room type must belong to the property. The state axes are the house’s, not the feed’s: housekeeping_status is honoured only on first registration (the room’s state on day 0; dirty when absent) and never overwritten by a restatement, and occupancy starts vacant and is written only by check-in / check-out. Links the room to its property and its type on first registration. A Mews connector provisions one per resource assigned to a category of the bookable service (code == the resource id, number == its name). Emits room.registered.

Effects: create hospitality.room; modify hospitality.room; link hospitality.link.property_has_room; link hospitality.link.room_type_has_room; unlink hospitality.link.room_type_has_room.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.register_room:apply

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

bed_configuration

How the room's convertible beds are made up now, when known

string

Allowed values: joined split

code

required

The room's vendor-alignment code (trimmed; the tenant-unique business key — a vendor's unit id when a connector provisions it)

string

floor

The floor it is on, in the house's own words

string

housekeeping_status

The room's cleaning state on first registration only (`dirty` when absent)

string

Allowed values: dirty pickup clean inspected

number

required

The room number — what the house calls the room

string

property_id

required

The property the room is in

string format: uuid

room_type_id

required

The room type the room sells as (must belong to the property)

string format: uuid

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

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 unlinked end_dated

link_type

required

Allowed values: hospitality.link.property_has_room hospitality.link.room_type_has_room

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

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

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.