RailFareSearch response 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
<RailFareSearchRS>
RailFareSearch response root element1
<InfoGroup>
Error and information group0..1
<ForInfo>
Information group0..N
@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.
@SourceRef
PNR Record Locator associated to Source attribute.0..1
@Code
A code to uniquely identify a specific type of ForInfo message. Currently not returned for most ForInfo messages.

0..1 I00001
@Lang
ISO language code. A two letter code as defined by ISO-639-1.

0..1 de
<Text/>
Information text or error text. 1..N Free flow text. Example: Invalid flight number
</ForInfo>
<Error>
Error group0..N
@ErrorType
Type of error. 1 Air
@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.
@SourceRef
PNR Record Locator associated to Source attribute.0..1
<Code/>
Error code or equipment type code. 1 0104 (error code), 747 (equipment code)
<Text/>
Information text or error text. 1..N Free flow text. Example: Invalid flight number
<UnderlyingError>
Errors of the backend system can be returned here.0..N
@Code
error code of the backend system.0..1
<Text/>
Information text or error text. 0..N Free flow text. Example: Invalid flight number
</UnderlyingError>
</Error>
<BackOffice>
Generic back office response container. Serves as a placeholder for any context specific content.0..1
</BackOffice>
</InfoGroup>
<Fare>
The Fare element represents a rail fare. A Fare refers to either:
1) a specific Connection of a specific OriginDestination (=one-way fare). In this case there will be exactly one OriginDestinationIDRef and one ConnectionIDRef child element.

2) or a set of two specific Connections, one from the outbound and one from the return OriginDestination of a round trip (=round-trip fare). In this case there will be exactly two OriginDestinationIDRef and two ConnectionIDRef elements.

For case 1), if more than one OriginDestination was requested, the Fare must be combined with a Fare for each of the remaining OriginDestiantions respectively to optain a fare for the complete itinerary. This may also apply for a round trip as not all round trip fares are returned as in case 2) but may also be optained by combining one-way fares!

When case 1) applies to a round trip, there may be restrictions regarding which "outbound" Fare (=referring only to the outbound OriginDestination) may be combined with which "return" Fare (=referring only to the return OriginDestination) - see element CompatibleFare.
1..N
@FareID
An ID uniqely identifying this Fare within this RailSearchRS.

1 F_1_6
@TotalPrice
Total price for this Fare including decimal places but without decimal separator (see CurrencyCode element for currency and decimal places).

1 23900
@IsEstimated
Is returned if source estimated the price rather than receiving the data directly from the supplier. Typically this occurs in cases where a final tax rate can’t be calculated until the booking stage, or if additional corporate discounts might apply to the fare. Values:
Y: price is estimated

[Y] 0..1 Y
@AvailabilityCheckBypassed
If AvailabilityCheckBypassed="Y", the provider system was not able to verify the fare is actually available in the supplier system. Values:
- "Y": availability of fare was not checked.

[Y] 0..1 Y
<CurrencyCode>
Currency code. 1 USD
@NumberOfDecimals
Decimal position in fare amount. 1 2
</CurrencyCode>
<FareComponent>
A Fare may consist of one or more FareComponents. Each FareComponent applies to a specific subset of all the segments the Fare applies to. Different FareComponents may have different Rules and TicketDeliveryOptions. To the Fare as a whole, the most restrictive of Rules of its FareComponents applies. If the Rules of multiple FareComponents imply penalties for a specific action, the penalties need to be added up.1..N
<RelatedSegment>
Each RelatedSegment element refers to one of the Segments the Fare and FareComponent applies to and provides detailed information for it.1..N
<SegmentIDRef/>
A reference to a Segment of one of the associated Connections. Its value refers to the Connection/Segment/@SegmentID value.

1 S_1_3_2
<ClassOfService/>
Class of service as designated by the source.
Values:
- PREMIUM
- FIRST
- SECOND
- THIRD

[PREMIUM] [FIRST] [SECOND] [THIRD] 1 SECOND
<CarrierClassOfService/>
The carrier’s name for the class of service.

