Skip to content

Recipient Definition

Title: Recipient Definition
Type object
Required No
Additional properties Any type allowed

Description: Voluptuous validation schema for Recipient_Definition

Property Pattern Type Deprecated
+ person No string No
- alias No string No
- email No string No
- target No Combination No
- phone_number No string No
- mobile_discovery No boolean No
- mobile_devices No array of object No
- delivery No object No

Property Recipient Definition > person
Type string
Required Yes

Property Recipient Definition > alias
Type string
Required No

Property Recipient Definition > email
Type string
Required No

Property Recipient Definition > target
Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
item 2
item 3
item 4

Property Recipient Definition > target > anyOf > item 0
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- No array of string No

Property Recipient Definition > target > anyOf > item 0 > additionalProperties
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
additionalProperties items -
Recipient Definition > target > anyOf > item 0 > additionalProperties > additionalProperties items
Type string
Required No

Property Recipient Definition > target > anyOf > item 1
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- No string No

Property Recipient Definition > target > anyOf > item 1 > additionalProperties
Type string
Required No

Property Recipient Definition > target > anyOf > item 2
Type string
Required No

Property Recipient Definition > target > anyOf > item 3
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
item 3 items -

Recipient Definition > target > anyOf > item 3 > item 3 items
Type string
Required No

Property Recipient Definition > target > anyOf > item 4
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- entity_id No array of string No
- device_id No array of string No
- area_id No array of string No
- floor_id No array of string No
- label_id No array of string No

Property Recipient Definition > target > anyOf > item 4 > entity_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
entity_id items -
Recipient Definition > target > anyOf > item 4 > entity_id > entity_id items
Type string
Required No

Property Recipient Definition > target > anyOf > item 4 > device_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
device_id items -
Recipient Definition > target > anyOf > item 4 > device_id > device_id items
Type string
Required No

Property Recipient Definition > target > anyOf > item 4 > area_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
area_id items -
Recipient Definition > target > anyOf > item 4 > area_id > area_id items
Type string
Required No

Property Recipient Definition > target > anyOf > item 4 > floor_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
floor_id items -
Recipient Definition > target > anyOf > item 4 > floor_id > floor_id items
Type string
Required No

Property Recipient Definition > target > anyOf > item 4 > label_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
label_id items -
Recipient Definition > target > anyOf > item 4 > label_id > label_id items
Type string
Required No

Property Recipient Definition > phone_number
Type string
Required No

Property Recipient Definition > mobile_discovery
Type boolean
Required No
Default true

Property Recipient Definition > mobile_devices
Type array of object
Required No
Default []
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
mobile_devices items -

Recipient Definition > mobile_devices > mobile_devices items
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- manufacturer No string No
- model No string No
- mobile_app_id No string No
- device_tracker No string No

Property Recipient Definition > mobile_devices > mobile_devices items > manufacturer
Type string
Required No

Property Recipient Definition > mobile_devices > mobile_devices items > model
Type string
Required No

Property Recipient Definition > mobile_devices > mobile_devices items > mobile_app_id
Type string
Required No

Property Recipient Definition > mobile_devices > mobile_devices items > device_tracker
Type string
Required No

Property Recipient Definition > delivery
Type object
Required No
Additional properties Each additional property must conform to the schema
Default {}
Property Pattern Type Deprecated
- No object No

Property Recipient Definition > delivery > additionalProperties
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- target No Combination No
- enabled No boolean No
- data No object No

Property Recipient Definition > delivery > additionalProperties > target
Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
item 2
item 3
item 4
Property Recipient Definition > delivery > additionalProperties > target > anyOf > item 0
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- No array of string No
Property Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > additionalProperties
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
additionalProperties items -
Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > additionalProperties > additionalProperties items
Type string
Required No
Property Recipient Definition > delivery > additionalProperties > target > anyOf > item 1
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- No string No
Property Recipient Definition > delivery > additionalProperties > target > anyOf > item 1 > additionalProperties
Type string
Required No
Property Recipient Definition > delivery > additionalProperties > target > anyOf > item 2
Type string
Required No
Property Recipient Definition > delivery > additionalProperties > target > anyOf > item 3
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
item 3 items -
Recipient Definition > delivery > additionalProperties > target > anyOf > item 3 > item 3 items
Type string
Required No
Property Recipient Definition > delivery > additionalProperties > target > anyOf > item 4
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- entity_id No array of string No
- device_id No array of string No
- area_id No array of string No
- floor_id No array of string No
- label_id No array of string No
Property Recipient Definition > delivery > additionalProperties > target > anyOf > item 4 > entity_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
entity_id items -
Recipient Definition > delivery > additionalProperties > target > anyOf > item 4 > entity_id > entity_id items
Type string
Required No
Property Recipient Definition > delivery > additionalProperties > target > anyOf > item 4 > device_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
device_id items -
Recipient Definition > delivery > additionalProperties > target > anyOf > item 4 > device_id > device_id items
Type string
Required No
Property Recipient Definition > delivery > additionalProperties > target > anyOf > item 4 > area_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
area_id items -
Recipient Definition > delivery > additionalProperties > target > anyOf > item 4 > area_id > area_id items
Type string
Required No
Property Recipient Definition > delivery > additionalProperties > target > anyOf > item 4 > floor_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
floor_id items -
Recipient Definition > delivery > additionalProperties > target > anyOf > item 4 > floor_id > floor_id items
Type string
Required No
Property Recipient Definition > delivery > additionalProperties > target > anyOf > item 4 > label_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
label_id items -
Recipient Definition > delivery > additionalProperties > target > anyOf > item 4 > label_id > label_id items
Type string
Required No

Property Recipient Definition > delivery > additionalProperties > enabled
Type boolean
Required No
Default true

Property Recipient Definition > delivery > additionalProperties > data
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- No object No

Generated using json-schema-for-humans on 2025-11-21 at 23:32:28 +0000