Read Group displacement analysis

GET

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

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

Read an existing instance.

Frozen decision artefact recording the displacement analysis for a group block — Cornell SHA / Sheryl Kimes methodology, carried as audit-grade evidence of the rate floor and decision at the moment they were made. The embedded forecast_snapshot pins the transient-room / ADR / occupancy projection at decision time; recomputing against today’s forecast undermines the audit trail. Mutation post-write is disallowed by convention — re-decisions create new analyses, not mutations.

Authorizations

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

properties

required

object

counter_rate

Group displacement analysis counter rate

Counter offer ADR (set when decision = counter)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

decided_at

required

When the decision was recorded

string format: date-time

decided_by

Decider principal identifier (matches Principal::stable_id)

string

decision

required

Decision recorded at the moment of analysis

string

Allowed values: accept decline counter

decision_notes

Decision notes

string

displaced_contribution

Group displacement analysis displaced contribution

Forfeited transient contribution

object

amount

required

string format: decimal

currency

required

string format: iso-4217

displaced_room_nights

required

Displaced transient room nights

integer

forecast_snapshot

Group displacement analysis forecast snapshot

Forecast at decision time

object

compset_revpar_by_night

Array<object>

object

amount

required

string format: decimal

currency

required

string format: iso-4217

occupancy_by_night

Array<string>

transient_adr_by_night

required

Array<object>

object

amount

required

string format: decimal

currency

required

string format: iso-4217

transient_rooms_by_night

required

Array<integer>

group_total_revenue

Group displacement analysis group total revenue

Group total revenue (rooms + ancillary)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

group_variable_cost

Group displacement analysis group variable cost

Group variable cost

object

amount

required

string format: decimal

currency

required

string format: iso-4217

required

Analysis id

string

minimum_acceptable_rate

Group displacement analysis minimum acceptable rate

Minimum acceptable group ADR (rate floor)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

variable_cost_per_room

Group displacement analysis variable cost per room

Variable cost per room

object

amount

required

string format: decimal

currency

required

string format: iso-4217

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.group_displacement_analysis",
  "properties": {
    "decision": "accept"
  },
  "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).