Checklist for a task

POST

/v1/functions/hospitality.function.checklist_for_task/invoke

curl --request POST \
  --url https://api.aerandil.com/v1/functions/hospitality.function.checklist_for_task/invoke \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "params": {}, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.housekeeping_task" } }'

• Production API

The checklist a housekeeping task resolves to — the most specific active template for its task type and its room’s type: the house’s for the room’s type, the house’s for every room, the brand’s for the room’s type, the brand’s for every room (oldest template first within a tier). The same resolution complete_housekeeping_task gates on and record_checklist_result answers, so a handset reads the list instead of re-deriving it. Returns the template’s id, name, items (code, label, kind) and whether it is required for completion, and the id of the result recorded against the task for it; no template when no list applies. Read-only.

Authorizations

• aerandil_oauth
  functions:invoke
• aerandil_oauth
  functions:hospitality.function.checklist_for_task:invoke

Request Body^required

Media typeapplication/json

object

params

required

object

target

required

object

id

required

string format: uuid

object_type

required

Allowed value: hospitality.housekeeping_task

Responses

200

Function invoked. The body carries the typed return_value shaped by the function’s declared return_type.

Media typeapplication/json

InvokeFunctionResponse

Envelope returned by the Aerandil function engine. correlation_id is the per-invocation id for trace stitching; return_value is the typed value the function computed (shape declared by the function’s return_type).

object

correlation_id

required

Per-invocation correlation id; appears on log/trace records this function emitted.

string format: uuid

return_value

required

object

result_id

string format: uuid

task_id

required

string format: uuid

template

object

id

required

string format: uuid

items

required

Array<object>

object

code

required

string

kind

required

string

Allowed values: check photo count text

label

required

string

name

required

string

required_for_completion

required

boolean

Example

{
  "return_value": {
    "template": {
      "items": [
        {
          "kind": "check"
        }
      ]
    }
  }
}

Headers

Cache-Control

string

Always no-store — function results are time-sensitive and never cacheable.

404

Function or target object not found.

422

Parameter validation or domain-rule violation.