1 Standard Premier
<Reservable/>
Indicates whether or not seat reservations are available for the RelatedSegment for this Fare.
Possible values are:
- OPTIONAL: Seat reservations are optionally available (specify RailService/@Type="ReservationWithSeat" and reference segment to request).

- MANDATORY: Seat reservations are mandatory and therefore automatically included in the fare (do NOT specify RailService to request).

- NOT_POSSIBLE: Seat reservations are not possible. Passenger MAY still be guaranteed to obtain a seat, but is not assigned a specific one as part of the booking.

[MANDATORY] [NOT_POSSIBLE] [OPTIONAL] 1 OPTIONAL
<Amenities>
0..1
<Amenity>
An individual train amenity available for on the RelatedSegment for this Fare - either for free or at an extra charge.

1..N WiFi access (Free)
@Type
A code specifying the the type of amenity offered.

[BAGGAGE] [BAR] [BUFFET] [DINING] [MEAL] [NEWSPAPER] [QUIET] [SNACK] [TAXI] [TROLLEY] [AUDIO] [VIDEO] [POWER_SOCKET] [LOUNGE_ACCESS] [INTERNET] [INTERNET_AVAILABLE] [PARKING] 1 INTERNET
</Amenity>
</Amenities>
<RewardsEligible/>
Returns Y if the RelatedSegment qualifies for points on the supplier’s loyalty or rewards program for this Fare. Otherwise returns N. Values.
- N
- Y

[N] [Y] 1 Y
<FareClass/>
The Carrier’s name for the type of Fare.

1 ANYTIME_DAY
<OpenReturn/>
Returns Y if the Fare is an open return for this RelatedSegment, good for any train within the restrictions of the fare rules and expiration date/time. Otherwise returns N. Values:
- N
- Y

[N] [Y] 1 Y
<FareExpirationDateTime/>
The UTC date/time after which the Fare is no longer valid for travel for this RelatedSegment, in YYYY-MM-DDTHH:MM:SSZ format. If FareExpirationDateTime is not returned, the Fare is only valid for this RelatedSegment up to the date and time of its departure.

0..1 2011-03-24T02:30:00Z
<FareApplicabilities>
A container element for one or more sets of fare applicability information.0..1
<FareApplicability>
Indicates if the Fare is open (can be used on any train), semi-open (can be used on some trains), or restricted (tied to a specific train) with respect to this RelatedSegment.

Currently only one Type is defined: SCHEDULE. Therefore will only occur once.
1
@Type
Type of FareApplicability. Only Type currently supported:
SCHEDULE

[SCHEDULE] 1 SCHEDULE
@Outbound
FareApplicability on outbound OriginDestination. Values:
- OPEN: can be used on any train
- SEMI-OPEN: can be used on some trains
- RESTRICTED: tied to a specific train

[OPEN] [SEMI-OPEN] [RESTRICTED] 0..1 SEMI-OPEN
@Return
FareApplicability on return OriginDestination if fare is a return fare. Values:
- OPEN: can be used on any train
- SEMI-OPEN: can be used on some trains
- RESTRICTED: tied to a specific train

[OPEN] [SEMI-OPEN] [RESTRICTED] 0..1 SEMI-OPEN
<Text/>
Optional text that provides additional information or information which is only available as free text.

0..1 Valid for off-peak trains after 8pm
</FareApplicability>
</FareApplicabilities>
</RelatedSegment>
<Discount>
A discount provided in the request which is applicable to this FareComponent.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
@AuthorizationCodeRequired
If AuthorizationCodeRequired="Y", an additional AuthorizationCode must be supplied for this Discount in PNRCreateRQ to be able to book this fare. Values:
- "Y": additional AuthorizationCode required

[Y] 0..1 Y
</Discount>
<OptionalServices>
A set of optional services which may be booked along with the Fare for an additional charge.0..1
<RailService>
Each RailService element represents an optional service which may be booked along with this Fare. Some RailServices may be mutually exclusive.

