Set green stay

POST

/v1/actions/hospitality.action.set_green_stay/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.set_green_stay/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "green_stay": true }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.stay" } }'

• Production API

Set or clear the stay’s green stay: the guest declined the day’s clean for sustainability (hubOS’s leaf, beside and never one of its do-not-disturb states). While set, generate_housekeeping_tasks mints no stayover clean for the stay’s room — a shared room only when every guest in house in it declined — and the departure clean, turndown and every other task are untouched. Setting it retires today’s generated stayover on the room that nobody has started (skipped, with the reason); clearing it re-mints today’s stayover when the house’s board has been generated for today (reviving the skipped one in place, through the generator’s own key and price), so the room is back on the sheet without a re-run. Today is the house’s housekeeping service date (its local calendar day). A manual task is never touched. Refused on a stay that has checked out, did not show or was cancelled; setting the value the stay already carries is a no-op. The flag is not guest PII: the floor sets it through the room’s in-house stay. Emits stay.green_stay_set.

Effects: modify hospitality.stay; modify hospitality.housekeeping_task; create hospitality.housekeeping_task; link hospitality.link.housekeeping_task_for_room.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.set_green_stay: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

green_stay

required

true when the guest declines the day's clean; false clears it

boolean

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

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

link_type

required

Allowed values: hospitality.link.housekeeping_task_for_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: modified created

object_type

required

Allowed values: hospitality.stay hospitality.housekeeping_task

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.housekeeping_task_for_room"
    }
  ],
  "modified_objects": [
    {
      "kind": "modified",
      "object_type": "hospitality.stay"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.