RailFareSearch request message

Tabular overview of all nodes, which may occur in this message. See legend below for description of table columns.
Note: Some sibling elements or complete sub-trees of the hierarchy may be defined as mutually exclusive alternative choices. This information cannot be expressed in this tabular overview. Please refer to schema diagram for a graphical representation of the message schema.

NodeDescriptionValuesOccursExample
<RailFareSearchRQ>
RailFareSearch request root element1
@version
Version number. 0..1 1.0
@Source
Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. 0..1 1A, 1V, or other.
<Traveler>
Data related to the traveler. Currently only one traveler is supported.1
@Type
Passenger type. Only type currently supported is
ADT= Adult

[ADT] 1 ADT
<Discount>
A discount to be applied for this Traveler.0..N
@Type
The type of discount to be applied for the Traveler.

[AmtrakAAA] [AmtrakCorporate] [AmtrakIntlStudentID] [AmtrakNatAssocRailPax] [AmtrakStudentAdvantage] [AmtrakUSArmedForces] [AmtrakVeteranAdvantage] [AtocUKAnnualGold] [AtocUKChildDisability] [AtocUKDisability] [AtocUKFamilyFriends] [AtocUKGroupsave3] [AtocUKGroupsave4] [AtocUKHMArmedForces] [AtocUKJobcentrePlus] [AtocUKNetwork] [AtocUKSenior] [AtocUKTwoTogether] [AtocUKYouth] [BahnCard1st25] [BahnCard2nd25] [BahnCard1st50] [BahnCard2nd50] [BahnCardBusiness1st25] [BahnCardBusiness2nd25] [BahnCardBusiness1st50] [BahnCardBusiness2nd50] [A-VORTEILScardInclRAILPLUS] [CH-HalbtaxAboInclRAILPLUS] [CH-HalbtaxAbo] [NL-VoordeelurenaboInclRAILPLUS] [NL-Voordeelurenabo] [RAILPLUS] [DBCorporate] [EurostarCorporate] [RenfeCarnetGo25ISTC] [RenfeCarnetJoven] [RenfeCorporate] [RenfeTarjetaDorada] [RenfeTarjetaJovenRenfe] [RenfeTarjetaRailPlusJunior] [ThalysCorporate] [VIACorporate] 1 BahnCard2nd25
@Code
A discount code required for the chosen Discount/@Type. Only some discount Types require an accompanying code (e.g. corporate discount types).

0..1 893443
</Discount>
<Age/>
Traveler age at time of travel.

1 35
<DateOfBirth/>
Date of birth of the traveler in ISO 8601 format (yyyy-mm-dd).

1 1980-10-31
</Traveler>
<OriginDestination>
Each OriginDestination requests transport from a point of origin to a point of destination.1..N
<Departure>
Point of origin for this OriginDestination.1
<StationCode/>
Railway, point of interest, address or other station code.1
</Departure>
<Arrival>
Point of destination for this OriginDestination.1
<StationCode/>
Railway, point of interest, address or other station code.1
</Arrival>
<Date>
Departure or arrival date (see @Qualifier) in ISO 8601 format (yyyy-mm-dd).

1 2001-12-25
@Qualifier
The Qualifer indicates if search is by departure or arrival date (and time).

Values:
- DEPARTURE (default if left out)
- ARRIVAL

[DEPARTURE] [ARRIVAL] 0..1 ARRIVAL
</Date>
<Preferences>
Preferences group0..1
<Time/>
Departure or arrival time (see Date/@Qualifier) in ISO 8601 twenty-four hour clock format (hh:mm).

If a time is specified and search is by departure, search is restricted to connections leaving on or after the time specified on the given date.

If a time is specified and search is by arrival, search is restricted to connections arriving on or before the time specified on the given date.


1 14:25
</Preferences>
</OriginDestination>
</RailFareSearchRQ>

Legend

ColumnDescription
NodeName of message node (element or attribute). Nodes in bold type are mandatory, if their parent element occurs in the message. Point mouse cursor at table cell to view complete XPath.
DescriptionDescription of meaning and usage of the node.
ValuesList of predefined values (each in square brackets) or range of values ("[a] to [z]") allowed for the node, if formally defined in the schema.
OccursMinimum and maximum number of times the node must/may occur, if its parent element occurs in the message. Examples:
0..3 Node is optional and may occur up to 3 times.
1..N Node must occur at least one (mandatory) and may occur any number of times.
2 Node must occur exactly twice.
ExampleExample value for the node.

XML Schema documentation generated with XX/1 server