Read Fault type

GET

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

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

Read an existing instance.

A kind of fault a house keeps in its catalogue — “no hot water”, “TV remote dead”, “lift stuck between floors” (hubOS’s failure catalogue). Keyed by code within its catalogue: a brand’s (fault_type_at_brand, shared by the brand’s houses) or one house’s (fault_type_at_property); define_fault_type with a code the catalogue holds re-states it in place. It carries the title an order raised from it is given, the room element it is in, the category (the trade that mends it) and the severity it starts at — create_work_order and create_public_area_work_order take fault_type_id and fill each one the call does not state. active, or retired for good (the code stays taken).

Authorizations

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

properties

required

object

category

required

The work-order category an order raised from it starts with — the trade that mends it

string

Allowed values: hvac plumbing electrical furniture fixtures networking audio_visual structural exterior safety other

code

required

The catalogue's code for it — unique within the catalogue

string

defined_at

required

When it was first put in the catalogue

string format: date-time

description

Notes for whoever raises or mends it

string

element

The room element the fault is in (hubOS's icon), when it is in one

string

Allowed values: light air_conditioning curtain safe door television phone wardrobe shower mirror toilet pipework minibar electrical other

retire_reason

Why it was retired

string

retired_at

When it was retired

string format: date-time

severity

required

The severity an order raised from it starts at

string

Allowed values: cosmetic minor major blocking safety

status

required

active, or retired (final)

string

Allowed values: active retired

title

required

The title an order raised from it is given

string

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.fault_type",
  "properties": {
    "category": "hvac",
    "element": "light",
    "severity": "cosmetic",
    "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).