Skip to content
aerandil.com
GitHub

Define worker group

POST
/v1/actions/hospitality.action.define_worker_group/apply
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.define_worker_group/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "department": "housekeeping", "floors": [ "example" ], "name": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

Define a named group of staff at the target property that work can be assigned to — the third-floor runners, the public-areas team, the night maintenance crew (hubOS’s workers groups). department says whose work it takes: a housekeeping task goes to a housekeeping, public_areas or other group, a work order to a maintenance or other one. floors, when given, are the floors it covers — runners by floor are a group of runners naming its floors, and work in a room or area on another floor is refused to it, as is work in a room or area that states no floor. Upsert by name: the same name again restates the group in place (an identical restatement writes nothing; absent floors clears them), and a retired group defined again comes back active. A restatement releases the group’s open work it no longer covers — on a floor it no longer names, or of a kind its department no longer takes — back to the open board, unassigned, as retire_worker_group does. Two first definitions of one name queue on a per-house lock, so the second restates the first. Members are set_worker_group_members’. Emits worker_group.defined, naming the work it released.

Effects: create hospitality.worker_group; modify hospitality.worker_group; unlink hospitality.link.housekeeping_task_assigned_to_group; unlink hospitality.link.work_order_assigned_to_group; modify hospitality.housekeeping_task; modify hospitality.work_order.

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
department
required
Whose work the group takes
string
Allowed values: housekeeping maintenance public_areas other
floors
The floors the group covers, in the rooms' own words (absent: every floor)
Array<string>
name
required
What the house calls the group (trimmed; unique in the house)
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.property

Responses

Section titled “Responses”

200

Section titled “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: unlinked end_dated
link_type
required
Allowed values: hospitality.link.housekeeping_task_assigned_to_group hospitality.link.work_order_assigned_to_group
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.worker_group hospitality.housekeeping_task hospitality.work_order
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": "unlinked",
      "link_type": "hospitality.link.housekeeping_task_assigned_to_group"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.worker_group"
    }
  ]
}

409

Section titled “409”

Conflict — concurrent modification or unique constraint violation.

422

Section titled “422”

Validation error — parameter validation or business-rule violation.