Definition Type: Element
Name: OTA_AirFareDisplayRQ
Namespace: http://www.opentravel.org/OTA/2003/05
Containing Schema: OTA_AirFareDisplayRQ.xsd
Abstract
Documentation:
The air fare display request enables display of fares between a given city pair.
Collapse XSD Schema Diagram:
Drilldown into Account in schema ota_airfaredisplayrq_xsd Drilldown into TravelerInfoSummary in schema ota_airfaredisplayrq_xsd Drilldown into TravelPreferences in schema ota_airfaredisplayrq_xsd Drilldown into SpecificFlightInfo in schema ota_airfaredisplayrq_xsd Drilldown into OriginDestinationInformation in schema ota_airfaredisplayrq_xsd Drilldown into POS in schema ota_airfaredisplayrq_xsd Drilldown into DisplayOrder in schema ota_airfaredisplayrq_xsd Drilldown into AvailableFlightsOnly in schema ota_airfaredisplayrq_xsd Drilldown into DirectFlightsOnly in schema ota_airfaredisplayrq_xsd Drilldown into MaxResponses in schema ota_commontypes_xsd1 Drilldown into MaxResponsesGroup in schema ota_commontypes_xsd1 Drilldown into RetransmissionIndicator in schema ota_commontypes_xsd1 Drilldown into AltLangID in schema ota_commontypes_xsd1 Drilldown into AltLangID_Group in schema ota_commontypes_xsd1 Drilldown into PrimaryLangID in schema ota_commontypes_xsd1 Drilldown into PrimaryLangID_Group in schema ota_commontypes_xsd1 Drilldown into TransactionStatusCode in schema ota_commontypes_xsd1 Drilldown into SequenceNmbr in schema ota_commontypes_xsd1 Drilldown into TransactionIdentifier in schema ota_commontypes_xsd1 Drilldown into Version in schema ota_commontypes_xsd1 Drilldown into Target in schema ota_commontypes_xsd1 Drilldown into TimeStamp in schema ota_commontypes_xsd1 Drilldown into EchoToken in schema ota_commontypes_xsd1 Drilldown into OTA_PayloadStdAttributes in schema ota_commontypes_xsd1XSD Diagram of OTA_AirFareDisplayRQ in schema ota_airfaredisplayrq_xsd (Open Travel (OTA))
Collapse XSD Schema Code:
<xs:element name="OTA_AirFareDisplayRQ">
    <xs:annotation>
        <xs:documentation xml:lang="en">The air fare display request enables display of fares between a given city pair.</xs:documentation>
    </xs:annotation>
    <xs:complexType>
        <xs:sequence>
            <xs:element name="POS" type="POS_Type">
                <xs:annotation>
                    <xs:documentation xml:lang="en">Point of sale object. </xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="OriginDestinationInformation" maxOccurs="5">
                <xs:annotation>
                    <xs:documentation xml:lang="en">Origin and Destination location as well as all fare related detail information required for fare display.</xs:documentation>
                </xs:annotation>
                <xs:complexType>
                    <xs:complexContent>
                        <xs:extension base="OriginDestinationInformationType">
                            <xs:attribute name="RPH" type="RPH_Type" use="optional">
                                <xs:annotation>
                                    <xs:documentation xml:lang="en">A placeholder for OriginDestinationInformation to be referenced wihin the OTA_AirLowFareSearchRS message. PricedItineraryType carries the reference to this RPH. </xs:documentation>
                                </xs:annotation>
                            </xs:attribute>
                        </xs:extension>
                    </xs:complexContent>
                </xs:complexType>
            </xs:element>
            <xs:element name="SpecificFlightInfo" minOccurs="0">
                <xs:annotation>
                    <xs:documentation xml:lang="en">Specify actual airline, flight number, or booking class.</xs:documentation>
                </xs:annotation>
                <xs:complexType>
                    <xs:complexContent>
                        <xs:extension base="SpecificFlightInfoType">
                            <xs:attribute name="BookingReferenceID" type="xs:string" use="optional">
                                <xs:annotation>
                                    <xs:documentation xml:lang="en">This is the identifier returned by the booking system, also referred to as a PNR locator, confirmation number or reservation number from where the flight information is taken from.</xs:documentation>
                                </xs:annotation>
                            </xs:attribute>
                        </xs:extension>
                    </xs:complexContent>
                </xs:complexType>
            </xs:element>
            <xs:element name="TravelPreferences" minOccurs="0">
                <xs:annotation>
                    <xs:documentation xml:lang="en">Contains travel preference information.</xs:documentation>
                </xs:annotation>
                <xs:complexType>
                    <xs:complexContent>
                        <xs:extension base="AirSearchPrefsType">
                            <xs:sequence>
                                <xs:element name="FareApplicationTypePref" minOccurs="0">
                                    <xs:annotation>
                                        <xs:documentation xml:lang="en">Indicates the journey type for which fares are required e.g. OneWay, Return, HalfReturn </xs:documentation>
                                    </xs:annotation>
                                    <xs:complexType>
                                        <xs:attribute name="FareApplicationType" type="FareApplicationType" use="required">
                                            <xs:annotation>
                                                <xs:documentation xml:lang="en">The journey type for which fares are required can be OneWay, Return or HalfReturn</xs:documentation>
                                            </xs:annotation>
                                        </xs:attribute>
                                        <xs:attribute name="PreferLevel" type="PreferLevelType" use="optional" />
                                    </xs:complexType>
                                </xs:element>
                                <xs:element name="FareTypePref" minOccurs="0" maxOccurs="5">
                                    <xs:annotation>
                                        <xs:documentation xml:lang="en">Indicates the type of fare required e.g. unrestricted, excursion etc.</xs:documentation>
                                    </xs:annotation>
                                    <xs:complexType>
                                        <xs:attributeGroup ref="FareTypePrefGroup">
                                            <xs:annotation>
                                                <xs:documentation xml:lang="en">The type of fare preferred and the preference level for this fare type.</xs:documentation>
                                            </xs:annotation>
                                        </xs:attributeGroup>
                                    </xs:complexType>
                                </xs:element>
                                <xs:element name="FareAccessTypePref" minOccurs="0" maxOccurs="5">
                                    <xs:annotation>
                                        <xs:documentation xml:lang="en">Indicates the fare calculation type e.g. (PointToPoint, Through, Joint, Private)</xs:documentation>
                                    </xs:annotation>
                                    <xs:complexType>
                                        <xs:sequence>
                                            <xs:element name="NegotiatedFareCodes" minOccurs="0">
                                                <xs:annotation>
                                                    <xs:documentation xml:lang="en">Container for multiple negotiated fare codes</xs:documentation>
                                                </xs:annotation>
                                                <xs:complexType>
                                                    <xs:sequence>
                                                        <xs:element name="NegotiatedFareCode" maxOccurs="99">
                                                            <xs:annotation>
                                                                <xs:documentation xml:lang="en">Account code required to access fares</xs:documentation>
                                                            </xs:annotation>
                                                            <xs:complexType>
                                                                <xs:simpleContent>
                                                                    <xs:extension base="xs:string">
                                                                        <xs:attribute name="Code" type="StringLength1to16" use="required">
                                                                            <xs:annotation>
                                                                                <xs:documentation xml:lang="en">Negotiated fare code to use when retrieving fare contracts</xs:documentation>
                                                                            </xs:annotation>
                                                                        </xs:attribute>
                                                                        <xs:attribute name="CodeContext" type="StringLength1to32" use="optional">
                                                                            <xs:annotation>
                                                                                <xs:documentation xml:lang="en">Optional indicator to specify code list used</xs:documentation>
                                                                            </xs:annotation>
                                                                        </xs:attribute>
                                                                    </xs:extension>
                                                                </xs:simpleContent>
                                                            </xs:complexType>
                                                        </xs:element>
                                                    </xs:sequence>
                                                </xs:complexType>
                                            </xs:element>
                                        </xs:sequence>
                                        <xs:attribute name="FareAccess" type="FareAccessPrefType" use="optional">
                                            <xs:annotation>
                                                <xs:documentation xml:lang="en">Fare calculation type (e.g. PointToPoint, Through, Joint, Private)</xs:documentation>
                                            </xs:annotation>
                                        </xs:attribute>
                                        <xs:attribute name="PreferLevel" type="PreferLevelType" use="optional" />
                                    </xs:complexType>
                                </xs:element>
                                <xs:element name="BookingClassPref" minOccurs="0" maxOccurs="5">
                                    <xs:annotation>
                                        <xs:documentation xml:lang="en">Booking Classes (RBD's) to include or exclude)</xs:documentation>
                                    </xs:annotation>
                                    <xs:complexType>
                                        <xs:attribute name="ResBookDesigCode" type="AlphaLength1to2" use="required">
                                            <xs:annotation>
                                                <xs:documentation xml:lang="en">The booking class code</xs:documentation>
                                            </xs:annotation>
                                        </xs:attribute>
                                        <xs:attribute name="PreferLevel" type="PreferLevelType" use="optional" />
                                    </xs:complexType>
                                </xs:element>
                                <xs:element name="PricingPrefs" minOccurs="0">
                                    <xs:annotation>
                                        <xs:documentation xml:lang="en">Specify whether prices returned should include Taxes, ServicesFees</xs:documentation>
                                    </xs:annotation>
                                    <xs:complexType>
                                        <xs:sequence>
                                            <xs:element name="ExchangeRates" minOccurs="0">
                                                <xs:annotation>
                                                    <xs:documentation xml:lang="en">Container for exchange rate elements </xs:documentation>
                                                </xs:annotation>
                                                <xs:complexType>
                                                    <xs:sequence>
                                                        <xs:element name="ExchangeRate" maxOccurs="10">
                                                            <xs:annotation>
                                                                <xs:documentation xml:lang="en">Specify a particular exchange rate to use in the response.</xs:documentation>
                                                            </xs:annotation>
                                                            <xs:complexType>
                                                                <xs:attributeGroup ref="ExchangeRateGroup">
                                                                    <xs:annotation>
                                                                        <xs:documentation xml:lang="en">Group of attributes used to express an Exchange Rate between 2 currencies</xs:documentation>
                                                                    </xs:annotation>
                                                                </xs:attributeGroup>
                                                            </xs:complexType>
                                                        </xs:element>
                                                    </xs:sequence>
                                                </xs:complexType>
                                            </xs:element>
                                        </xs:sequence>
                                        <xs:attribute name="IncludeTaxInd" type="xs:boolean" use="optional">
                                            <xs:annotation>
                                                <xs:documentation xml:lang="en">When true, response should include taxes.</xs:documentation>
                                            </xs:annotation>
                                        </xs:attribute>
                                        <xs:attribute name="IncludeServiceFeesInd" type="xs:boolean" use="optional">
                                            <xs:annotation>
                                                <xs:documentation xml:lang="en">When true, response should include service fee information.</xs:documentation>
                                            </xs:annotation>
                                        </xs:attribute>
                                        <xs:attribute name="OverrideCurrency" type="AlphaLength3" use="optional">
                                            <xs:annotation>
                                                <xs:documentation xml:lang="en">Specifies the currency for pricing that overrides that in point of sale. Use ISO 4217, 3 alpha code.</xs:documentation>
                                            </xs:annotation>
                                        </xs:attribute>
                                        <xs:attribute name="AlternateCurrency" type="AlphaLength3" use="optional">
                                            <xs:annotation>
                                                <xs:documentation xml:lang="en">Specifies the alternate currency for pricing other than that in point of sale or the override currency. Use ISO 4217, 3 alpha code.</xs:documentation>
                                            </xs:annotation>
                                        </xs:attribute>
                                        <xs:attribute name="IncludeBaseAmtInd" type="xs:boolean" use="optional">
                                            <xs:annotation>
                                                <xs:documentation xml:lang="en">If true, the base amount should be returned in the response.  If false, it does not need to be returned.
</xs:documentation>
                                            </xs:annotation>
                                        </xs:attribute>
                                        <xs:attribute name="MaxRateAmount" type="Money" use="optional">
                                            <xs:annotation>
                                                <xs:documentation xml:lang="en">The maximum rate that a traveler is willing to pay.
</xs:documentation>
                                            </xs:annotation>
                                        </xs:attribute>
                                        <xs:attribute name="MaxCalculatedRateAmount" type="Money" use="optional">
                                            <xs:annotation>
                                                <xs:documentation xml:lang="en">The maximum calculated rate that a traveler is willing to pay.
</xs:documentation>
                                            </xs:annotation>
                                        </xs:attribute>
                                        <xs:attribute name="CurrencyOption" use="optional">
                                            <xs:annotation>
                                                <xs:documentation xml:lang="en">May be used to specify why an override currency is being included.</xs:documentation>
                                            </xs:annotation>
                                            <xs:simpleType>
                                                <xs:restriction base="xs:NMTOKEN">
                                                    <xs:enumeration value="FilingCurrency">
                                                        <xs:annotation>
                                                            <xs:documentation xml:lang="en">Display fares filed in a specific currency (i.e., the override currency).</xs:documentation>
                                                        </xs:annotation>
                                                    </xs:enumeration>
                                                    <xs:enumeration value="ConvertToCurrency">
                                                        <xs:annotation>
                                                            <xs:documentation xml:lang="en">Convert fares to a specific currency
 (i.e., the override currency).</xs:documentation>
                                                        </xs:annotation>
                                                    </xs:enumeration>
                                                </xs:restriction>
                                            </xs:simpleType>
                                        </xs:attribute>
                                    </xs:complexType>
                                </xs:element>
                                <xs:element name="GlobalIndicatorPref" minOccurs="0" maxOccurs="5">
                                    <xs:annotation>
                                        <xs:documentation xml:lang="en">Specify global direction preferences (e.g. AP- Atlantic Ocean, PA, Pacific Ocean etc.)</xs:documentation>
                                    </xs:annotation>
                                    <xs:complexType>
                                        <xs:attribute name="GlobalIndicatorCode" use="optional">
                                            <xs:annotation>
                                                <xs:documentation xml:lang="en">AP - Atlantic Ocean
PA - Pacific Ocean
WH - Western Hemisphere
EH - Eastern Hemisphere
PO - Polar Route
TS - Trans Siberia Route
AP - Atlantic/Pacific Round-the-World</xs:documentation>
                                            </xs:annotation>
                                            <xs:simpleType>
                                                <xs:restriction base="xs:NMTOKEN">
                                                    <xs:enumeration value="AT" />
                                                    <xs:enumeration value="PA" />
                                                    <xs:enumeration value="WH" />
                                                    <xs:enumeration value="EH" />
                                                    <xs:enumeration value="PO" />
                                                    <xs:enumeration value="TS">
                                                        <xs:annotation>
                                                            <xs:documentation xml:lang="en">Trans Siberian.</xs:documentation>
                                                        </xs:annotation>
                                                    </xs:enumeration>
                                                    <xs:enumeration value="AP">
                                                        <xs:annotation>
                                                            <xs:documentation xml:lang="en">Atlantic Pacific.</xs:documentation>
                                                        </xs:annotation>
                                                    </xs:enumeration>
                                                    <xs:enumeration value="SP" />
                                                </xs:restriction>
                                            </xs:simpleType>
                                        </xs:attribute>
                                        <xs:attribute name="CodeContext" type="StringLength1to32" use="optional" default="IATA">
                                            <xs:annotation>
                                                <xs:documentation xml:lang="en">The code list from which the global indicator code is valid</xs:documentation>
                                            </xs:annotation>
                                        </xs:attribute>
                                        <xs:attribute name="PreferLevel" type="PreferLevelType" use="optional" />
                                    </xs:complexType>
                                </xs:element>
                            </xs:sequence>
                            <xs:attribute name="DistributorInfoInd" type="xs:boolean" use="optional">
                                <xs:annotation>
                                    <xs:documentation xml:lang="en"> If true, the distributor information should be returned with the fare. </xs:documentation>
                                </xs:annotation>
                            </xs:attribute>
                            <xs:attribute name="TicketDesignatorCode" type="StringLength1to16" use="optional">
                                <xs:annotation>
                                    <xs:documentation xml:lang="en">Specifies that the fare being requested is for this ticket designator code.
</xs:documentation>
                                </xs:annotation>
                            </xs:attribute>
                            <xs:attribute name="HistoricalFareInfoDate" type="DateOrDateTimeType" use="optional">
                                <xs:annotation>
                                    <xs:documentation xml:lang="en">If the fare request is for a previously issued ticket, this is the date on which it was issued.
</xs:documentation>
                                </xs:annotation>
                            </xs:attribute>
                            <xs:attribute name="ReqFareLoadDateInd" type="xs:boolean" use="optional">
                                <xs:annotation>
                                    <xs:documentation xml:lang="en">If true, the fare load date information is being requested.</xs:documentation>
                                </xs:annotation>
                            </xs:attribute>
                        </xs:extension>
                    </xs:complexContent>
                </xs:complexType>
            </xs:element>
            <xs:element name="TravelerInfoSummary" minOccurs="0">
                <xs:annotation>
                    <xs:documentation xml:lang="en">Information regarding the numbers and types of passengers.</xs:documentation>
                </xs:annotation>
                <xs:complexType>
                    <xs:sequence>
                        <xs:element name="PassengerTypeQuantity" maxOccurs="10">
                            <xs:annotation>
                                <xs:documentation xml:lang="en">Specify number of passengers using Passenger Type Codes. </xs:documentation>
                            </xs:annotation>
                            <xs:complexType>
                                <xs:complexContent>
                                    <xs:extension base="PassengerTypeQuantityType">
                                        <xs:sequence>
                                            <xs:element name="ReductionPref" minOccurs="0">
                                                <xs:annotation>
                                                    <xs:documentation xml:lang="en">Specify a desired reduction amount or percentage for this passenger type</xs:documentation>
                                                </xs:annotation>
                                                <xs:complexType>
                                                    <xs:attribute name="Amount" type="Money" use="optional">
                                                        <xs:annotation>
                                                            <xs:documentation xml:lang="en">The desired reduction amount</xs:documentation>
                                                        </xs:annotation>
                                                    </xs:attribute>
                                                    <xs:attribute name="Currency" type="AlphaLength3" use="optional">
                                                        <xs:annotation>
                                                            <xs:documentation xml:lang="en">The desired reduction currency</xs:documentation>
                                                        </xs:annotation>
                                                    </xs:attribute>
                                                    <xs:attribute name="Percent" type="Percentage" use="optional">
                                                        <xs:annotation>
                                                            <xs:documentation xml:lang="en">The desired reduction percentage</xs:documentation>
                                                        </xs:annotation>
                                                    </xs:attribute>
                                                    <xs:attribute name="PreferLevel" type="PreferLevelType" use="optional" />
                                                </xs:complexType>
                                            </xs:element>
                                        </xs:sequence>
                                    </xs:extension>
                                </xs:complexContent>
                            </xs:complexType>
                        </xs:element>
                    </xs:sequence>
                </xs:complexType>
            </xs:element>
            <xs:element name="Account" minOccurs="0" maxOccurs="99">
                <xs:annotation>
                    <xs:documentation xml:lang="en">Specifies an account code for which fares are requested.</xs:documentation>
                </xs:annotation>
                <xs:complexType>
                    <xs:attribute name="CodeOnlyFaresInd" type="xs:boolean" use="optional">
                        <xs:annotation>
                            <xs:documentation xml:lang="en">If true, return only the fares for the specified account code.  If false, also return other fares.

</xs:documentation>
                        </xs:annotation>
                    </xs:attribute>
                    <xs:attribute name="Code" type="StringLength1to32" use="optional">
                        <xs:annotation>
                            <xs:documentation xml:lang="en">The account code for which fares are requested.
</xs:documentation>
                        </xs:annotation>
                    </xs:attribute>
                </xs:complexType>
            </xs:element>
        </xs:sequence>
        <xs:attributeGroup ref="OTA_PayloadStdAttributes" />
        <xs:attributeGroup ref="MaxResponsesGroup">
            <xs:annotation>
                <xs:documentation xml:lang="en"> The maximum number of FareDisplayInfo elements to return in the response message </xs:documentation>
            </xs:annotation>
        </xs:attributeGroup>
        <xs:attribute name="DirectFlightsOnly" type="xs:boolean" use="optional" default="false">
            <xs:annotation>
                <xs:documentation xml:lang="en"> Request direct flights on between the given locations.This defaults to false.</xs:documentation>
            </xs:annotation>
        </xs:attribute>
        <xs:attribute name="AvailableFlightsOnly" type="xs:boolean" use="optional">
            <xs:annotation>
                <xs:documentation xml:lang="en">Include only flights with available booking codes (when True or when attribute not present).</xs:documentation>
            </xs:annotation>
        </xs:attribute>
        <xs:attribute name="DisplayOrder" type="DisplayOrderType" use="optional">
            <xs:annotation>
                <xs:documentation xml:lang="en">Specifies the order in which fare contracts should be returned.</xs:documentation>
            </xs:annotation>
        </xs:attribute>
    </xs:complexType>
</xs:element>
Collapse Child Elements:
Name Type Min Occurs Max Occurs
POS nsA:POS (1) (1)
OriginDestinationInformation nsA:OriginDestinationInformation (1) 5
SpecificFlightInfo nsA:SpecificFlightInfo 0 (1)
TravelPreferences nsA:TravelPreferences 0 (1)
TravelerInfoSummary nsA:TravelerInfoSummary 0 (1)
Account nsA:Account 0 99
Collapse Child Attributes:
Name Type Default Value Use
EchoToken EchoToken Optional
TimeStamp TimeStamp Optional
Target Target Production Optional
Version Version Required
TransactionIdentifier TransactionIdentifier Optional
SequenceNmbr SequenceNmbr Optional
TransactionStatusCode TransactionStatusCode Optional
PrimaryLangID PrimaryLangID Optional
AltLangID AltLangID Optional
RetransmissionIndicator RetransmissionIndicator Optional
MaxResponses MaxResponses Optional
DirectFlightsOnly nsA:DirectFlightsOnly false Optional
AvailableFlightsOnly nsA:AvailableFlightsOnly Optional
DisplayOrder nsA:DisplayOrder Optional