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.
| Node | Description | Values | Occurs | Example |
|---|---|---|---|---|
<RailSearchRS> | Rail search response root element | 1 | ||
<InfoGroup> | Error and information group | 0..1 | ||
<ForInfo> | Information group | 0..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 group | 0..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> | ||||
<FareGroup> | Fare group containing all information regarding the air fares. It includes the type of fare, the passenger type and number in party as well as tax information and restrictions, if any. | 0..N | ||
@TravelerCount | Total number of passengers of all types for the entire itinerary. | [0] to [18] | 1 | 4 |
@TotalPrice | Total price for the entire itinerary for all passengers of all types. It is the sum of all TypeTotalPrice. | 1 | 320000 | |
@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. | |
<CurrencyCode> | Currency code. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<FareRules> | Fare rules information group | 1 | ||
<FareInfo> | A FareInfo element contains data related to a fare component used during pricing. Since a fare may consist of more than one fare component, a FareGroup may have more than one FareInfo element. | 1..N | ||
@FareType | Type of the fare. DB supports: CUST...customer price SAVE...savings fares STAN...standard fare | 1 | ||
<DepartureDate/> | The departure date of the first segment this FareInfo is related to. | 1 | 2002-12-25 | |
<DepartureCode/> | The station code of the departure station of the first segment this FareInfo is related to. | 1 | Berlin Hbf | |
<ArrivalCode/> | The station code of the arrival station of the last segment this FareInfo is related to. | 1 | Berlin Hbf | |
<ConnectionIDRef/> | The @ConnectionID of the OriginDestination/Connection element this FareInfo refers to. | 1 | 3 | |
<RelatedSegment> | A FareInfo element refers to specific Segment elements of its corresponding Connection. It has one RelatedSegment element for each Segment it refers to. | 1..N | ||
<SegmentIDRef/> | The value of the SegmentIDRef element is the relative position of the corresponding Segment element within the OriginDestination/Connection element referenced by the FareInfo/ConnectionIDRef. | 1 | 1 | |
<ClassOfService/> | 1 | |||
</RelatedSegment> | ||||
<Penalty> | Penalty group | 0..1 | ||
@TicketRefundable | Indicates if ticket is refundable or not. Values are: Y = Ticket is refundable N = Ticket is not refundable. | [Y] [N] | 0..1 | Y |
@DepositRequired | Indicates if deposit is required or not. Values are: Y = Deposit is required N = Deposit is not required. | [Y] [N] | 0..1 | Y |
@DepositRefundable | Indicates if deposit is refundable or not. Values are: Y = Deposit is refundable N = Deposit is not refundable. | [Y] [N] | 0..1 | Y |
<TicketText/> | Text related to the ticket penalty. Possible values: AD = ticket is not refundable after departure BD = ticket is not refundable before departure | [AD] [BD] | 0..1 | AD |
<FeeApplies> | Fee applies group | 0..1 | ||
@FailureToConfirm | Y = Pax must confirm space N = No confirmation required. | [Y] [N] | 0..1 | Y |
@Cancellation | Y = Cancellation Fee Applies N = No Cancel Fee. | [Y] [N] | 0..1 | Y |
@Carrier | Y = Carrier Fee applies N = No carrier fees. | [Y] [N] | 0..1 | Y |
@ReplaceTicket | Y = Replacement fee applies N = No replacement fee. | [Y] [N] | 0..1 | Y |
@ChangeItinerary | Y = Change Itinerary fee applies N = No change fee. | [Y] [N] | 0..1 | Y |
</FeeApplies> | ||||
<CurrencyCode> | If present, this element specifies the currency for all penalty amounts (see Change, Cancel,...). If missing, the FareGroup/CurrencyCode element applies. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<Change> | Change penalty group | 0..1 | ||
<Amount> | Penalty amount in currency amount or percentage. | 0..1 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage. | [M] [P] | 1 | M |
</Amount> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</Change> | ||||
<Cancel> | Cancel penalty group | 0..1 | ||
<Amount> | Penalty amount in currency amount or percentage. | 0..1 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage. | [M] [P] | 1 | M |
</Amount> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</Cancel> | ||||
<Failure> | Failure to confirm penalty group | 0..1 | ||
<Amount> | Penalty amount in currency amount or percentage. | 0..1 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage. | [M] [P] | 1 | M |
</Amount> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</Failure> | ||||
<Replace> | Replacement penalty group | 0..1 | ||
<Amount> | Penalty amount in currency amount or percentage. | 0..1 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage. | [M] [P] | 1 | M |
</Amount> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</Replace> | ||||
</Penalty> | ||||
<FareRefKey/> | Unique fare reference key. If present in pricing response messages, must be included in FareRulesRQ. | 0..1 | ||
<Remark/> | Fare rules miscellaneous remarks. | 0..N | See pax type | |
</FareInfo> | ||||
</FareRules> | ||||
</FareGroup> | ||||
<OriginDestination> | Each OriginDestination element corresponds to a respective OriginDestination element in the request. | 0..N | ||
@DepartureStationCode | The departure station code specifed in the request for this OriginDestination. | 1 | W102XAXXT | |
@ArrivalStationCode | The arrival station code specifed in the request for this OriginDestination. | 1 | W102XAXXT | |
<Connection> | Each Connection element contains an alternative set of Segments to travel from origin to destination. Each FareGroup refers to a set of Connection elements (by their ConnectionID attribute), one from each OriginDestination. | 1..N | ||
@ConnectionID | A string uniquely identifying this Connection among all Connection elements of this RailSearchRS. | 1 | 3 | |
<JourneyTime/> | Total journey time of the connection. | 0..1 | 13:45 | |
<TransferToFirstSegment> | If the initial locaion specified as Departure/StationCode does not acutually refer to a station but a different type of location, the TransferToFirstSegment element will be returned to provide information on the the transfer from the initial location to the begin of the first segment, if such information is available. | 0..1 | ||
@Time | Time required for transfer from initial location to first segment in hours and minutes. | 0..1 | 00:45 | |
@MeansOfTransfer | Means of transport assumed for transfer (and to which the @Time applies, if specified). | [BICYCLE] [CAR] [FOOT] [TAXI] | 0..1 | FOOT |
</TransferToFirstSegment> | ||||
<TransferFromLastSegment> | If the final locaion specified as Arrival/StationCode does not acutually refer to a station but a different type of location, use TransferFromLastSegment will be returned to provide information on the transfer from the last segment to the final location, if such information is available. | 0..1 | ||
@Time | Time required for transfer from last segment to final destination in hours and minutes. | 0..1 | 00:45 | |
@MeansOfTransfer | Means of transport assumed for transfer (and to which the @Time applies, if specified). | [BICYCLE] [CAR] [FOOT] [TAXI] | 0..1 | FOOT |
</TransferFromLastSegment> | ||||
<Segment> | Segment information group | 1..N | ||
@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 group | 1 | ||
<StationCode/> | Segment departure or arrival station code. | 1 | Berlin Hbf | |
<StationName/> | Segment departure or arrival station name. | 1 | Berlin Hbf | |
<Track/> | The track the train is scheduled to depart from. | 0..1 | 22 | |
<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 group | 1 | ||
<StationCode/> | Railway, point of interest, address or other station code. | 1 | ||
<StationName/> | Segment departure or arrival railway station name. | 1 | Berlin Hbf | |
<Track/> | The track the train is scheduled to depart from. | 0..1 | 22 | |
<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 group | 0..1 | ||
<CarrierCode/> | Carrier code. | 1 | 2V | |
<CarrierName/> | Carrier name. | 1 | Deutsche Bahn | |
<TrainNumber/> | Train number. | 0..1 | ||
</Carrier> | ||||
<Equipment> | Equipment group | 0..1 | ||
<Code/> | Error code or equipment type code. | 1 | 0104 (error code), 747 (equipment code) | |
<Name/> | Equipment type name. | 1 | Boeing 747 series | |
</Equipment> | ||||
<NumberOfStops/> | Number of stops. | 0..1 | 0 | |
<SegmentDuration/> | Segment total traveling time. | 0..1 | 01:30 | |
<ElectronicTicketing/> | Electronic ticketing indicator. Values are: Y = eticket can be issued N = no eticket possible. | [Y] [N] | 0..1 | Y |
<TransferTime/> | Time to transfer to the start point of the next segment | 0..1 | ||
<ServiceText> | further service informations | 0..1 | ||
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
</ServiceText> | ||||
</Segment> | ||||
</Connection> | ||||
</OriginDestination> | ||||
</RailSearchRS> |
| Column | Description |
|---|---|
| Node | Name 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. |
| Description | Description of meaning and usage of the node. |
| Values | List of predefined values (each in square brackets) or range of values ("[a] to [z]") allowed for the node, if formally defined in the schema. |
| Occurs | Minimum 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. |
| Example | Example value for the node. |
XML Schema documentation generated with XX/1 server