Read Room discrepancy

GET

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

const url = 'https://api.aerandil.com/v1/object-types/hospitality.room_discrepancy/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.room_discrepancy/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

A derived disagreement between system occupancy and what the attendant physically found (OPERA’s skip / sleep / person model, plus the resolution audit it lacks): skip — system occupied, found vacant; sleep — system vacant, found occupied; person — occupant count mismatch. Raised and auto-resolved by set_room_housekeeping_status when the views diverge and re-agree; front-desk verdicts land through resolve_room_discrepancy with a typed outcome, so every discrepancy closes with a recorded why.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.room_discrepancy: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.room_discrepancy

properties

required

object

expected_persons

Occupants per the in-house reservation

integer

required

Discrepancy id

string

kind

required

Discrepancy kind

string

Allowed values: skip sleep person

notes

Resolution notes

string

observed_occupancy

required

Observed occupancy at raise time

string

Allowed values: vacant occupied

observed_persons

Occupants the attendant counted

integer

outcome

How the investigation closed

string

Allowed values: statuses_realigned walkout_confirmed unregistered_occupant_registered observation_error corrected_by_front_office

raised_at

required

Raised at

string format: date-time

resolved_at

Resolved at

string format: date-time

status

required

Status

string

Allowed values: open resolved

system_occupancy

required

System occupancy at raise time

string

Allowed values: vacant occupied

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.room_discrepancy",
  "properties": {
    "kind": "skip",
    "observed_occupancy": "vacant",
    "outcome": "statuses_realigned",
    "status": "open",
    "system_occupancy": "vacant"
  },
  "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).