Record checklist result

POST

/v1/actions/hospitality.action.record_checklist_result/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.record_checklist_result/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "items": [ { "code": "example", "ok": true, "remark": "example", "value": "example" } ], "recorded_at": "2026-04-15T12:00:00Z", "remarks": "example", "template_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.housekeeping_task" } }'

• Production API

Record the ticked checklist against a housekeeping task — the attendant’s list at a clean, the supervisor’s at an inspection. The template is template_id, or (absent) the most specific active template for the task’s type and room type; a named template must apply to the task. items answer the template’s items by code (each at most once; a code the template does not have refuses; a count item’s value is a whole number); the score is derived — the template’s check items answered ok ÷ all its check items, × 100, rounded half up (none when the template has no checks). The recorder is the staff member behind the session, taken from the principal as start_housekeeping_task self-assigns. One write, replay-safe per task × template: an identical repeat writes nothing, even once the task is finished or its template retired or revised; different answers replace this task’s earlier result in place while the task is open; a complete or skipped task refuses. Photos attach to the result (host_kind = checklist_result). Emits checklist_result.recorded.

Effects: create hospitality.checklist_result; modify hospitality.checklist_result; link hospitality.link.checklist_result_for_task; link hospitality.link.checklist_result_for_template; link hospitality.link.checklist_result_recorded_by; unlink hospitality.link.checklist_result_recorded_by.

Authorizations

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

items

required

Checked items

Array<object>

object

code

required

string

ok

required

boolean

remark

string

value

string

recorded_at

When the list was ticked (defaults to now)

string format: date-time

remarks

Remarks on the whole list

string

template_id

The template answered (absent: the one that resolves for the task)

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

target

required

object

id

required

string format: uuid

object_type

required

Allowed value: hospitality.housekeeping_task

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.checklist_result_for_task hospitality.link.checklist_result_for_template hospitality.link.checklist_result_recorded_by

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

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

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.