Skip to content
aerandil.com
GitHub

Validate Create housekeeping task (dry-run)

POST
/v1/actions/hospitality.action.create_housekeeping_task/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.create_housekeeping_task/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "assignee_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "business_date": "2026-04-15", "credits": "example", "due_at": "2026-04-15T12:00:00Z", "from_triage_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "notes": "example", "priority": "low", "requested_by": "guest", "standard_minutes": 1, "stay_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "task_type": "stayover" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.room" } }'

Dry-run of apply_hospitality_action_create_housekeeping_task’s parameter checks. No side effects, no idempotency reservation, no handler dispatch — just the schema pass plus action-level shape (target presence, target type, unknown-parameter rejection). return_modified is meaningless here and ignored.

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
assignee_id
Staff member to assign the task to in the same write — someone at the room's house; a housekeeper or runner session names only itself
string format: uuid
business_date
Service date (defaults to the property-local business day)
string format: date
credits
Credits the task is worth, overriding the house's credit rule (zero or more)
string format: decimal
due_at
When the work is due (no earlier than the start of the day before the house's today)
string format: date-time
from_triage_id
The triaged guest request that asked for this, if one did — links the task back to the conversation so the lane closing the loop knows where to reply
string format: uuid
notes
Notes for the attendant
string
priority
Priority (defaults to normal)
string
Allowed values: low normal high urgent
requested_by
Who asked: guest, desk, floor, pms or automation (defaults from the caller — guest when stay_id or from_triage_id is named)
string
Allowed values: guest desk floor pms automation
standard_minutes
Minutes the work should take, overriding the house's credit rule (1 to 1440)
integer
stay_id
The guest stay that asked for the work — a stay at the task's house
string format: uuid
task_type
required
Kind of work
string
Allowed values: stayover departure vacant_pickup deep_clean turndown inspection public_area_clean public_area_inspection minibar laundry
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.room

Responses

Section titled “Responses”

200

Section titled “200”

Validation outcome. result is valid or invalid; per-parameter diagnostics are always populated for every declared parameter so a UI can render the action’s full surface.

Media typeapplication/json
object
action
required
string
errors

Action-level errors not tied to a single parameter (missing target, target type mismatch, unknown parameter names). Absent when empty.

Array<string>
parameters
required

Per-parameter diagnostics keyed by api_name.

object
key
additional properties
object
errors
Array<string>
result
required
Allowed values: valid invalid
value
required

The serialised value the server interpreted, or null if the parameter was not supplied.

result
required
Allowed values: valid invalid
Example
{
  "parameters": {
    "additionalProperty": {
      "result": "valid"
    }
  },
  "result": "valid"
}