If SegmentIDRef child elements are returned for a RailService, the RailService may be booked for the specified segments or a subset of these. In this case, when requesting the RailService in the subsequent PNRCreateRQ the segments for which the RailService is requested must also be specified!
1..N
@Type
Type of RailService available.
Values:
- Accommodation
- Internet
- LocalTransit
- Meal
- ReservationWithSeats

[Accommodation] [Internet] [LocalTransit] [Meal] [ReservationSeatsOnly] [ReservationWithSeats] [TicketsByMail] [TicketsSeparateInAndOutbound] [CityTicketOutboundSingle] [CityTicketOutboundDay] [CityTicketInboundSingle] [CityTicketInboundDay] 1 ReservationWithSeat
@MinQuantity
The minimum number of segments for which this RailService must be requested (if it is requested at all). For instance there may be cases where a service may only be requested for all segments or non at all. For a FareComponent referring to 3 segments the @MinQuantity would then be returned as 3. Defaults to 1 if not present.

0..1 3
@MaxQuantity
The number of segments covered by the ServicePrice for this RailService. For example, if each optional seat reservation is charged separately, @MaxQuantity would be 1. If the specified ServicePrice covers the seat reservation of up to two segments it would be 2. Defaults to 1 if not present.

Note: @MaxQuantity does not limit the number of segments for which the RailService may be requested. If it is requested for a number of segments greater than @MaxQuanitity the ServicePrice is charged multiple times.

0..1 2.
<SegmentIDRef/>
A reference to a segment of the associated Connection(s) this RailService is available for. Its value refers to a Connection/Segment/@SegmentID value.

1..N S_1_3_2
<Description/>
Short description of this service as returned by the vendor.

1 Ticket with seat reservation
<DescriptionDetails>
Detailed or additional description as returned by the vendor.0..1
<Text/>
1..N Per seat and direction 3.50 EUR (for a maximum of two segments per direction).
</DescriptionDetails>
<ServicePrice>
The price for one "unit" of this RailService. Depending on the type of service, booking the service may actually result in a multiple of the price specified here. If for instance the service is a seat reservation the price may refer to a single seat on a single segment. If the service requested for 2 segments the resulting price is twice the price specified here.1
@Total
Total amount for this rail service. Integer value including decimal digits without decimal separator. Number of decimal digits and currency is defined by CurrencyCode/@NumberOfDecimals.

