Skip to content
aerandil.com
GitHub

Search Inspection round

POST
/v1/object-types/hospitality.inspection_round/search
curl --request POST \
  --url https://api.aerandil.com/v1/object-types/hospitality.inspection_round/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cursor": "example", "filters": [ { "property": "id", "type": "eq", "value": "example" } ], "limit": 1, "order": "asc", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "scope": { "level": "tenant" }, "sort_by": "created_at" }'

Search for instances. Filters eq, contains, gte and lte AND-compose; or / not are additive follow-ups. Pages with an opaque cursor; the +1 fetch returns has_more without a second round-trip. Ordered by sort_by (default created_at) in order (default ascending), id breaking ties; rows with no value for a property key sort last.

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”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
branch

Optional open-branch id. Search composes that branch’s copy-on-first-write overlay instead of main, so a preview reads its own hypothetical writes. Omit to read main.

string format: uuid
cursor

Opaque cursor from a prior response’s next_cursor. Pass back verbatim; do not introspect.

string
filters

Conjunctive list of predicates. Empty or omitted matches every row in scope, capped by limit.

Array
One of:
object
property
required
Allowed value: id
type
required
Allowed value: eq
value
required
string
limit

Page size. Server defaults to 50, silently clamps at 500 (AIP-158 §3).

integer
>= 1 <= 500
order

Direction of sort_by: asc (oldest / smallest first) or desc. A cursor is bound to the sort_by and order it was minted under; another pair is refused (422).

string
default: asc
Allowed values: asc desc
property_id

The house a desk stands in: keeps this property’s rows (property- or venue-scoped there) and every row scoped to no property (tenant, brand, portfolio), and drops a sibling house’s — the meaning property_id has on the event tail.

string format: uuid
scope
One of: discriminator: level
object
level
required
string
Allowed value: tenant
Allowed values: tenant
sort_by

What the page is ordered by: the row’s created_at or updated_at, or a property whose type orders — strings, enums and dates as text, ints, decimals and durations as numbers, datetimes as instants. Rows with no value sort last in either direction. A property the caller is not cleared to read is refused (403).

string
default: created_at
Allowed values: created_at updated_at id name family due_on status started_at started_by completed_at completed_by partial_reason observations cancelled_at cancel_reason checkpoints_recorded total_anomalies total_faults template_revision

Responses

Section titled “Responses”

200

Section titled “200”

Search results, ordered by (sort_by, id) in the requested order (ascending by default).

Media typeapplication/json
object
data
required
Array<object>
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
has_more
required
boolean
next_cursor

Cursor for the next page; omitted when the result set is exhausted.

string
Example
{
  "data": [
    {
      "object_type": "hospitality.inspection_round",
      "properties": {
        "checkpoints": [
          {
            "items": [
              {
                "kind": "check"
              }
            ],
            "kind": "room"
          }
        ],
        "family": "corrective",
        "status": "open"
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Section titled “422”

Validation error — unknown property or filter type mismatch.