Skip to content
aerandil.com
GitHub

What-if Open channel connection (rollup delta)

POST
/v1/actions/hospitality.action.open_channel_connection/whatif
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.open_channel_connection/whatif \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "ari_endpoint_url": "example", "channel_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "display_name": "example", "horizon_days": 1, "notes": "example", "owner_client_ref": "example", "partner_code": "example", "price_basis": "gross", "property_code": "example", "protocol": "pmsx_ota_2003_05", "provider": "example", "provisioning": "partner_hosted", "rate_model": "per_day", "reservation_delivery": "partner_push", "secret_ref": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

What-if projection of apply_hospitality_action_open_channel_connection — previews the action (execute-and-roll-back) and folds its would-be events into rollup deltas, returning the contribution an apply would make to the daily_rooms fact (ADR / RevPAR / TRevPAR / Occupancy inputs) without persisting anything. Requires the same actions:hospitality.action.open_channel_connection:apply scope as apply. An action that emits no rooms-fact events yields an empty daily_rooms.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
branch

Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).

string format: uuid
params
required
object
ari_endpoint_url
HTTPS endpoint we publish ARI into
string
channel_ids
Demand channels this conduit carries
Array<string>
display_name
required
Human-readable name shown in the Explorer
string
horizon_days
required
Days forward from today that ARI is published for (1..=750)
integer
notes
Free-form operator notes
string
owner_client_ref
Client registering this subscription (subscription provisioning only)
string
partner_code
The partner's identifier for our system (SiteMinder RequestorID / pmsCode)
string
price_basis
Whether published amounts are gross, net, or both (default gross_and_net)
string
Allowed values: gross net gross_and_net
property_code
The partner's identifier for this property (SiteMinder HotelCode)
string
protocol
required
Wire dialect this conduit speaks
string
Allowed values: pmsx_ota_2003_05 mews_chm_v1 aerandil_ari_v1 other
provider
required
Partner identifier (siteminder / d_edge / derbysoft / …)
string
provisioning
required
Who stood the conduit up (we call them, or they subscribed to us)
string
Allowed values: partner_hosted subscription
rate_model
required
Published rate model — fixed per conduit, never per property
string
Allowed values: per_day occupancy_based
reservation_delivery
required
How reservations reach us from the partner
string
Allowed values: partner_push we_pull none
secret_ref
Name of the credential in the external secret store (never the value)
string
return_modified

When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.

boolean
target
required
object
id
required
string format: uuid
object_type
required
Allowed value: hospitality.property

Responses

Section titled “Responses”

200

Section titled “200”

Rollup deltas the action would contribute, computed and rolled back.

Media typeapplication/json
object
daily_rooms
required

Per (property, business_date) additive contribution to the rooms rollup.

Array<object>
object
business_date
required
string format: date
currency

ISO 4217, when the fold observed one.

string
property_id
required
string format: uuid
rooms_revenue_net_delta
required

Decimal, net rooms revenue delta.

string
rooms_sold_delta
required
integer format: int64
total_revenue_net_delta
required

Decimal, net total revenue delta.

string
Examplegenerated
{
  "daily_rooms": [
    {
      "business_date": "2026-04-15",
      "currency": "example",
      "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "rooms_revenue_net_delta": "example",
      "rooms_sold_delta": 1,
      "total_revenue_net_delta": "example"
    }
  ]
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: no-store

Always no-store — derived, uncommitted data.

422

Section titled “422”

Validation error — the apply would be rejected.