Skip to content
aerandil.com
GitHub

Preview Open channel connection (dry-run)

POST
/v1/actions/hospitality.action.open_channel_connection/preview
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.open_channel_connection/preview \
  --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" } }'

Scenario preview of apply_hospitality_action_open_channel_connection — runs the action exactly as apply would (validation, handler dispatch, modified-object projection, commit-time cross-link validation) then rolls the transaction back. Returns the modified_objects / modified_links / warnings the apply would have produced without persisting anything or firing any outward effect. Requires the same actions:hospitality.action.open_channel_connection:apply scope as apply. No Idempotency-Key.

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”

Preview computed and rolled back. modified_objects and modified_links carry the effect set the apply would produce; preview is always true.

Media typeapplication/json
ApplyActionResponse

Envelope returned by the Aerandil action engine. correlation_id ties every event emitted by this invocation; modified_objects and modified_links project the events the handler emitted (per the action’s declared effects); warnings carries any non-blocking soft-validator observations.

object
correlation_id
required

Per-invocation correlation id; matches events.correlation_id for every event this action appended.

string format: uuid
modified_links
required

Links established or removed by this invocation. Empty when the caller did not request return_modified.

Array<object>
object
from_id
required
string format: uuid
from_type
required
string
kind
required
Allowed values: linked
link_type
required
Allowed values: hospitality.link.channel_connection_for_property hospitality.link.channel_connection_carries_channel
to_id
required
string format: uuid
to_type
required
string
modified_objects
required

Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.

Array<object>
object
id
required
string format: uuid
kind
required
Allowed values: created
object_type
required
Allowed values: hospitality.channel_connection
warnings

Non-blocking soft-validator observations emitted during this invocation (e.g. comp-authority over-limit, recipe pour-cost over sell-price). Absent when no warnings were emitted.

Array<object>
object
message
required

Human-readable summary, suitable for logging or operator-UI surfacing.

string
object_type
required

Object type the warning was raised against.

string
property

Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.

string
rule
required

Stable kebab-case rule identifier (e.g. comp-authority-over-limit).

string
Example
{
  "modified_links": [
    {
      "kind": "linked",
      "link_type": "hospitality.link.channel_connection_for_property"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.channel_connection"
    }
  ]
}

Headers

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

Always no-store — uncommitted live data.

409

Section titled “409”

Conflict — concurrent modification or unique constraint violation the apply would hit.

422

Section titled “422”

Validation error — the apply would be rejected.