1 2000
</ServicePrice>
<Rules>
Rules applicable to this RailService.0..1
<Rule>
An individual rule that applies to this RailSearvice. Each rule applies to a specific booking status (as specified by @ApplicableBookingStatus). Typically, multiple rules are returned for each booking status. Note that the order in which rules appear in the response is not necessarily the order in which they apply. For rules of the same type, the execution sequence is determined by the @ExpirationDateTime.1..N
@Type
The type of this rule. Either an exchange/refund action allowed or prohibited for this item or TEXT for free text rules. Possible values are:
- EXCHANGE_ALLOWED This item is eligible for exchange.
- EXCHANGE_PROHIBITED This item cannot be exchanged.
- REFUND_ALLOWED This item is eligible for a refund.
- REFUND_PROHIBITED This item cannot be refunded.
- TEXT The Supplier has imposed other conditions on this item. The Text element contains additional information.
[EXCHANGE_ALLOWED] [EXCHANGE_PROHIBITED] [REFUND_ALLOWED] [REFUND_PROHIBITED] [TEXT] 1
@ApplicableBookingStatus
The stage in the booking process (as specified by /PNRViewRS//Rail/@BookingStatus) to which this rule applies. Values:
- BOOKED
- CONFIRMED
- TICKETED
- RETURNED

[BOOKED] [CONFIRMED] [TICKETED] [RETURNED] 0..1 CONFIRMED
@ApplicableTDO
If this rule only applies to a specific ticket delivery option, @ApplicableTDO is returned to specify which one it applies to. Values:
- PNR: Ticket is returned as part of PNRViewRS (to be printed out by customer).
- EML: Ticket is sent by email (to be printed out by customer).
- TBC: Ticket is handed out by conductor.
- TOF: Ticket to be picked up at ticket office.
- TVM: Ticket to be picked up at vending machine.
- TBM: Ticket is sent by standard mail.
- TBX: Ticket is sent by express mail.
- TBO: Ticket is sent by overnight mail.
- TML: Ticket is sent by MetroLink (Amtrak only).

[EML] [PNR] [TBC] [TBM] [TBO] [TBX] [TML] [TOF] [TVM] 0..1 EML
@ExpirationDateTime
The UTC date/time at which the refund/exchange window closes, in YYYY-MM-DDTHH:MM:SSZ format.
Where multiple rules have the same type and @ApplicableBookingStatus (for example, if refunds are only available for a certain amount of time after purchase), the @ExpirationDateTime determines the application sequence. The earliest-expiring rules apply first and rules with no @ExpirationDateTime apply last (when all rules with @ExpirationDateTime have expired).

0..1 2013-08-23T09:58:00Z
@IsEstimated
@IsEstimated is returned when the CRS estimated either the applicability of the rule or the amount of the penalty rather than receiving the data directly from the Supplier. Values:
Y: rule applicability and/or penalty amount is estimated.

[Y] 0..1 Y
<Text/>
Free text rule description. Will be returned if and only if @Type="TEXT". NOTE: It is mandatory to present this message to the passenger prior to ticket purchase.

0..1 Outbound: VALID AFTER 0929 MON-FRI
<Penalty>
Penalty which applies in case of exchange or refund. Only returned if @Type="EXCHANGE_ALLOWED" or "REFUND_ALLOWED" and a penalty applies.0..1
@Amount
The amount of the penalty to pay in case of exchange or refund with decimal places but without decimal separator (see CurrencyCode element for currency and decimal places).

1 2000
</Penalty>
</Rule>
</Rules>
<ReferenceKey/>
Unique reference key for this RailService. Must be included in subsequent requests.1
</RailService>
</OptionalServices>
<Rules>
A set of rules which apply to this FareComponent.1
<Rule>
An individual rule that applies to this FareComponent. Each rule applies to a specific booking status (as specified by @ApplicableBookingStatus). Typically, multiple rules are returned for each booking status. Note that the order in which rules appear in the response is not necessarily the order in which they apply. For rules of the same type, the execution sequence is determined by the @ExpirationDateTime.1..N
@Type
The type of this rule. Either an exchange/refund action allowed or prohibited for this item or TEXT for free text rules. Possible values are:
- EXCHANGE_ALLOWED This item is eligible for exchange.
- EXCHANGE_PROHIBITED This item cannot be exchanged.
- REFUND_ALLOWED This item is eligible for a refund.
- REFUND_PROHIBITED This item cannot be refunded.
- TEXT The Supplier has imposed other conditions on this item. The Text element contains additional information.
[EXCHANGE_ALLOWED] [EXCHANGE_PROHIBITED] [REFUND_ALLOWED] [REFUND_PROHIBITED] [TEXT] 1
@ApplicableBookingStatus
The stage in the booking process (as specified by /PNRViewRS//Rail/@BookingStatus) to which this rule applies. Values:
- BOOKED
- CONFIRMED
- TICKETED
- RETURNED

[BOOKED] [CONFIRMED] [TICKETED] [RETURNED] 0..1 CONFIRMED
@ApplicableTDO
If this rule only applies to a specific ticket delivery option, @ApplicableTDO is returned to specify which one it applies to. Values:
- PNR: Ticket is returned as part of PNRViewRS (to be printed out by customer).
- EML: Ticket is sent by email (to be printed out by customer).
- TBC: Ticket is handed out by conductor.
- TOF: Ticket to be picked up at ticket office.
- TVM: Ticket to be picked up at vending machine.
- TBM: Ticket is sent by standard mail.
- TBX: Ticket is sent by express mail.
- TBO: Ticket is sent by overnight mail.
- TML: Ticket is sent by MetroLink (Amtrak only).

[EML] [PNR] [TBC] [TBM] [TBO] [TBX] [TML] [TOF] [TVM] 0..1 EML
@ExpirationDateTime
The UTC date/time at which the refund/exchange window closes, in YYYY-MM-DDTHH:MM:SSZ format.
Where multiple rules have the same type and @ApplicableBookingStatus (for example, if refunds are only available for a certain amount of time after purchase), the @ExpirationDateTime determines the application sequence. The earliest-expiring rules apply first and rules with no @ExpirationDateTime apply last (when all rules with @ExpirationDateTime have expired).

0..1 2013-08-23T09:58:00Z
@IsEstimated
@IsEstimated is returned when the CRS estimated either the applicability of the rule or the amount of the penalty rather than receiving the data directly from the Supplier. Values:
Y: rule applicability and/or penalty amount is estimated.

[Y] 0..1 Y
<Text/>
Free text rule description. Will be returned if and only if @Type="TEXT". NOTE: It is mandatory to present this message to the passenger prior to ticket purchase.

0..1 Outbound: VALID AFTER 0929 MON-FRI
<Penalty>
Penalty which applies in case of exchange or refund. Only returned if @Type="EXCHANGE_ALLOWED" or "REFUND_ALLOWED" and a penalty applies.0..1
@Amount
The amount of the penalty to pay in case of exchange or refund with decimal places but without decimal separator (see CurrencyCode element for currency and decimal places).

1 2000
</Penalty>
@PriceType
The component of the price to which this rule applies. Values are:
- Ticket: rule applies to price of the rail ticket itself
- SeatReservation: rules applies to price for seat reservation(s)
- Accommodation: rule applies to price for accommodation (sleeper cars,...)
- OnboardServices: rule applies to price for optional onboard services booked with the ticket
- Fee: rules applies to service or transaction fees

[Ticket] [SeatReservation] [Accommodation] [OnboardServices] [Fee] 0..1 TICKET
</Rule>
</Rules>
</FareComponent>
<TicketDeliveryOptions>
TicketDeliveryOptions is returned if specific ticket delivery options are available for this Fare. NOTE: There may be further delivery options (e.g. by mail) for which no information can be provided at time of RailFareSearch. Their availability is only specified in PNRViewRS after the Fare was initially booked. If none of delivery options refered to by the attributes of TicketDeliveryOptions are available, the TicketDeliveryOptions element is left out.0..1
@Email
@Email is returned if customer can choose to have ticket delivered by email. Values: Y (yes).

[Y] 0..1 Y
@PNR
@PNR is returned if customer can choose to have ticket returned as part of PNRViewRS response. Values: Y (yes).

[Y] 0..1 Y
@Station
@Station is returned if customer can choose to pick up ticket at a station (ticket office or vending machine). Values: Y (yes). NOTE: This does NOT imply that the necessary facilities are available and open at the station and time of the first departure of the itinerary (see StationOnDeparture).

[Y] 0..1 Y
@StationOnDeparture
@StationOnDeparture is returned if customer can choose to pick up ticket at a station (ticket office or vending machine) AND the necessary facilities are available and open at the station and time of the first departure of the itinerary.

[Y] 0..1 Y
</TicketDeliveryOptions>
<OriginDestinationIDRef/>
The @OriginDestinationID of an OriginDestination this Fare refers to.

1..2 OD_1
<ConnectionIDRef/>
The @ConnectionID of an OriginDestination/Connection element this Fare refers to.

1..2 C_2_4
<FareRefKey/>
Unique key identifying this Fare. Must be included in subsequent requests for all segments referenced by the Fare.
1
<CompatibleFare>
If request is for a round trip, CompatibleFare will be returned for one-way Fare elements which may only be combined with specific one-way Fare elements for the opposite direction. When it is present, the respective Fare may only be combined with Fare elements for the opposite direction references by one of the FareIDRef child elements.

NOTE: If CompatibleFare is not present for a one-way fare, it may be combined with any one-way fare for the opposite direction.
0..1
<FareIDRef/>
A reference to the FareID of a one-way Fare for the opposite direction.

1..N F_1_3
</CompatibleFare>
</Fare>
<TransactionFees>
0..1
<TransactionFee>
A TransactionFee is a fee which applies per booking in addition to the fare. Each TransactionFee may apply to all or to specific OriginDestinations.1..N
@Amount
The amount of the TransactionFee including decimal places but without decimal separator (see CurrencyCode element for currency and decimal places).

1 1000
<CurrencyCode>
Currency code. 1 USD
@NumberOfDecimals
Decimal position in fare amount. 1 2
</CurrencyCode>
<Description/>
A description of the TransactionFee.

1 Renfe Booking Charge
<ApplicableOriginDestinations>
ApplicableOriginDestinations specifies to which OrginDestinations the fee applies. The fee applies to all OriginDestinationIDs referenced by OriginDestinationIDRef. If @MaxQuantity is less than the number of OriginDestinations the fee applies to, the @Amount is applied N times where N = (number of OriginDestinationIDRefs) / @MaxQuantity rounded to the next higher integer value.1
@MaxQuantity
The maximum number of OriginDestinations to which this TransactionFee applies.

1 2
<OriginDestinationIDRef/>
A reference to an OriginDestination to which this TransactionFee applies.

1..N OD_1
</ApplicableOriginDestinations>
</TransactionFee>
</TransactionFees>
<OriginDestination>
Each OriginDestination element corresponds to a respective OriginDestination element in the request.0..N
@OriginDestinationID
A string uniquely identifying this OriginDestination among all OriginDestination elements of this RailFareSearchRS.

1 OD_1
@DepartureStationCode
The departure station code specifed in the request for this OriginDestination.

1 GBRDG
@ArrivalStationCode
The arrival station code specifed in the request for this OriginDestination.

1 GBQQM
<Connection>
Each Connection element contains an alternative set of Segments to travel from origin to destination for the current OriginDestination. 1..N
@ConnectionID
A string uniquely identifying this Connection among all Connection elements of this RailFareSearchRS.

1 C_2_4
@VendorCode
The VendorCode indicates the vendor through which this Connection will be booked (referred to as "supply channel" by Silverrail).

1 AMT
@OvertakenConnection
The OvertakenConnection attribute is returned with value "Y" if and only if another Connection exists which departs later and arrives earlier than this Connection.
Values:
- N (default if not present): Connection is not overtaken by other Connection
- Y: Connection is overtaken by other Connection.

[N] [Y] 0..1 Y
<JourneyTime/>
Total journey time of the connection in hours and minutes: hh:mm.

0..1 30:45
<Segment>
Segment information group1..N
@SegmentID
An ID uniquely identifying this segment.

1 S_1_3_2
@Type
The Type of the rail segment specifies the means of transportation.

[Bus] [Car] [Ferry] [Ship] [Hovercraft] [Suburban] [Taxi] [Train] [Tram] [Transfer] [Underground] [Unknown] [Walking] 1 Train
<Departure>
Segment departure group1
<StationCode/>
Segment departure or arrival station code. 1 Berlin Hbf
<StationName/>
Segment departure or arrival station name. 1 Berlin Hbf
<Date/>
Segment departure or arrival date in ISO 8601 format (yyyy-mm-dd). 1 2001-12-25
<Time/>
Segment departure or arrival time in ISO 8601 (hh:mm). 1 14:30
</Departure>
<Arrival>
Segment arrival group1
<StationCode/>
Railway, point of interest, address or other station code.1
<StationName/>
Segment departure or arrival railway station name. 1 Berlin Hbf
<Date/>
Segment departure or arrival date in ISO 8601 format (yyyy-mm-dd). 1 2001-12-25
<Time/>
Segment departure or arrival time in ISO 8601 (hh:mm). 1 14:30
</Arrival>
<Carrier>
Carrier group0..1
<CarrierCode/>
A code identifying the carrier for this segment.

1 FirstGrtWest
<CarrierName/>
The name of the carrier for this segment.

1 First Great Western
<TrainNumber/>
Train number.

0..1 ICE 690
</Carrier>
<OperatingCarrier>
The OperatingCarrier element is returned when the Segment is operated by a different carrier than the one specfied in the Carrier element.0..1
<CarrierCode/>
A code identifying the operating carrier for this segment.

1 Virgin
<CarrierName/>
The name of the operating carrier for this segment.

1 Virgin Trains
</OperatingCarrier>
<Equipment>
Equipment group0..1
<Code/>
Error code or equipment type code. 1 0104 (error code), 747 (equipment code)
<Name/>
Equipment type name. 1 Boeing 747 series
<SupplierName/>
0..1
</Equipment>
<SegmentDuration/>
Duration of this particular segment in hours and minutes: hh:mm.

0..1 02:30
<ServiceText>
further service informations0..1
<Text/>
Information text or error text. 1..N Free flow text. Example: Invalid flight number
</ServiceText>
<AvailableSeatPreferences>
0..1
<AvailableSeatPreference>
A specifc seat preference available on this segment for a fare with the specified @ClassOfService.

Values:
- AIRLINE: Airline-style seat
- AISLE: Aisle Seat
- BACKWARD: backward facing seat
- COMPARTMENT: Compartment Seating Car
- FORWARD: forward facing seat
- LAVATORY: Near Lavatory
- LUGGAGE: Near Luggage Rack
- MIDDLE: Middle Seat
- PHONE: Mobile Phone Zone
- POWER: Power Socket
- QUIET: Quiet Zone
- SINGLE: Individual Solo Seat
- TABLE: Table Seat
- WINDOW: Window Seat

[FORWARD] [BACKWARD] [AIRLINE] [WINDOW] [AISLE] [COMPARTMENT] [MIDDLE] [QUIET] [TABLE] [POWER] [PHONE] [LUGGAGE] [LAVATORY] [SINGLE] 1..N AISLE
@ClassOfService
Class of service (as specified in referencing Fare//RelatedSegment) this seat preference is available to.

[PREMIUM] [FIRST] [SECOND] [THIRD] 1 SECOND
</AvailableSeatPreference>
</AvailableSeatPreferences>
</Segment>
<PassengerInformationRequired>
0..1
<PassengerInformation>
A specifc form of passenger information which must be supplied at time of booking.1..N
@Type
The type of passenger information required.
Values:
- PASSENGER_ADDRESS: An address will be required for the passenger.
- TRAVEL_DOCUMENTS: A travel document such as a passport will be required for the passenger. The types of documents accepted are defined by the AcceptableFormOfTravelDocument child elements.
- DATE_OF_BIRTH: A date of birth will be required for the passenger.
- GENDER: A statement of gender will be required for the passenger.
- RESIDENCE_INFORMATION: A two-character ISO country code will be required for the passenger. Use /PNRCrateRQ//TravelerName/Residence/CountryCode to specify

[PASSENGER_ADDRESS] [TRAVEL_DOCUMENTS] [DATE_OF_BIRTH] [GENDER] [RESIDENCE_INFORMATION] 1 GENDER
<AcceptableFormOfTravelDocument/>
A specific type of travel document accepted (only applies to PassengerInformation/@Type="TRAVEL_DOCUMENT").

Values:
- PERMRESIDENT: Permanent resident card
- PASSPORT: Passport
- NATURALCERT: Naturalization certificate
- MILORDER: Military orders

[PERMRESIDENT] [PASSPORT] [NATURALCERT] [MILORDER] 0..N TRAVEL_DOCUMENTS
</PassengerInformation>
</PassengerInformationRequired>
<ConnectionRefKey/>
Unique key identifying this Connection. Must be included in subsequent requests for all Segments of this Connection.
1
</Connection>
</OriginDestination>
</RailFareSearchRS>

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