travellerRequirements

Type: object

---

Properties overview

Property	Type	Required	Description
mode	mode		These classes are taken from the NeTeX standard, but ALL and UNKNOWN are remo...
subMode	shortString		short string, display names (length 0-75)
class	classOfUse		A classification of fare and other service classes by category of user entitl...
operators	array[operatorReference]
products	array[productReference]
assets	array[assetReference]
zones	array[zoneReference]
distribution	array[distribution]
avoid	object
previousLeg	object		when this leg is part of a sequence, refer to the previous (external) leg
estimatedUsage	object
prmNeeds	array[prmNeeds]

Detailed Properties

• mode (mode) - optional
  These classes are taken from the NeTeX standard, but ALL and UNKNOWN are removed. On the other hand OTHER and PARKING are added.

• subMode (shortString) - optional
  short string, display names (length 0-75)

• class (classOfUse) - optional
  A classification of fare and other service classes by category of user entitled to use them.

• operators (array[operatorReference]) - optional

• products (array[productReference]) - optional

• assets (array[assetReference]) - optional

• zones (array[zoneReference]) - optional

• distribution (array[distribution]) - optional
  Array item properties:

  • accessType (enum (BARCODE, QRCODE, AZTECCODE, REMOTE, DEEP_LINK, ...)) - optional
    A way to open/access the asset OR a proof of travel rights
    
    BARCODE a barcode can be retrieved from the links and used to access the purchased service
    QRCODE a QR code can be retrieved from the links
    AZTECCODE an Aztec code can be retrieved from the links
    REMOTE the /processes/start-leg/execution must be used to open the asset
    DEEP_LINK a deep link into a proprietary app is provided in the links to open the asset (NFC, Bluetooth)
    KEY a physical key must be obtained (see instructions) to open the asset
    
  • distributionChannel (string) - optional
    default string, full names etc (length 0-200)

• avoid (object) - optional

  • places (array[placeReference]) - optional
  • zones (array[zoneReference]) - optional
  • lines (array[lineReference]) - optional

• previousLeg (object) - optional
  when this leg is part of a sequence, refer to the previous (external) leg

  • operator (operatorReference) - optional
    default string, full names etc (length 0-200)
  • product (productReference) - optional
    default string, full names etc (length 0-200)
  • package (packageReference) - optional
    default string, full names etc (length 0-200)
  • leg (legReference) - optional
    default string, full names etc (length 0-200)
  • asset (assetReference) - optional
    default string, full names etc (length 0-200)

• estimatedUsage (object) - optional

  • time (duration) - optional
    value: "/-?P?=\d|T\d?:\d+Y??:\d+M??:\d+[DW]??:T?:\d+H??:\d+M??:\d+?:.\d+?S??/" duration, ISO 8601 compliant
  • distanceType (enum (KM, MILE)) - optional
  • distance (float) - optional
    the travelled distance. Only if applicable.

• prmNeeds (array[prmNeeds]) - optional
  Array item properties:

  • encumbranceNeed (enum (pushchair, baggage_trolley, oversized_baggage, luggage_encumbrance, guide_dog, ...)) - optional
  • medicalNeed (enum (heart_condition, other)) - optional
  • mobilityNeed (enum (wheelchair, assisted_wheelchair, motorized_wheelchair, mobility_scooter, road_mobility_scooter, ...)) - optional
  • psychoSensoryNeed (enum (visual_impaired, auditory_impaired, cognitive_impaired, averse_to_lifts, averse_to_escalators, ...)) - optional

Example

{
  "mode": "AIR",
  "subMode": "example-string",
  "class": "FIRST_CLASS"
}