Skip to content
aerandil.com
GitHub

Validate Card checks (dry-run)

POST
/v1/functions/hospitality.function.card_checks/validate
curl --request POST \
  --url https://api.aerandil.com/v1/functions/hospitality.function.card_checks/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "params": { "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } }'

Dry-run of invoke_hospitality_function_card_checks’s parameter checks. No handler dispatch, no store reads — just parameter shape, target presence, target type, unknown-parameter rejection.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
params
required
object
property_id
required
Property
string format: uuid
Examplegenerated
{
  "params": {
    "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  }
}

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.

Media typeapplication/json
object
errors

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

Array<string>
function
required
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"
}