Skip to content
aerandil.com
GitHub

Read Inspection round

GET
/v1/object-types/hospitality.inspection_round/objects/{id}
curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.inspection_round/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

One executed walk of a round template (inspection_round_from_template) — hubOS’s revision. Carries the template’s name and family, the due date it answers (due_on) and the template’s checkpoints as they stood when it started, so a revision of the template never changes a walk under way and the record shows the list it was walked against (template_revision, the template’s revision it copied). Started by hand or by the automation lane when the template falls due (started_by names the principal; inspection_round_started_by the staff member when one did); each checkpoint is recorded as a checkpoint_result (checkpoint_result_in_round); checkpoints_recorded, total_anomalies and total_faults are the fold of those results, kept by the verbs. open → completed (every checkpoint recorded, or partial with a reason; moves the template’s next due date on) or cancelled (with a reason; the occurrence is still owed). Faults raised from it are work orders (work_order_from_round).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

Section titled “Query Parameters”
branch
string format: uuid

Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.

Responses

Section titled “Responses”

200

Section titled “200”

Object found.

Media typeapplication/json
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
Allowed value: hospitality.inspection_round
properties
required
object
cancel_reason
Why the round was cancelled
string
cancelled_at
When the round was cancelled
string format: date-time
checkpoints
required
Inspection round checkpoints

The template’s checkpoints as they stood when the round started

Array<object>
object
items
required
Array<object>
object
code
required
string
kind
required
string
Allowed values: check reading text photo section
label
required
string
max
string format: decimal
min
string format: decimal
unit
string
kind
required
string
Allowed values: room asset general
label
string
position
required
integer
ref_id
string
checkpoints_recorded
required
How many of its checkpoints have a result
integer
completed_at
When the round was finished
string format: date-time
completed_by
The principal that finished it
string
due_on
required
The due date this round answers — the template's next_due_on when it started
string format: date
family
required
The template's family when the round started
string
Allowed values: corrective preventive technical_legal inspection_legal
id
required
Inspection round id
string
name
required
The template's name when the round started
string
observations
The walker's observations on the round as a whole
string
partial
Finished with checkpoints unrecorded (with partial_reason)
boolean
partial_reason
Why checkpoints were left unrecorded
string
started_at
required
When the round was started (the handset's own time when it says)
string format: date-time
started_by
required
The principal that started it (`user:…`, `agent:…`, `service:…`, `system` — the automation lane when the template fell due)
string
status
required
open, completed or cancelled
string
Allowed values: open completed cancelled
template_revision
The template's revision when the round started — the walk the checkpoints were copied from
integer
total_anomalies
required
Anomalies across its checkpoints (items answered not ok)
integer
total_faults
required
Work orders raised from its checkpoints
integer
provenance

Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.

object
pins
object
key
additional properties
object
pinned_at
string format: date-time
pinned_by
object
reason
required
string
properties
object
key
additional properties
object
external_id
string
recorded_at
required
string format: date-time
source
required
string
source_updated_at
string format: date-time
stream
string
scope
required
One of: discriminator: level
object
level
required
string
Allowed value: tenant
Allowed values: tenant
tenant_id
required
string format: uuid
updated_at
required
string format: date-time
version
required
integer
>= 1
Example
{
  "object_type": "hospitality.inspection_round",
  "properties": {
    "checkpoints": [
      {
        "items": [
          {
            "kind": "check"
          }
        ],
        "kind": "room"
      }
    ],
    "family": "corrective",
    "status": "open"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

Section titled “Headers”
ETag
string
/^"\d+"$/

Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.

404

Section titled “404”

No object with that id (or soft-deleted).