Read Room status block

GET

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

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

Read an existing instance.

A dated out-of-order or out-of-service record against one room — the time-boxed inventory fact OPERA and Mews both model underneath their status enums. out_of_order deducts the blocked dates from the room type’s sellable inventory (availability_day.out_of_order) and refuses assignment; out_of_service is an advisory flag with no inventory effect. return_status names the housekeeping status the room re-enters on release — declared at creation, so a block can never expire into an undefined state. ledger_dates records exactly which availability rows the block decremented (release restores exactly those); displaced_dates records nights where the deduction pushed sold past the new ceiling — overbooking exposure reported, never silently absorbed.

Authorizations

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

properties

required

object

blocked_at

required

When the block was recorded

string format: date-time

displaced_dates

Blocked dates already sold past the reduced ceiling

Array<string>

end_date

required

Last blocked night (inclusive through-date)

string format: date

required

Block id

string

kind

required

Block kind

string

Allowed values: out_of_order out_of_service

ledger_dates

Dates whose availability rows this block decremented

Array<string>

reason

required

Reason

string

released_at

When the block was released

string format: date-time

remarks

Remarks

string

return_status

required

Housekeeping status the room re-enters on release

string

Allowed values: dirty pickup clean inspected

start_date

required

First blocked night

string format: date

status

required

Status

string

Allowed values: active released

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_status_block",
  "properties": {
    "kind": "out_of_order",
    "return_status": "dirty",
    "status": "active"
  },
  "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).