Read Checkpoint result

GET

/v1/object-types/hospitality.checkpoint_result/objects/{id}

const url = 'https://api.aerandil.com/v1/object-types/hospitality.checkpoint_result/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Read an existing instance.

What one checkpoint of an inspection round recorded (checkpoint_result_in_round) — hubOS’s revision chapter. The checkpoint’s checkpoint_position and kind in the round, the room (checkpoint_result_for_room) or equipment (checkpoint_result_for_asset) it is at — neither for a general place — the answered items, the walker’s observations, when it was started and finished (its duration is the difference), and who recorded it (recorded_by; checkpoint_result_recorded_by when a staff member did). anomalies is derived, never typed: the items answered not ok. faults counts the work orders raised from it (work_order_from_checkpoint). One result per round × checkpoint: recording the checkpoint again replaces it in place while the round is open. Its id may be the walker’s own (a v4 or v7 UUID minted on the handset), so a photo taken with no signal waits for it. Photos hang off it as attachments; a checkpoint’s photo items are answered by them, and the round does not complete without them.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.checkpoint_result:read

Parameters

Path Parameters

required

string format: uuid

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

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

200

Object found.

application/json

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.checkpoint_result

properties

required

object

anomalies

required

Items answered not ok — derived from the items

integer

checkpoint_position

required

The checkpoint's position in the round

integer

completed_at

required

When the checkpoint was finished (the handset's own time when it says)

string format: date-time

faults

required

Work orders raised from this checkpoint

integer

required

Checkpoint result id

string

items

required

Checkpoint result items

The answered items, by the checkpoint’s item codes

Array<object>

object

code

required

string

boolean

text

string

value

string format: decimal

kind

required

room, asset or general — the checkpoint's kind in the round

string

Allowed values: room asset general

observations

What the walker noticed at the checkpoint

string

recorded_by

required

The principal that recorded it (`user:…`, `agent:…`, `service:…`, `system`)

string

started_at

When the walker began the checkpoint

string format: date-time

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.checkpoint_result",
  "properties": {
    "kind": "room"
  },
  "scope": {
    "level": "tenant"
  }
}

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

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