Skip to content

Complete inspection round

POST
/v1/actions/hospitality.action.complete_inspection_round/apply
curl --request POST \
--url https://api.aerandil.com/v1/actions/hospitality.action.complete_inspection_round/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "completed_at": "2026-04-15T12:00:00Z", "observations": "example", "partial": true, "partial_reason": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.inspection_round" } }'

Finish an open round — hubOS’s ‘finalized by’. Refuses while any of the round’s checkpoints has no result, or a recorded one has fewer photos (attachments whose upload landed) than photo items, naming them, unless partial is true with a partial_reason (the walk could not reach them); observations are the walker’s on the round as a whole. Stamps completed_at (the handset’s time when it says) and who finished it, clears the template’s open_round_id, and moves the template on as a maintenance plan moves on: the next due date is the last plus the interval for a fixed template (skipping slots a late round overran) or the completion’s property-local date plus the interval for a floating one. A retired template is not moved. Completing a completed round is a no-op; a cancelled one refuses. Emits inspection_round.completed.

Effects: modify hospitality.inspection_round; modify hospitality.round_template; link hospitality.link.inspection_round_completed_by.

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
completed_at
When the round was finished (defaults to now; refused when more than five minutes ahead of the kernel's clock)
string format: date-time
observations
The walker's observations on the round as a whole
string
partial
Finish with checkpoints unrecorded (needs partial_reason)
boolean
partial_reason
Why checkpoints were left unrecorded
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.inspection_round

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.inspection_round_completed_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: modified
object_type
required
Allowed values: hospitality.inspection_round hospitality.round_template
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.inspection_round_completed_by"
}
],
"modified_objects": [
{
"kind": "modified",
"object_type": "hospitality.inspection_round"
}
]
}

Conflict — concurrent modification or unique constraint violation.

Validation error — parameter validation or business-rule violation.