Skip to content

What-if Grant consent (rollup delta)

POST
/v1/actions/hospitality.action.grant_consent/whatif
curl --request POST \
--url https://api.aerandil.com/v1/actions/hospitality.action.grant_consent/whatif \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "default_scope": {}, "effective_from": "2026-04-15T12:00:00Z", "effective_until": "2026-04-15T12:00:00Z", "min_cohort_size": 1, "policy_text_uri": "example", "purposes_grantable": [ "operational" ], "regulatory_basis": "example", "verified_by": "example" }, "return_modified": false }'

What-if projection of apply_hospitality_action_grant_consent — 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.grant_consent:apply scope as apply. An action that emits no rooms-fact events yields an empty daily_rooms.

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
default_scope
required
Default ConsentScope applied to objects without their own scope
object
key
additional properties
any
effective_from
required
When this policy version takes effect
string format: date-time
effective_until
When this policy version is superseded
string format: date-time
min_cohort_size
Kernel-level k-anonymity floor (default 5)
integer
policy_text_uri
Opaque pointer to the human-readable policy document
string
purposes_grantable
required
Purposes this policy may grant
Array<string>
Allowed values: operational benchmark_aggregate federated_query federated_training model_distillation fraud_network
regulatory_basis
required
Regulatory regime this policy is written under (GDPR / CCPA / UK DUA …)
string
verified_by
Principal::stable_id() of the DPO sign-off, when verified
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

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"
}
]
}
Cache-Control
string
Allowed value: no-store

Always no-store — derived, uncommitted data.

Validation error — the apply would be rejected.