Skip to content
aerandil.com
GitHub

Validate Define fault type (dry-run)

POST
/v1/actions/hospitality.action.define_fault_type/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.define_fault_type/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "brand_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "category": "hvac", "code": "example", "description": "example", "element": "light", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "severity": "cosmetic", "title": "example" }, "return_modified": false }'

Dry-run of apply_hospitality_action_define_fault_type’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
brand_id
The brand's catalogue (exactly one of brand_id / property_id)
string format: uuid
category
The trade that mends it (defaults to the element's)
string
Allowed values: hvac plumbing electrical furniture fixtures networking audio_visual structural exterior safety other
code
required
The catalogue's code for it
string
description
Notes for whoever raises or mends it
string
element
The room element the fault is in
string
Allowed values: light air_conditioning curtain safe door television phone wardrobe shower mirror toilet pipework minibar electrical other
property_id
One house's catalogue (exactly one of brand_id / property_id)
string format: uuid
severity
required
The severity an order raised from it starts at
string
Allowed values: cosmetic minor major blocking safety
title
required
The title an order raised from it is given
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"
}