Start inspection round
const url = 'https://api.aerandil.com/v1/actions/hospitality.action.start_inspection_round/apply';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"branch":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","params":{"round_id":"example","started_at":"2026-04-15T12:00:00Z","template_revision":1},"return_modified":false,"target":{"id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","object_type":"hospitality.round_template"}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.aerandil.com/v1/actions/hospitality.action.start_inspection_round/apply \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "round_id": "example", "started_at": "2026-04-15T12:00:00Z", "template_revision": 1 }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.round_template" } }'Start a round from an active template — by hand, or the automation sweep’s effect when the template falls due. The round carries the template’s name, family, the due date it answers (due_on, the template’s next_due_on) and its checkpoints as they stand now; it starts open, started_by the principal (and linked to the staff member behind a handset session), and the template’s open_round_id names it. One open round per template: while one is open, the same caller starting again — or the same round_id — is a replay that writes nothing, and anyone else is refused, naming the open round. round_id is the round’s id when the caller mints it (a v4 or v7 UUID — a handset starting a walk with no signal records its checkpoints against it before the start lands); the same id on another template is refused as a duplicate. Refuses a retired template. template_revision (2026-10-17) is the template’s revision the caller saw — a handset queueing a start names the walk it shows: when the template has been revised since, the start is refused (409 version_conflict, expected_version the stated revision and current_version the template’s) and nothing opens, so readings queued against the old positions never land on moved checkpoints; a start already landed under the same round_id is a replay whatever it names. The round records the revision it copied (template_revision). Emits inspection_round.started. A person’s start under a minted round_id takes over a round the automation sweep opened (started_by an automation) that nothing has been recorded on yet (2026-10-17) — the walk queued on a handset that was offline when the template fell due: the sweep’s round is cancelled (cancel_reason naming the walk that took it; inspection_round.cancelled with taken_over_by), the caller’s round opens for the same due date and stands (inspection_round.started with took_over; the response lists both and an inspection-round-taken-over warning names them). A sweep’s round with a checkpoint recorded is someone’s walk and is not taken: the start is refused, naming it, as any other open round.
Effects: create hospitality.inspection_round; modify hospitality.round_template; link hospitality.link.inspection_round_from_template; link hospitality.link.inspection_round_started_by; modify hospitality.inspection_round.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
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).
object
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.
object
Responses
Section titled “Responses”Action applied. modified_objects and modified_links populated when return_modified: true was supplied.
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
Per-invocation correlation id; matches events.correlation_id for every event this action appended.
Links established or removed by this invocation. Empty when the caller did not request return_modified.
object
Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.
object
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.
object
Human-readable summary, suitable for logging or operator-UI surfacing.
Object type the warning was raised against.
Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.
Stable kebab-case rule identifier (e.g. comp-authority-over-limit).
Example
{ "modified_links": [ { "kind": "linked", "link_type": "hospitality.link.inspection_round_from_template" } ], "modified_objects": [ { "kind": "created", "object_type": "hospitality.inspection_round" } ]}Conflict — concurrent modification or unique constraint violation.
Validation error — parameter validation or business-rule violation.