Skip to content
aerandil.com
GitHub

Validate Book appointment (dry-run)

POST
/v1/actions/hospitality.action.book_appointment/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.book_appointment/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "booked_at": "2026-04-15T12:00:00Z", "duration_minutes": 1, "external_record_reference_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "external_ref": "example", "guest_kind": "hotel_guest", "notes": "example", "outlet_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "person_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "price": { "amount": "example", "currency": "example" }, "provider_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "room_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "service_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "start_at": "2026-04-15T12:00:00Z" }, "return_modified": false }'

Dry-run of apply_hospitality_action_book_appointment’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
booked_at
When the booking was taken — business time, not record time (defaults to now)
string format: date-time
duration_minutes
Duration override in minutes (skill-level / guest-specific duration)
integer
external_record_reference_id
Clinical-record reference (mandatory when the bound modality requires_medical_licensing)
string format: uuid
external_ref
Source-system key for replayed / connector-landed bookings
string
guest_kind
Who the client is to the property (in-house capture dimension)
string
Allowed values: hotel_guest member external
notes
Front-desk / therapist notes (may carry intake detail)
string
outlet_id
required
Outlet the appointment trades under
string format: uuid
person_id
Guest the appointment is for (optional — desk walk-ins may book anonymously)
string format: uuid
price
Price override (skill-level / yield pricing; defaults to the service's list price)
object
amount
required
string format: decimal
currency
required
string format: iso-4217
provider_id
Provider / therapist (optional — may be assigned later via reschedule)
string format: uuid
room_id
Treatment room (optional — may be assigned later via reschedule)
string format: uuid
service_id
required
Service being booked
string format: uuid
start_at
required
Treatment start
string format: date-time
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"
}