Definition Type: ComplexType
Name: FareType
Containing Schema: OTA_AirCommonTypes.xsd
Abstract
Documentation:
Holds a base fare, tax, total and currency information on a price
Collapse XSD Schema Diagram:
Drilldown into TPA_Extensions in schema ota_commontypes_xsd Drilldown into Discounts in schema ota_aircommontypes_xsd1 Drilldown into ExchangeInfo in schema ota_aircommontypes_xsd1 Drilldown into OriginalIssueInfo in schema ota_aircommontypes_xsd1 Drilldown into Remark in schema ota_aircommontypes_xsd1 Drilldown into TourCode in schema ota_aircommontypes_xsd1 Drilldown into FareBaggageAllowance in schema ota_aircommontypes_xsd1 Drilldown into UnstructuredFareCalc in schema ota_aircommontypes_xsd1 Drilldown into FareConstruction in schema ota_aircommontypes_xsd1 Drilldown into TotalFare in schema ota_aircommontypes_xsd1 Drilldown into Fees in schema ota_aircommontypes_xsd1 Drilldown into Taxes in schema ota_aircommontypes_xsd1 Drilldown into EquivFare in schema ota_aircommontypes_xsd1 Drilldown into BaseFare in schema ota_aircommontypes_xsd1 Drilldown into TotalNbrPTC in schema ota_aircommontypes_xsd Drilldown into TotalNbrTrips in schema ota_aircommontypes_xsd Drilldown into TicketDesignatorCode in schema ota_aircommontypes_xsd Drilldown into NegotiatedFareCode in schema ota_aircommontypes_xsd Drilldown into NegotiatedFare in schema ota_aircommontypes_xsd Drilldown into NegotiatedFareAttributes in schema ota_aircommontypes_xsd1XSD Diagram of FareType in schema ota_aircommontypes_xsd1 (Open Travel (OTA))
Collapse XSD Schema Code:
<xs:complexType name="FareType">
    <xs:annotation>
        <xs:documentation xml:lang="en">Holds a base fare, tax, total and currency information on a price</xs:documentation>
    </xs:annotation>
    <xs:sequence>
        <xs:element name="BaseFare" minOccurs="0">
            <xs:annotation>
                <xs:documentation xml:lang="en">Price of the inventory excluding taxes and fees.</xs:documentation>
            </xs:annotation>
            <xs:complexType>
                <xs:attributeGroup ref="CurrencyAmountGroup" />
                <xs:attributeGroup ref="ExchangeRateGroup" />
            </xs:complexType>
        </xs:element>
        <xs:element name="EquivFare" minOccurs="0">
            <xs:annotation>
                <xs:documentation xml:lang="en">Price of the inventory excluding taxes and fees in the payable currency.</xs:documentation>
            </xs:annotation>
            <xs:complexType>
                <xs:attributeGroup ref="CurrencyAmountGroup" />
            </xs:complexType>
        </xs:element>
        <xs:element name="Taxes" minOccurs="0">
            <xs:annotation>
                <xs:documentation xml:lang="en">This is a collection of Taxes</xs:documentation>
            </xs:annotation>
            <xs:complexType>
                <xs:sequence>
                    <xs:element name="Tax" type="AirTaxType" maxOccurs="99">
                        <xs:annotation>
                            <xs:documentation xml:lang="en">Any individual tax applied to the fare</xs:documentation>
                        </xs:annotation>
                    </xs:element>
                </xs:sequence>
                <xs:attribute name="Amount" type="Money" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">The total of all the taxes.</xs:documentation>
                    </xs:annotation>
                </xs:attribute>
            </xs:complexType>
        </xs:element>
        <xs:element name="Fees" minOccurs="0">
            <xs:annotation>
                <xs:documentation xml:lang="en">This is a collection of Fees</xs:documentation>
            </xs:annotation>
            <xs:complexType>
                <xs:sequence>
                    <xs:element name="Fee" type="AirFeeType" maxOccurs="9">
                        <xs:annotation>
                            <xs:documentation xml:lang="en">Any additional fee incurred by the passenger but not shown on the ticket.  </xs:documentation>
                        </xs:annotation>
                    </xs:element>
                </xs:sequence>
                <xs:attributeGroup ref="CurrencyAmountGroup">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">The fee total and the appropriate currency code.</xs:documentation>
                    </xs:annotation>
                </xs:attributeGroup>
            </xs:complexType>
        </xs:element>
        <xs:element name="TotalFare" minOccurs="0">
            <xs:annotation>
                <xs:documentation xml:lang="en">The total price that the passenger would pay (includes fare, taxes, fees)  </xs:documentation>
            </xs:annotation>
            <xs:complexType>
                <xs:attributeGroup ref="CurrencyAmountGroup" />
            </xs:complexType>
        </xs:element>
        <xs:element name="FareConstruction" minOccurs="0">
            <xs:annotation>
                <xs:documentation xml:lang="en">Should not contain unstructured FareCalc data.</xs:documentation>
            </xs:annotation>
            <xs:complexType>
                <xs:attribute name="FormattedIndicator" type="xs:boolean" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">When true, this is structured fare calculation information.</xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="Language" type="xs:language" use="optional" />
                <xs:attribute name="OriginCityCode" type="StringLength1to8" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">The origin airport city code for this fare construction.</xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="OriginCodeContext" type="StringLength1to32" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">Identifies the context of the origin city code such as IATA, ARC, or internal code.</xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="DestinationCityCode" type="StringLength1to8" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">The destination airport city code for this fare construction.</xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="DestinationCodeContext" type="StringLength1to32" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">Identifies the context of the destination city code such as IATA, ARC, or internal code.</xs:documentation>
                    </xs:annotation>
                </xs:attribute>
            </xs:complexType>
        </xs:element>
        <xs:element name="UnstructuredFareCalc" minOccurs="0">
            <xs:annotation>
                <xs:documentation xml:lang="en">Contains the fare calc information for the stored fare for the passenger.</xs:documentation>
            </xs:annotation>
            <xs:complexType>
                <xs:simpleContent>
                    <xs:extension base="xs:string">
                        <xs:attribute name="FareCalcMode" type="AlphaNumericStringLength1" use="optional">
                            <xs:annotation>
                                <xs:documentation xml:lang="en">Used to identify the method of pricing for this transaction (e.g., manual,  automated pricing). Should be 1 character in length.</xs:documentation>
                            </xs:annotation>
                        </xs:attribute>
                    </xs:extension>
                </xs:simpleContent>
            </xs:complexType>
        </xs:element>
        <xs:element name="FareBaggageAllowance" minOccurs="0" maxOccurs="99">
            <xs:annotation>
                <xs:documentation xml:lang="en">Checked baggage allowance for the fare.</xs:documentation>
            </xs:annotation>
            <xs:complexType>
                <xs:attributeGroup ref="UnitsOfMeasureGroup">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">Baggage allowance for this fare.</xs:documentation>
                    </xs:annotation>
                </xs:attributeGroup>
                <xs:attribute name="FlightSegmentRPH" type="RPH_Type" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">The segment this baggage allowance is associated with.</xs:documentation>
                    </xs:annotation>
                </xs:attribute>
            </xs:complexType>
        </xs:element>
        <xs:element name="TourCode" type="StringLength1to16" minOccurs="0">
            <xs:annotation>
                <xs:documentation xml:lang="en">The tour code associated with the fare.</xs:documentation>
            </xs:annotation>
        </xs:element>
        <xs:element name="Remark" minOccurs="0" maxOccurs="10">
            <xs:annotation>
                <xs:documentation xml:lang="en">Free flow remarks for the fare breakdown.</xs:documentation>
            </xs:annotation>
            <xs:complexType>
                <xs:simpleContent>
                    <xs:extension base="StringLength0to64" />
                </xs:simpleContent>
            </xs:complexType>
        </xs:element>
        <xs:element name="OriginalIssueInfo" minOccurs="0">
            <xs:annotation>
                <xs:documentation>The original ticket/document issue information.</xs:documentation>
            </xs:annotation>
            <xs:complexType>
                <xs:attribute name="TicketDocumentNbr" type="StringLength1to16" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">The original ticket/document number.</xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="IssuingAgentID" type="NumericStringLength1to8" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">ID of the original issuer of the ticket/document.</xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="DateOfIssue" type="xs:date" use="optional">
                    <xs:annotation>
                        <xs:documentation>Date the ticket/document was originally issued.</xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="LocationCode" type="StringLength1to8" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">Location of original issue.</xs:documentation>
                    </xs:annotation>
                </xs:attribute>
            </xs:complexType>
        </xs:element>
        <xs:element name="ExchangeInfo" minOccurs="0">
            <xs:annotation>
                <xs:documentation>Exchange ticket/document information.</xs:documentation>
            </xs:annotation>
            <xs:complexType>
                <xs:sequence>
                    <xs:element name="CouponInfo" minOccurs="0" maxOccurs="4">
                        <xs:annotation>
                            <xs:documentation>Optional information on coupon numbers being exchanged.</xs:documentation>
                        </xs:annotation>
                        <xs:complexType>
                            <xs:attribute name="Number" type="Numeric1to4" use="optional">
                                <xs:annotation>
                                    <xs:documentation xml:lang="en">The applicable coupon number.</xs:documentation>
                                </xs:annotation>
                            </xs:attribute>
                        </xs:complexType>
                    </xs:element>
                    <xs:element name="OriginalOriginDestination" minOccurs="0">
                        <xs:annotation>
                            <xs:documentation>The original origin and destination for exchanged ticket/documents.</xs:documentation>
                        </xs:annotation>
                        <xs:complexType>
                            <xs:attribute name="OriginCityCode" type="StringLength1to8" use="optional">
                                <xs:annotation>
                                    <xs:documentation xml:lang="en">Origin city code.</xs:documentation>
                                </xs:annotation>
                            </xs:attribute>
                            <xs:attribute name="DestinationCityCode" type="StringLength1to8" use="optional">
                                <xs:annotation>
                                    <xs:documentation xml:lang="en">Destination city code.</xs:documentation>
                                </xs:annotation>
                            </xs:attribute>
                        </xs:complexType>
                    </xs:element>
                </xs:sequence>
                <xs:attribute name="TicketDocumentNbr" type="StringLength1to16" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">The new ticket/document number.</xs:documentation>
                    </xs:annotation>
                </xs:attribute>
            </xs:complexType>
        </xs:element>
        <xs:element name="Discounts" minOccurs="0">
            <xs:annotation>
                <xs:documentation>Collection for discounts.</xs:documentation>
            </xs:annotation>
            <xs:complexType>
                <xs:sequence>
                    <xs:element name="Discount" maxOccurs="99">
                        <xs:annotation>
                            <xs:documentation>Provides discount information associated with the fare.</xs:documentation>
                        </xs:annotation>
                        <xs:complexType>
                            <xs:attributeGroup ref="DiscountInfoGroup">
                                <xs:annotation>
                                    <xs:documentation xml:lang="en">Details regarding the discount.</xs:documentation>
                                </xs:annotation>
                            </xs:attributeGroup>
                        </xs:complexType>
                    </xs:element>
                </xs:sequence>
            </xs:complexType>
        </xs:element>
        <xs:element ref="TPA_Extensions" minOccurs="0" />
    </xs:sequence>
    <xs:attributeGroup ref="NegotiatedFareAttributes">
        <xs:annotation>
            <xs:documentation xml:lang="en"> Used to indicate a negotiated fare and, if so, the fare code.</xs:documentation>
        </xs:annotation>
    </xs:attributeGroup>
    <xs:attribute name="TicketDesignatorCode" type="StringLength1to16" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">Specifies a discount code applicable to the fare.</xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attribute name="TotalNbrTrips" type="Numeric1to99" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">The total number of trips in this itinerary.</xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attribute name="TotalNbrPTC" type="Numeric1to99" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">The total number of passenger type codes in this priced itinerary.</xs:documentation>
        </xs:annotation>
    </xs:attribute>
</xs:complexType>
Collapse Child Elements:
Name Type Min Occurs Max Occurs
BaseFare BaseFare 0 (1)
EquivFare EquivFare 0 (1)
Taxes Taxes 0 (1)
Fees Fees 0 (1)
TotalFare TotalFare 0 (1)
FareConstruction FareConstruction 0 (1)
UnstructuredFareCalc UnstructuredFareCalc 0 (1)
FareBaggageAllowance FareBaggageAllowance 0 99
TourCode TourCode 0 (1)
Remark Remark 0 10
OriginalIssueInfo OriginalIssueInfo 0 (1)
ExchangeInfo ExchangeInfo 0 (1)
Discounts Discounts 0 (1)
TPA_Extensions [Unresolved]: TPA_Extensions: 0 (1)
Collapse Child Attributes:
Name Type Default Value Use
TicketDesignatorCode TicketDesignatorCode Optional
TotalNbrTrips TotalNbrTrips Optional
TotalNbrPTC TotalNbrPTC Optional