Skip to content

FieldDefinition

Properties

Name Type Description
propertyId string PropertyId
type string Traveler field type. Can be radio, text, select, etc.
additionalType string Additional type for field. Can be ProfileImage, TravelerProfileImage, etc. for media type fields.
name string Can be used as a label of a field
required boolean Is travelerField required?
requiredForOffers boolean Is this required to get an offer? null - not used for offers (default). false - can be used. true - must be used
possibleValue object Values of the field
rangeMin string Integer, number: number-date, dateTime: duration ISO 8601 duration
rangeMax string Integer, number: number-date, dateTime: duration ISO 8601 duration
rangeBasePropertyId string Property id from which range will be calculated (e.g. for ZH it is birthDate). Currently only DateTime validation supports it.
parentFieldPropertyId string Name of parent field property
parentFieldValue string Value of parent field property
parentFieldOperator string Operator which is used to check the value defined in ParentFieldPropertyId. If operator is not defined or wrong operator provided then 'equal' operator is used by default. Supported operators: 'equal' - (default) current value must be equal to ParentFieldValue property; 'notnullorempty' - can be applied on string and arrays and check that array/string contains value(s)
parentFieldType string Type of parent field property. Explicit definition is useful only when type is multiselect or checksum.
parentFieldModel string Parent model which should be used for validation. Supported types: OrderItem, Customer, Stay. Example: when validating travelers -> OrderItem or Customer properties can be used in parent fields.
readonly boolean Can this field be changed in the 'edit order item': null/false - the referenced property is editable. true - the referenced property must not change its value
requiredErrorName string Name of error message translated resource which is used to generate custom validation message instead of default Required validation message
customErrorNames object List of custom translated error message resources which are used to generate custom validation message instead of default Required, RangeMin and RangeMax validation messages if defined