Skip to content
aerandil.com
GitHub

Validate Record turnaway (dry-run)

POST
/v1/actions/hospitality.action.record_turnaway/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.record_turnaway/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "adults": 1, "arrival_date": "2026-04-15", "external_ref": "example", "guest_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "market_segment": "transient", "min_stay_in_force": 1, "nights": 1, "notes": "example", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "quoted_rate": { "amount": "example", "currency": "example" }, "rate_plan_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "reason": "sold_out", "requested_at": "2026-04-15T12:00:00Z", "room_type_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "source": "direct_web", "visitor_id": "example" }, "return_modified": false }'

Dry-run of apply_hospitality_action_record_turnaway’s parameter checks. No side effects, no idempotency reservation, no handler dispatch — just the schema pass plus action-level shape (target presence, target type, unknown-parameter rejection). return_modified is meaningless here and ignored.

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
adults
Adults asked for
integer
arrival_date
required
The arrival night asked for
string format: date
external_ref
Replay key from the recording source
string
guest_id
Who asked, when known
string format: uuid
market_segment
Market segment of the demand, when the desk could tell
string
Allowed values: transient group contract
min_stay_in_force
The minimum stay posted for the arrival at the time
integer
nights
required
Nights asked for
integer
notes
What the desk noted
string
property_id
required
The house that refused the request
string format: uuid
quoted_rate
Rate quoted
object
amount
required
string format: decimal
currency
required
string format: iso-4217
rate_plan_id
The plan the guest was quoted on, when a rate was offered
string format: uuid
reason
required
Why the request was refused
string
Allowed values: sold_out min_stay closed rate other
requested_at
When the guest asked (defaults to now; must not be in the future)
string format: date-time
room_type_id
Room type asked for, when one was
string format: uuid
source
Channel the request arrived through, when known
string
Allowed values: direct_web direct_call property_direct ota gds wholesale corporate walk_in group_block agent loyalty
visitor_id
The booking engine's key for the browser that asked, when its tag read one
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

Responses

Section titled “Responses”

200

Section titled “200”

Validation outcome. result is valid or invalid; per-parameter diagnostics are always populated for every declared parameter so a UI can render the action’s full surface.

Media typeapplication/json
object
action
required
string
errors

Action-level errors not tied to a single parameter (missing target, target type mismatch, unknown parameter names). Absent when empty.

Array<string>
parameters
required

Per-parameter diagnostics keyed by api_name.

object
key
additional properties
object
errors
Array<string>
result
required
Allowed values: valid invalid
value
required

The serialised value the server interpreted, or null if the parameter was not supplied.

result
required
Allowed values: valid invalid
Example
{
  "parameters": {
    "additionalProperty": {
      "result": "valid"
    }
  },
  "result": "valid"
}