Caveats -...

654
Passenger Solutions SITA Airfare Price XML Interface Specification Revision: 2.23 Revision Date: 2014-September-23 Copyright © SITA Information Networking Computing USA Inc 2013. Confidential. All Rights Reserved.

Transcript of Caveats -...

Copyright © SITA Information Networking Computing USA Inc 2013. Confidential. All Rights Reserved.
Copyright Notice
Confidential Information
All Rights Reserved
The information contained in this document is the property of SITA. No part of this document may be reproduced, stored in a retrieval system, or transmitted in any form, or by any means; mechanical, photocopying, recording, or otherwise, without the prior written consent of SITA. Under the law, copying includes translating into another language or format. Legal action will be taken against any infringement.
The information contained in this document is subject to change without notice and does not carry any contractual obligation for SITA. SITA reserves the right to make changes to any products or services described in this document at any time without notice. SITA shall not be held responsible for the direct or indirect consequences of the use of the information contained in this document.
Copyright © SITA Information Networking Computing USA Inc 2013. Confidential. All Rights Reserved.
Table of Contents
Copyright © SITA Information Networking Computing USA Inc 2013. Confidential. All Rights Reserved.
Page ii
Table of Contents
Copyright © SITA Information Networking Computing USA Inc 2013. Confidential. All Rights Reserved.
Page i
Revision History
Alan Cracknell
Fare Display Open Pricing Non-Lowest PNR Pricing Changes to schemas for above and to reflect increased use of attributes.
1.2
Draft
Alan Cracknell
Fare rules text Routing Itinerary mileage City pair mileage Best Buy
1.3
Draft
Alan Cracknell
Excess baggage charges Exchange rates Document history details Code tables for PTC, FTC and flight status codes
1.4
Draft
Alan Cracknell
Ping Tax text Passenger facility charges Minor corrections (refer to detailed history)
1.5
Draft
1.6
Draft
1.7
Draft
1.8
Draft
FlightShop and CalendarShop chapters reissued. Minor updates (refer to detailed history)
1.82
Draft
Khalil Nazir
Added OperatingAirline to PriceRQ. Minor updates done check the detailed change history.
1.83
Draft
Point Of Sale. Added NegotiatedFareCode element to FareDisplayRQ. (Refer to detailed history)
1.84
Draft
Corrected example mileage request to use marketing not operating carrier.
1.84
Draft
1.84
Draft
1.84
Draft
1.85
Draft
1.85
Draft
1.85
Draft
1.86
Draft
1.87
Draft
Changed the number of times FlightResBookDesigcodes can repeat in a SITA_AirfareFlightShopRS.
1.89
Draft
1.90
Draft
Khalil Nazir
SITA_AirfarePriceRS now returns the TicketTimeLimit in Local time based on the POS.
1.91
Draft
1.92
Draft
1.93
Draft
1.93
Draft
Added ExemptTransportingSurcharges, TaxExemptItems and IgnoreTaxItems to Price request.
1.94
Draft
1.95
Draft
1.95
Draft
1.95
Draft
Added Surcharge and Farecalc element and related attributes to FlightShopRS
1.96
Draft
1.96
Draft
1.96
Draft
1.96
Draft
1.96
Draft
1.96
Draft
1.96
Draft
1.96
Draft
1.96
Draft
1.96
Draft
1.96
Draft
1.96
Draft
1.96
Draft
1.96
Draft
1.97
Draft
1.97
Draft
1.97
Draft
1.97
Draft
1.97
Draft
1.97
Draft
1.98
Draft
1.98
Draft
1.98
Draft
1.98
Draft
1.99
Draft
1.99
Draft
1.99
Draft
2.00
Final
2.00
Final
2.01
Final
2.02
Final
2.02
Final
2.03
Final
2.04
Final
2.05
Final
2.05
Final
2.05
Final
2.06
Final
21st March 2012
Antonio Del Rio
Added City and IsTotal attributes to the PreviousTaxQuotes element in the SITA_AirfareRefundRQ transaction
2.06
Final
2.06
Final
2.07
Final
2.07
Final
2.07
Final
2.07
Final
2.08
Final
2.08
Final
2.09
Final
Added description for the F value in the CurrencyOverride@Indicator attribute.
2.10
Final
2.11
Final
2.12
Final
2.12
Final
2.13
Final
2.14
Final
2.14
Final
2.14
Final
2.14
Final
2.15
Draft
2.15
Final
2.15
Final
2.15
Final
2.16
Final
2.16
Final
2.17
Final
2.18
Final
2,19
Final
2.20
Final
2.20
Final
2.21
Final
2.21
Final
2.22
Final
2.22
Final
2.23
Final
2.23
Final
Revision History
Copyright © SITA Information Networking Computing USA Inc 2013. Confidential. All Rights Reserved.
Page xiv
Revision History
Copyright © SITA Information Networking Computing USA Inc 2013. Confidential. All Rights Reserved.
Page xv
Introduction
Clients may choose to access Airfare Price or Airfare Shop using a traditional terminal interface suitable for legacy reservation systems and/or an XML interface suitable for new generation reservation systems, e-commerce and other applications.
This document defines the Airfare XML interface (AXI), for details of the terminal interface refer to the Airfare Agents Guide and Training Manual (reference 2).
Caveats
This document defines AXI; it is not intended to provide a functional description of Airfare. It is assumed that the reader is familiar with the Airfare terminal interface, international pricing concepts and pricing terminology.
XML examples in this document are based on Airfare queries and responses. Some examples have been modified for illustrative purposes. AXI may not return the same results should the query be repeated.
SITA recommend that the reader review this interface specification alongside the schemas using a tool such as XML Spy.
Draft versions of this specification are subject to change without warning.
Open Travel Alliance
SITA have based AXI on the Open Travel Alliance (OTA) XML 2005A message specification. For schemas and usage examples, please refer to www.opentravel.org .
Interface Scope
The Airfare XML Interface provides messages for the following Airfare functions:
· Best buy
· Calendar shop
· Currency calculator
· Flight shop
· Interline agreements
· Mileage
· Pricing including return of reservation conditions (chained RBD’s)
· Routing
· Taxes and charges text
The Airfare XML Interface does not provide an interface for the following Airfare terminal requests:
· Encode / decode
· Management of ad hoc data and SITA automated rule tables
· Management or retrieval of online documentation
· Retrieval of flight restrictions details
· Retrieval of information notes details
· Retrieval of additional fare calc information
Supporting Documents
1. SITA Airfare XML Interface Artefacts V1.0 10 November 2005
2. SITA Passenger & Travel Solutions Airfare Agents Guide and Training Manual 2005
3. SITA Airfare XML Technical Interface Specification
4. Open Travel Alliance Message Users Guide OTA_MessageUsersGuide2005AV1.0.pdf
5. Open Travel Alliance XML schemas www.opentravel.org
6. Open Travel Alliance Code Types (available from www.opentravel.org ) OTA_CodeTable20050606.xls
Updates
Refer to the document history for document updates. Sections or text highlighted in blue indicate changes since the last revision.
Glossary
Term
Definition
Airfare
Within this document the term Airfare when used without qualification refers to both Airfare Price and Airfare Shop
Airfare program
The Airfare program comprises Airfare Price, Airfare Shop, Airfare Insight and Airfare Data
Airfare Data
Airfare Data provides data management facilities for Airfare automated rules.
Airfare Insight
Airfare Insight is a fares management tool that empowers airlines to set fares at the right level by providing feedback about fares that are currently being sold in the market.
Airfare Legacy
Airfare Price supersedes the pre-existing mainframe Airfare Legacy (or Legacy Airfare) application.
Airfare Price
Airfare Shop
AXI
DTD
Data Type Definition – a mechanism for defining the structure of a valid XML message, superseded by the schema (see XSD)
Legacy Airfare
OTA is a self-funded, non-profit organization, comprised of major airlines, hoteliers, car rental companies, leisure suppliers, travel agencies, global distribution systems (GDS), technology providers and other interested parties working to create and implement industry-wide, open e-business specifications. These specifications form a common e-business language that will encourage development of systems to create new collections of services to better meet the demands and expectations of travellers and the travel industry.
Requestor
The client application making a pricing or shopping request to Airfare via AXI.
RPH
Terminal Interface
The terminal, native or agent interface provides the cryptic Airfare commands and responses used by many of Airline reservation systems on “green screens” today.
Valid
In relation to XML, a “Valid” XML document is a “Well Formed” XML document, which also conforms to the rules of a Document Type Definition (DTD).
W3C
The World Wide Web Consortium (W3C) develops interoperable technologies (specifications, guidelines, software, and tools) to lead the Web to its full potential as a forum for information, commerce, communication, and collective understanding.
Well formed
In relation to XML, a “Well Formed” XML document is a document that conforms to the XML syntax rules as defined by W3C.
XML
XSD
The XML Schema defines the structure of a valid XML message.
Overview
AXI provides an XML interface to the Airfare Price and Airfare Shop international air fare, pricing and shopping functions.
AXI does not provide a human user interface. AXI is intended for use by client software applications (requestor) needing air pricing and shopping. The requestor is responsible for all aspects of the user interface including interaction and presentation, and integration with third party applications such as reservations and ticketing.
AXI is based on technology and travel industry standards. Use of standards promises to increase interoperability, reduce integration expense and increase asset reuse and agility. Refer to the SITA Airfare Technical Interface Specification (Ref. 3) for further details of the technical interface. AXI is based on the OTA XML standard.
Figure 1: Airfare XML Interfaces
Open Travel Alliance (OTA)
OTA is a self-funded, non-profit organization, comprised of major airlines, hoteliers, car rental companies, leisure suppliers, travel agencies, global distribution systems, technology providers and other interested parties working to create and implement industry-wide, open e-business specifications. These specifications form a common e-business language that will encourage development of systems to create new collections of services to better meet the demands and expectations of travellers and the travel industry.
SITA is an active member in both IATA and the OTA XML initiatives working to define and refine these specifications.
OTA Compliance
During a mapping process, SITA have exposed additional interfaces required for access to Airfare functions and data provided by Airfare that are not part of the OTA specification. XML is extensible by design. OTA recognise that specifications will never meet all needs. To this end the OTA schemas are extensible at specified places.
SITA have used OTA provided TPA Extensions where possible, however currently as not all elements are extensible, it has been necessary to wrap some OTA messages with a SITA message in which SITA extensions are placed.
Figure 2: OTA Extensions
SITA is working with OTA to refine these areas to improve the OTA specification and AXI interface in future releases.
All Airfare extensions are valid and OTA compliant.
Session Control
AXI does not provide any form of session control. Each transaction is independent from all other transactions.
There are in general three situations where sessions are important: short cut, scrolling and follow-on entries:
· Short-cut entries are provided for convenience for an end-user to allow them to repeat entries without re-trying a complete request. AXI provides an application interface and not a direct end-user interface. This presentation function must be provided by the client application if required.
· Scrolling entries provide for paging through responses where more than one screen of data is displayed. If scrolling is required, then the client application must provide this. AXI will supply all data associated with the transaction in a single response.
· Follow-on entries may be required to probe a pricing or fare display request for further information. Airfare Price returns two keys (cookies) with each pricing request. The first cookie gives a context to the request; the second cookie specifies a fare component. To facilitate a follow-on request, the client application must supply both cookies returned in the original request.
AXI Error handling
AXI reports validation and operational failures in the OTA Errors element and pricing functional indicators in the OTA Errors and OTA Warnings elements.
Validation Errors
AXI reports validation errors using an OTA code of 320 (invalid value) or 321 (required field missing). In addition AXI gives a partial XPATH to indicate the problem element.
For example creating an invalid date a pricing request generates the following error:
<ota:Errors>
Functional Errors and Warning Messages
Requests submitted to AXI may be well formed, valid and in all other respects reasonable, however, Airfare may still fail to return a positive result. Failure may be for operational reasons such as component outages but it is more likely that there are no fares or data filed that match the request. In either event AXI returns an error or a warning as appropriate, with an OTA error code of 448 (system error). The body of the error/warning element gives a formatted text string with a further Airfare specific error code and error message.
<ota:Warnings>
<ota:Warning Type=”448”>2063 – NO FARES FOUND FOR INPUT REQUEST</ota:Warning>
</ota:Warnings>
Please refer to Appendix 20.4 for a list of errors.
Document Usage / Conventions
This document uses italics to indicate element or attribute names.
This specification illustrates usage of the OTA XML messages and SITA extensions by way of examples (Use Cases). Many of these examples map to similar functionality exposed in the Airfare terminal interface.
Tables define and describe the request and response elements used by Airfare. The tables indicate:
· Whether the element is defined by OTA or is a SITA extension
· Whether the element is optional or mandatory in an Airfare request / response
· In a request some elements that are defined by OTA as optional are required by AXI. The table defines whether the element is mandatory or optional for AXI. In the event that an OTA optional but AXI mandatory element is not supplied in the request, then AXI will return an error response to the requestor.
· For responses, mandatory/optional indicates if non-error responses include the element and/or attribute always or just sometimes depending upon the Airfare response.
· Mandatory elements need not occur in a message if a higher-level element is optional, but must be in the message[footnoteRef:1] if the parent element is included. [1: Subject to aforementioned caveats]
· The OTA element or attribute name
· Attributes start with the “@” symbol
· The Airfare reference name
· A reference to a Use Case in the form of <use case number>.<row>.<column> giving the start of the named field.
Notes:
· The mapping tables include all mandatory OTA elements / attributes.
· AXI does not support OTA optional elements / attributes that are not given in the mapping tables.
· AXI ignores any non-supported optional OTA elements/attributes in a request.
· AXI does not generate non-supported optional OTA elements/attributes in responses.
General Usage Notes
GU1. Required but unused mandatory elements The OTA XML Schemas (XSD) require the use of certain elements, some of which AXI does not need. The following illustrates the minimum usage of the TravelerRefNumber that still preserves message validity.
<ota :AirTraveler PassengerTypeCode= »CNN »> <ota :TravelerRefNumber/> </ota :AirTraveler>
GU2. Standards and the CodeContext attribute
OTA use contexts to add flexibility and to avoid misinterpretation.
1. Standards bodies such as ISO, IATA or ICAO maintain common code-sets for the benefit of the community. Some standards compete. To avoid misinterpretation, use the CodeContext attribute to identify a code-set.
<ota :VendorPref Code= »SQ » CodeContext= »IATA »/>
Requestor use of the CodeContext is optional. AXI supports only the following code sets. AXI will reject or may incorrectly process requests made using alternate codes.
Code set
OTA (see code types table)
2. To qualify usage of a generic attribute such as identity OTA use a case-specific context. In the following example, the ID_Context indicates that the Identity “XSLON” represents a department code.
<ota:POS> <ota:Source AirlineVendorID=”XS” AirportCode=”ATL”> <ota:RequestorID ID=”XSLON” ID_Context=”DepartmentCode”/> </ota:Source> </ota:POS>
GU3. Public, Private and Cat 35 Negotiated Fares
Airfare supports public, private and automated rules category 35 negotiated fares.
Automated rules support private and negotiated fares through a combination of the following categories:
1. Category 15 (sales restrictions) restricts the ability to quote, price and issue tickets to authorised parties (§0). This is common known as private fares.
2. Category 25 (fare by rule) provides dynamic discounting of fares.
3. Category 35 (negotiated fare restrictions) provides further capabilities including ticketing, commissions, security and fare creation and reporting, some of which relate to net fares.
The requestor may restrict fares and pricing requests to public only, private only or public and private by using the PricingSource attribute:
<ota:PriceRequestInformation PricingSource=”Published”/>
<AdditionalPriceRQData IncludeNegotiatedFares=”true”>
Private and negotiated fares may be restricted to authorised parties (§0) and by corporate account code.
<ota:PriceRequestInformation PricingSource=”Both”>
<ota:NegotiatedFareCode Code=”IBM123”/>
GU4. Sales Restrictions
In addition to the airline code, AXI accepts the following category 15 sales restriction items:
· Department code
· Department number
· CRS code
· Company name
It is the requestor’s responsibility to ensure that the security information passed to Airfare is correct.
If necessary, the requestor should repeat the Source element to include the necessary sale restriction items, for example:
<ota:POS>
ERSP_UserID=”1234566” TerminalID=”AB123”>
</ota :Source>
</ota:Source>
<ota:Source>
</ota:Source> <ota:Source>
<ota:RequestorID Type=”13” ID=”ZZ” ID_Context=”CRSCode”/> <ota:BookingChannel Type=”13”> <ota:CompanyName Code=”XSTRAVEL”/> </ota:BookingChannel”> </ota:Source> </ota:POS>
There is no separate ID_Context for department number. This data is obtained from the ID attribute where the ID_Context is set to DepartmentCode as shown in the following example:
<ota:POS>
ERSP_UserID=”1234566” TerminalID=”AB123”>
</ota :Source>
</ota:Source>
<ota:Source>
</ota:Source> <ota:Source>
<ota:RequestorID Type=”13” ID=”ZZ” ID_Context=”CRSCode”/> <ota:BookingChannel Type=”13”> <ota:CompanyName Code=”XSTRAVEL”/> </ota:BookingChannel”> </ota:Source> </ota:POS>
The ID attribute holds the department code followed by the department number separated by a comma.
GU5. Authentication
AXI requires a user key is specified in every request made. The key is provided by SITA. The example below shows how the key is included in the POS element (high lighted):
<ota:POS>
<ota:RequestorID ID=”XS” ID_Context=”CRSCode”/>
<ota:BookingChannel Type=”13”/>
</ota:Source> </ota:POS>
GU6. OverrideCRSCode value in POS/Source/ RequestorID ID_Context
AXI will add a new value to ID_Context in the POS. This new value "OverrideCRSCode" will allow more secure messaging for a GDS/ IT company to operate also as a secondary/aggregator. In Specific, this new value will allow the GDS/IT to pass the Original GDS CRS code in the AXI RQ, that of the Original GDS with which the Carrier has filed as the security. This new POS capability is to support the NDC New Distribution Capability features which are beginning to appear and are still being discussed in the industry.
<ota:POS>
<ota:Source>
</ota:Source>
</ota:Source>
</ota :Source>
</ota:Source> <ota:Source>
</ota:Source>
</ota:POS>
Application Ping
The ping transaction provides verification that the Airfare application and interface components are responding to requests, it also returns an indication of when the transaction was processed, the interface and software version.
OTA Compliance
This message is a SITA Airfare specific message. It is not equivalent to the OTA ping message.
Usage Notes
SITA Airfare Price XML Interface Specification
Overview
Copyright © SITA Information Networking Computing USA Inc 2013. Confidential. All Rights Reserved.
Page 12
Application Ping
Copyright © SITA Information Networking Computing USA Inc 2013. Confidential. All Rights Reserved.
Page 13
@TimeStamp
The Airfare environment to process the request, for example “Production”.
@Version
@EchoToken
@TimeStamp
@Target
@Version
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Indicates the date at which the software version was deployed
Passenger & Travel Solutions
Application Ping
Copyright © SITA Information Networking Computing USA Inc 2013. Confidential. All Rights Reserved.
Page 14
Application Ping
Copyright © SITA Information Networking Computing USA Inc 2013. Confidential. All Rights Reserved.
Page 15
Use Cases – Example ping transaction
This example shows a client requesting the status of the service and supported interface versions.
XML Request
<SITA_PingRQ xmlns=”http://www.sita.aero/PTS/fare/2005/12/PingRQ” xmlns:ota2005a=”http://www.opentravel.org/OTA/2003/05” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” Version=”0.001”>
</POS>
</SITA_PingRQ>
<SITA_PingRS xmlns= »http://www.sita.aero/PTS/fare/2005/12/PingRS » xmlns :ota2005a= »http://www.opentravel.org/OTA/2003/05 » xmlns :xsi= »http://www.w3.org/2001/XMLSchema-instance » Version= »0.001 »>
</Versions>
</Service>
</Versions>
</Service>
</Versions>
</Service>
</Services>
<Components>
OperationalStatus=”Active” Version=”build-2006-02-09-0000”/>
OperationalStatus=”Active” Version=”v1.0”/>
OperationalStatus=”Active” Version=”v1.0”/>
</Components>
</SITA_PingRS>
Pricing
The itinerary pricing transaction allows the client to price a PNR returning the lowest price for the specified passengers and itinerary. The itinerary pricing request is similar to the Airfare terminal FSI entry.
Airfare offers flexible pricing capabilities supporting many different scenarios, including:
· PNR pricing returning the single lowest pricing solution
· PNR pricing returning alternate pricing solutions
· Best buy processing (§6) where the requestor passes in a list of available booking classes for the given flights and Airfare returns the lowest applicable pricing solution for the given booking classes
· Open or informative pricing (§5) where the requestor some of the travel details are not fixed
To affect these pricing scenarios Airfare offers a number of request parameters including:
1. MaxResponses Setting MaxResponses restricts the number of alternate pricing solutions returned by Airfare Price. The default value is “1”. Setting the MaxResponses to a value other than one may result in multiple alternate pricing solutions for the specified itinerary as booked.
2. Reprice The requestor can provide a best buy capability that offers a consumer the lowest available fare by building a price request with the Reprice attribute set to “true” and listing the available booking classes for each flight in the BookingClassAvails element. Refer to chapter 6 for examples of best buy.
Not to be used in a RepriceRQ. This is a shopping function only.
3. AirItinerary Airfare will try to return prices if it is able given only partial itinerary information, for example, Airfare can:
· price itineraries with an unspecified return travel date
· price itineraries with one or more flights that have unspecified booking classes
Refer to chapter 5 for examples of open / informative pricing.
In all cases, AXI returns the Airfare Functional Control Character (FCC). The FCC indicates whether a pricing solution is based on ticketable fares and if the request is sufficiently well qualified to be ticketed.
OTA Compliance
The SITA Airfare Price request implements and extends the OTA_AirPriceRQ to add:
· ReservationsDateTime at both a booking and a flight segment level
· Point of ticketing
· Alternative ticketing dates
· Segment specific, global indicator and fare breakpoints
· Include negotiated fares flag
The SITA Airfare Price response implements and extends the OTA_AirPriceRS to add:
· Functional Control Character
· Ticket endorsements
· Segment specific global indicators, NVA, NVB, free baggage allowances, IT/BT fare indicator and Stopover indicator
Usage Notes
The following notes provide guidance on how to use AXI itinerary pricing. The notes column of the tables in §4.3 and §4.4 indicate where the following notes apply. Section 5.2 addresses notes in the range 100-199 which pertain to open pricing.
1. TotalFare not used AXI does not generate the TotalFare element in the response, instead a total fare and breakdown is given for each passenger type requested in the PTC_breakdown element. This practice is OTA compliant and prevents unnecessary repetition of data.
2. Responses do not contain all request information OTA messages return only selected key request data in the response, so it may be necessary for the requestor to retain the context of the original request. For example, a client application requesting IT/BT pricing will not get an indicator in the response.
3. RPH element linking
OTA have a practice of linking elements where necessary through a unique index known as an RPH element.
The price request uses RPH element linking in order to give segment specific pricing options such a as stopover indicator or fare breakpoint. The price response uses RPH element linking in a similar way to link fare components to segments.
Refer to the mapping tables (§4.3, §4.4) and examples (§4.5) for more information.
4. Specified fares
Pricing may be constrained to one or more specified fares. To restrict pricing of the itinerary to a single fare use the FareReference at the itinerary (OriginDestinationOptions) level. To restrict specific flights to specific fares use the FareReference at the flight (AdditionalSegmentInfo) level.
5. PassengerTypeQuantity AXI supports two methods for specifying passenger types for pricing, either by individual traveller, or by passenger type codes and number of travellers. Specifying the passenger type for each travellers:
<ota:TravelerInfoSummary>
<ota:AirTravelerAvail>
<ota:PassengerTypeQuantity/>
<ota :AirTravelerAvail>
</ota:AirTravelerAvail>
AXI returns a fare info element for each fare component.
7. Common pricing scenarios: AXI supports different pricing scenarios, the following table illustrates how to affect some common pricing transaction scenarios using AXI:
Lowest PNR pricing
Return the single lowest price solution. Default action. To force lowest PNR pricing:
Set MaxResponses to “1” (default) Set Reprice to “false” (default) Provide full itinerary data
PNR pricing
Return alternative pricing solutions: Set MaxResponses > 1 Set Reprice to “false” (default) Provide full itinerary data
Best buy
To affect best buy: Set Reprice to “true” Provide full itinerary data
Open pricing
For open pricing: Set Reprice to “false” (default) Provide partial itinerary data
8. Multiple Pricing Solutions AXI creates each pricing solution as a separate OTA PricedItinerary with a unique SequenceNumber. AXI links additional Airfare response data to specific pricing solutions using both the SequenceNumber and the FareRPH references. Refer to §4.7 for an example.
9. Passenger date of birth / age
The Airfare XML interface requires the passenger date of birth. This differs from the native terminal interface that uses the date of birth.
10. Segment Status Codes Refer to Appendix A3 for a mapping of Airfare to OTA segment status codes.
11. Currency handling
Airfare defaults the currency for the transaction to that indicated by the AirportCode in the point of sale Source element. If the selling currency is different to the currency of the point of sale, then the requestor should set the CurrencyCode in the PriceRequestInforamtion element. In this case Airfare returns prices in the currency requested as an equivalent fare. The following example, shows a Japanese domestic fare, returned in a pricing response, for a London point of sale, sold in Euros. Note that Airfare returns the Equivalent rate in the SITA_PassengerFareExtension element
<ota:PTC_FareBreakdowns>
<ota:BaseFare Amount=”210100” CurrencyCode=”JPY” FromCurrency=”JPY” ToCurrency=”GBP” Rate=”0.005218”/>
<ota:EquivFare Amount=”1564.00” CurrencyCode=”EUR”/>
<ota:Taxes>
</ota:Taxes>
<ota:UnstructuredFareCalc>osa nh x/tyo nh sfo nh pdx m2021.77yxow nuc2021.77end roe103.906000</ota:UnstructuredFareCalc>
<ota :TPA_Extensions>
<ota :SITA_PassengerFareExtension>
</ota :SITA_PassengerFareExtension>
</ota :TPA_Extensions>
12. Tax summaries and breakdowns
The OTA schemas cater for summary tax information in the Taxes element. The schemas cater for the IATA tax code, currency code and amount. AXI, if requested, provides additional tax information in the TaxBreakdown element.
To avoid duplication of information in the response, AXI permits the requestor to control return of the summary and breakdown information in responses through the TaxSummaryInd and ReturnTaxDetails request parameters. By default, Airfare returns the OTA Taxes tax summary and does not return the TaxBreakdown.
Some countries re-use tax IATA tax codes depending upon context, for example, the US, US Tax code may used for the international departure arrival tax or the domestic transportation tax. In these cases, to uniquely identify a tax, SITA return an additional code – the Airfare Internal tax code. When making follow-on tax text requests, it is necessary to supply the country code, the tax code and where given in pricing responses the internal code (SITA_AirfareTaxTextRQ).
Taxes are uniquely identified by the IATA tax code, the country code and the SITA internal code. To retrieve tax text for a specific tax.
13. UnstructuredFareCalc
The default UnstructuredFareCalc line includes the fare basis codes. In order to comply with IATA Reso's, and return an a UnstructuredFareCalc line without fare basis code included, it is required to set the attribute DoNotIncludeFBCInHFC="true", which is in the element <sita:AdditionalPriceRQData. The attribute if not set at all or set to false returns the default which is UnstructuredFareCalc line includes the fare basis codes.
In the case of RepriceRQ, the value of this attribute must be coded the same in the OriginalItinerary and the RevisedItinerary . i.e. either not present in both, set to False in both, or set to True in both.
14. StopQuantity and IncidentalStop special logic
When an individual segment is coded with a StopQuantity value greater than zero AND that same segment RPH has an IncidentalStop indicated,processing will “ignore” the StopQuantity. This is logic in place in order to eliminate redundancy in the response while at same time allowing both to be coded for one segment.
15. SecondaryPTC Info new element and attributes added.
1) For the input, a new element SecondaryPTCinfo will be added to the AdditionalPassengerTypeInfo element. This new element will have 2 new attributes SecondaryPTCCode and PassengerAge . The AdditionalPassengerTypeInfo element already has an existing attribute called PassengerTypeCode which will be mandatory if the SecondaryPTCCode is set and it should match the PTC that was entered in the AirTravelerAvail section. This is required so AXI can cross-reference the data entered in both sections. For Example :
<ota:AirTravelerAvail>
<sita:SecondaryPTCInfo SecondaryPTCCode="CNN"/>
</sita:AdditionalPassengerTypeInfo>
</sita:AdditionalPassengerTypeInfos>
2) In the response, the SecondaryPTCCode from the input will be echo back in the same attribute as the "primary" PTC. So the response should look like this when there is a SecondaryPTCCode in the input:
<ota:PTC_FareBreakdowns>
The two PTCs will be separated by a "-" (dash) .
Note: For the SITA_AirfareRepriceRQ, the SecondaryPTCCode from the Revised Itinerary will be echo back.
3) In the PTC_Breakdown/PassengerFare/TPA_Extensions/SITA_PassengerFareExtension is new element AppliedPTCs and new 2 attributes: PTC which will be set if the fare applied to the primary PTC and the other SecondaryPTC is set if the fare applied to the secondary PTC. At least one of these 2 attributes is set in the response. Example RS :
<ota:PTC_FareBreakdowns>
<ota:UnstructuredFareCalc>atl dl fra3122.00y nuc3122.00end roe1.000000</ota:UnstructuredFareCalc>
<ota:TPA_Extensions>
<ota:SITA_PassengerFareExtension>
</ota:SITA_PassengerFareExtension>
</ota:TPA_Extensions>
</ota:PassengerFare>
</ota:PTC_FareBreakdown>
</ota:PTC_FareBreakdowns>
16. Endorsement element has attribute MessageNumber.
Used to display the special endorsement 2185 which is defined to identify the domestic Russian fares VAT tax amount separate from the fare to be used for further processing
17. Global Indicator codes. (fbr stands for Fare By Rule).
AL
NA
AP
RU
RW
TB
WH
Passenger & Travel Solutions
Pricing
Copyright © SITA Information Networking Computing USA Inc 2013. Confidential. All Rights Reserved.
Page 24
Pricing
Copyright © SITA Information Networking Computing USA Inc 2013. Confidential. All Rights Reserved.
Page 23
Price Request
OTA Element
Airfare Reference
Airfare Terminal
@TimeStamp
 
The Airfare environment to process the request, either “Test” or “Production”
@Version
 
 
 
n/a
US
0..1
GU4
 
 
 
 
 
 
 
 
AB123
0..1
GU4
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
n/a
n/a
ABCD
1
GU4
“OverrideCRSCode” (see GU6)
1.2.12 1.2.21
03NOV 0955
 
 
 
 
 
 
Number of incidental stops. May be used in lieu of global routing indicator where possible / necessary to correctly determine routing.
See usage notes #14
n/a
n/a
1
1
3
 
 
 
 
 
 
 
 
10 100
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
@RPH
1
0..1
 
 
 
 
 
n/a
n/a
1998-09-22
0..1
 
 
 
 
SITA Automated Rules passenger type. Refer to note for usage.
@RPH
1
0..1
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
+P
private
0..1
GU3
 
 
 
 
 
 
n/a
n/a
1
0..1
7
 
 
 
 
 
2.1.17
18AUG05
2005-08-18T10:00:00
0..1
 
 
 
 
 
 
 
n/a
n/a
false
0..1
12
 
n/a
n/a
true
0..1
12
Indicates if the pricing system should return extended tax information. If set to false, the pricing system omits extended tax information. Default false.
@PlusUpInd
n/a
n/a
true
0..1
Set to true to return any plus up information available for the fare. The default is false.
@ReturnAllEndos
n/a
n/a
true
0..1
Indicates if the pricing system should return all ENDOS messages. Default is false.
@IncludeNetFares
n/a
n/a
true
0..1
@FareCurrencySelection
n/a
n/a
EUR
0..1
This will enable the user to select fares of a currency other than the default currency of the origin country. It cannot be combined with the CurrencyOverride@Indicator attribute
@IncludePrivateNegoFares
n/a
n/a
true
0..1
Set to true to price private and negotiated fares combined
@FilterQTD
n/a
true
true
0..1
Set to true to eliminate the fares without the qualifying ticket designator code. The default is false which will return the fares that pass security as well as those fares with the qualifying ticket designator code.
@CurrencyConversionCode
n/a
*EUR
EUR
0..1
This will allow users to request fares be converted to a currency of payment other than currency of POS by a direct conversion using BSR/ICH. This will bypass default IATA Composite Reso 024e processing using BBR.
@NewBaggageUser
n/a
n/a
true
0..1
For new baggage users, this option will disable the default baggage information returned with the pricing transaction. New baggage users should use the SITA_AirfareAncillaryAirItemRQ for baggage information.
@AccompaniedTravel
true
0..1
If set to true, the system will apply accompanied travel validation. If set to false or not set at all, the system will not apply the accompanied travel validation
@DoNotIncludeFBCInHFC
true
0..1
Set to true to return an HFC line that does not include fare basis code. If not present or set to false, the HFC does include the FBC.
@TaxOnlyDisplay
true
0..1
Set this attribute to True to invoke special Tax only display in EFare.
@MileageRedemptionIndicator
MIMO
0..1
 
 
 
 
 
 
 
2.1.7
YXOW
YXOW
0..1
4
 
 
 
 
 
 
 
 
 
 
@Code
 
1.1.13
E
E
0..1
11
Alternative currency indicator: Overides the default hard/soft currency configuration for the airline/POS. C – Inhibit an equivalent amount from being returned in the local currency when the country of payment is a “soft” currency country. Equivalent amount returned in USD. E – Price an applicable itinerary in euros. With the implementation of the euro currency, for an EMU participating country, the expression “local currency” can mean either the currency for the country or the euro currency. The euro currency will be treated as a local currency and no currency conversion will be performed between EMU countries
 
 
2.1.35
0.003271
0.003271
0..1
11
 
 
2.1.46
1.55553
1.55553
0..1
11
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
*YPX6M
YPX6M
0..1
4
 
 
 
 
Fare break point indicator, may be one of the following values – defaults to “no” no – no breakpoint restriction
nb – no break at origin
ob – only break at origin
mb – must break at origin
ms - must side trip
md – must break at destination, usually use before a surface sector segment.
nd – no break at destination , usually use before a surface sector segment.
od – only break at destination, usually use before a surface sector segment
na – do not break at origin and/ or destination.
ma- must break at origin and destination.
oa – only break at origin and destination
nbmd – no break at origin but must break at destination.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Segment index relating incidental stop data to the FlightSegment element.
See usage notes #14.
 
 
 
 
 
 
 
 
@Country
US
US
1
Country code. If the exemption applies to all countries then the value “ALL” must be specified.
@Tax
AY
AY
1
 
 
 
 
@Country
US
US
1
Country code. If the ignore applies to all countries then the value “ALL” must be specified.
@Tax
AY
AY
1
 
 
 
 
 
 
@PassengerRPH
@PassengerTypeCode
ADT
ADT
0..1
 
 
 
@PreTaxAmount
-25
0..1
Amount to be discounted. The amount should be preceded by a ‘-‘ (minus) if substraction is to be applied, or by a ‘+’ (plus) if addition is to be applied
@PostTaxDiscountType
FLAT
0..1
Discount type can be either “percent” or “flat”. If PreTaxDiscountType has been initialized, the PostTaxDiscountType attribute will be ignored
@PostTaxAmount
+50.00
0..1
Amount to be discounted. The amount should be preceded by a ‘-‘ (minus) if substraction is to be applied, or by a ‘+’ (plus) if addition is to be applied
@Id
ID
1
Type of discount (id, dg, rg,…). This attribute is mandatory only if PreTaxDiscountType or PostTaxDiscountType are used.
@Qualifier
N1
0..1
 
 
 
@Percentage
-15
0..1
Percent discount to apply. It should be preceded by a ‘-‘ (minus) if substraction is to be applied, or by a ‘+’ (plus) if addition is to be applied
@FlatAmount
+100.00
0..1
 
 
 
@SecondaryPTCCode
CNN
1
See usage notes #15. PTC code for the discount from the primary PTC.
@PassengerAge
14
0..1
Price Response
OTA Element
Airfare Reference
Airfare Terminal
Success / Warnings / Errors
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
n/a
n/a
1
1
8
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2.7.4
CNN
CNN
0..1
5
 
 
 
 
 
 
 
 
1 = AWARD
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
If set to “true”, used ATP YQ/YR tax processing. If set to “false”, tax does not use ATP YQ/YR processing
TaxDetail
n/a
n/a
0..99
IndividualTaxAmount
n/a
n/a
00000016
0..1
This will be the tax breakdown of the Total Tax amount
Sequence
n/a
n/a
0232000
0..1
 
 
 
 
 
0..1
11
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
0..1
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 30000
30000 
0..1
 
 
 
 
 
0..1
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1.17.6
LLXZD01
LLXZD01
1
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
n/a
n/a
1
1
3
Key used to relate further segment specific fare information in the AdditionalResponseData
@RuleNumber
n/a
n/a
Y012
0..1
@RuleTariffNumber
n/a
n/a
001
0..1
The Rule Tariff number of this fare is used to match against tariff restrictions of the provision.
@FootNoteDate
n/a
n/a
2013-12-01
0..1
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Cookie string to use in follow on requests relating to this fare component
Directionality@Code
n/a
n/a
n/a
TVL
1
TVL = in direction of travel TVL
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
If supplied the TicketingCodeModifier should be appended to the TicketingCode for ticketing purposes The modifier may be used to indicate maximum stay, minimum group size or percentage discount.
Surcharges
0..1
Surcharge
1..99
@EndCity
LON
1
@Type
F
1
N = Service upgrade
@CurrencyCode
NUC
1
@NumberOfStopovers
1
0..1
Number of stopovers if cumulative surcharge. It is only returned if the Surcharge Type is either ‘S’ or ‘T’.
@TravelApplication
1
0..1
Amount of the surcharge displayed in the currency of payment
@PaymentCurrencyCode
CNY
0..1
Currency Code of the surcharge in the currency of payment
FailureDiagnosticInfo
0..1
Provides detailed information about the reasons for the pricing failure
CategoryFailures
0..1
CategoryFailure
1..35
@Failed
Y
1
@Unavailable
N
1
OtherFailureReasons
0..1
Describes the reason for the failure. Possible values returned are:
· BookingClass
· Routing
· PaxType
· Rec1Unavailable
· SurfaceSector
· Loit
· Currency
· NonSecurityCat15
· PricingUnit
· AbonnementFare
· YYSupressionTable
· HIPCheck
· TourCodeCombine
· CarrierVsYYCarrier
· CarrierSurfaceSector
· Mileage
ConstructedFareInfo
0..1
@CurrencyCode
SGD
1
@ConvertedAmount
0.00
0..1
Origin amount converted to the currency of the country of commencement
@ConvertedCurrencyCode
JPY
0..1
DepartureLocation
1
 
 
 
 
 
 
 
 
ArrivalLocation
1
 
 
 
 
 
 
 
 
SpecifiedFare
0..1
@CurrencyCode
SGD
1
@ConvertedAmount
0.00
0..1
Specified amount converted to the currency of the country of commencement
@ConvertedCurrencyCode
JPY
0..1
DepartureLocation
1
ArrivalLocation
1
DestinationAddOnFare
0..1
@CurrencyCode
SGD
1
@ConvertedAmount
0.00
0..1
Destination amount converted to the currency of the country of commencement
@ConvertedCurrencyCode
JPY
0..1
DepartureLocation
1
 
 
 
 
 
 
 
 
ArrivalLocation
1
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
M
 7
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
@FareComponentNumber
01
01
0..1
The fare component number that the endorsement applies to. This attribute will only be set when the ReturnAllEndos input is set to “true”.
@TicketLocation
00003
00003
0..1
This attribute will be the Ticket Location from Cat 18. The attribute will only be set if the the ReturnAllEndos input is set to “true”.
@MessageNumber
02185
02185
0..1
 
 
 
 
Global indicator (route code) used to give routing of flights containing incidental stops.
@GlobalIndicatorFromSelectionTable
AT
AT
0..1
 
 
 
 
 
 
 
 
 
Free baggage allowance expressed in pieces “PC” or weight “20K”.
@FareBasis
YXZ
YXZ
1
 
 
0..1
7
 
 
 
 
 
 
 
 
 
 
 
n/a
n/a
Y
0..1
 
 
 
 
n/a
n/a
Y
0..1
 
 
 
 
 
0..1
@EndOn
n/a
n/a
true
0..1
It is set to true if combination of Cat 35 fares with other fares
@CurrencyCode
n/a
n/a
USD
0..1
@Amount
n/a
n/a
1490.00
0..1
@EquivalentAmount
n/a
n/a
1200.00
0..1
@TotalAmount
n/a
n/a
1530.00
0..1
 
 
@Amount
n/a
n/a
1230.00
0..1
@EquivalentCurrencyCode
n/a
n/a
USD
0..1
@EquivalentAmount
n/a
n/a
1198.00
0..1
@TotalCurrencyCode
n/a
n/a
USD
0..1
@TotalAmount
n/a
n/a
1300.00
0..1
 
 
@Amount
n/a
n/a
900.00
0..1
@EquivalentCurrencyCode
n/a
n/a
USD
0..1
@EquivalentAmount
n/a
n/a
750.00
0..1
Equivalent total for the passenger coupon without taxes and surcharges
@TotalCurrencyCode
n/a
n/a
USD
0..1
@TotalAmount
n/a
n/a
830.00
0..1
 
 
@FareRPH
n/a
n/a
01
0..1
Zero if User Parameter 0065 is not set for Owner Carrier. This implies tour code is for the entire fare offer.Otherwise, this matches the fare component number
CouponDataInfos/CouponDataInfo
0..n
@FareRPH
n/a
n/a
1
1
Key used to relate further segment specific information in the FareInfo
@Upgrade
n/a
n/a
Y
1
@Rule
n/a
n/a
01JP
1
@Tariff
n/a
n/a
123
1
CouponDetails/CouponDetail
Pricing
Copyright © SITA Information Networking Computing USA Inc 2013. Confidential. All Rights Reserved.
Page 58
Pricing
Copyright © SITA Information Networking Computing USA Inc 2013. Confidential. All Rights Reserved.
Page 57
Interface Use Cases – Lowest PNR Price Example 1
In this Use Case the client application wishes to price an international multi-carrier itinerary for an adult passenger, with specified points of sale and ticketing using special fares.
Airfare Terminal Request
123456789012345678901234567890123456789012345678901234567890
1
2
3
4
5
6
FSI/NH/BU-C
Airfare XML Request
<sita:SITA_AirfarePriceRQ xmlns:ota=”http://www.opentravel.org/OTA/2003/05” xmlns:sita=”http://www.sita.aero/PTS/fare/2005/11/PriceRQ” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” Version=”0.3”>
<ota :POS>
</ota :POS>
<ota :AirItinerary>
<ota :OriginDestinationOptions>
<ota :OriginDestinationOption>
<ota :DepartureAirport LocationCode= »KUL »/>
<ota :ArrivalAirport LocationCode= »HND »/>
<ota:DepartureAirport LocationCode=”NRT”/>
<ota :DepartureAirport LocationCode= »SFO »/>
<ota :ArrivalAirport LocationCode= »PDX »/>
<ota:DepartureAirport LocationCode=”PDX”/>
<ota :DepartureAirport LocationCode= »SFO »/>
<ota :ArrivalAirport LocationCode= »KIX »/>
<sita:CurrencyOverride Indicator=”C”/>
</sita:AdditionalSegmentInfos>
</sita:AdditionalPriceRQData>
</sita:SITA_AirfarePriceRQ>
Airfare terminal response
The following table illustrates both the original native pricing response (FSI) and the native follow-up fare component (FSQ) display.
1 2 3 4 5 6
123456789012345678901234567890123456789012345678901234567890
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
FSI/NH/BU-C
*NO FARES/RBD/CARRIER
01 COW+CXOW 6171.60 USD RB INCL TAX
*ATTN PRICED ON 29JUN06*0923
AFPTEST/XS /EFEP_FS1REGRESS/FCC=D/PAGE 1/1»
TAX USD 11.80MY USD 5.00AY USD 128.80XT
TOTAL USD 6171.60
KUL NH X/TYO NH X/SFO NH PDX M2810.26NW X/SFO NH OSA M3215.0
0NUC6025.26END ROE3.800000
XT USD 28.20US USD 5.00XA USD 7.00XY USD 5.00YC USD 74.60YQ
XT USD 9.00XFSFO4.5PDX4.5
<sita:SITA_AirfarePriceRS xmlns:sita=”http://www.sita.aero/PTS/fare/2005/11/PriceRS” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:ota=”http://www.opentravel.org/OTA/2003/05” Version=”0.001”>
<ota:Success/>
<ota:PricedItineraries>
<ota:DepartureAirport LocationCode=”KUL”/>
<ota :DepartureAirport LocationCode= »NRT »/>
<ota :ArrivalAirport LocationCode= »SFO »/>
<ota:DepartureAirport LocationCode=”SFO”/>
<ota :DepartureAirport LocationCode= »PDX »/>
<ota :ArrivalAirport LocationCode= »SFO »/>
<ota:DepartureAirport LocationCode=”SFO”/>
<ota:EquivFare Amount=”6026.00” CurrencyCode=”USD”/>
<ota:Taxes>
</ota:Taxes>
<ota:TotalFare Amount=”6163.30” CurrencyCode=”USD”/>
<ota:UnstructuredFareCalc>kul nh x/tyo nh sfo nh pdx m2810.26cow nw sfo nh osa m3215.00cxow nuc6025.26end roe3.800000</ota:UnstructuredFareCalc>
</ota:PassengerFare>
</ota:PTC_FareBreakdown>
</ota:PTC_FareBreakdowns>
<ota:FareInfos>
<ota :RuleInfo/>
<sita:Ref2>003panadtcons00atp</sita:Ref2>
<ota :RuleInfo/>
<sita:Ref2>003panadtcons00atp</sita:Ref2>
</sita:References>
</sita:SITA_FareInfoExtension>
</ota:TPA_Extensions>
</ota:FareInfo>
</ota:FareInfos>
</ota:AirItineraryPricingInfo>
<ota:Notes>01013 – RATE USED IN EQU TOTAL IS bsr 1myr – 0.2632usd</ota:Notes>
<ota:TicketingInfo TicketType=”eTicket” TicketTimeLimit=”2005-11-03T09:55:00”/>
</ota:PricedItinerary>
</ota:PricedItineraries>
</ota:OTA_AirPriceRS>
<sita:AdditionalPriceRSData>
<sita:AdditionalItinerariesData>
<sita:AdditionalSegmentInfos>
<sita:AdditionalSegmentInfo SegmentRPH=”2” FareRPH=”0101” GlobalIndicator=”PA” StopoverPermitted=”true” NotValidBefore=”2005-11-03” NotValidAfter=”2005-11-03” FreeBaggageAllowance=”PC”/>
<sita:AdditionalSegmentInfo SegmentRPH=”3” FareRPH=”0101” GlobalIndicator=”PA” StopoverPermitted=”true” NotValidAfter=”2005-11-03” FreeBaggageAllowance=”PC”>
<sita:RebookResBookDesigCodes>
<sita:RebookResBookDesigCodes>
</sita:AdditionalSegmentInfos>
</sita:AdditionalItineraryData>
</sita:AdditionalItinerariesData>
</sita:AdditionalPriceRSData>
</sita:SITA_AirfarePriceRS>
Interface Use Cases – Lowest PNR Price Example 2
In this example a sales agent in the United States wishes to price an itinerary for a child departing from Japan. The agent is selling to a British customer wishing to pay in Sterling (GBP).
Furthermore, the agent wishes to override the exchange rates from the currency of the fare (JPY) to the point of sale currency (USD), and the exchange rate from the point of sale currency (USD) to the equivalent currency (GBP).
Airfare Terminal Request
1232456789012345678901234567890123456789012345678901234567890
1
2
3
4
5
Airfare XML Request
<?xml version=”1.0” encoding=”UTF-8”?>
<!–Price JPY fare from UK point of sale, but show resulting GBP fare in EUR as an equivalent currency,
also override exchange rates for JPY to GBP and GBP to EUR
<sita :SITA_AirfarePriceRQ xmlns :ota= »http://www.opentravel.org/OTA/2003/05 » xmlns :sita= »http://www.sita.aero/PTS/fare/2005/11/PriceRQ » xmlns :xsi= »http://www.w3.org/2001/XMLSchema-instance » Version= »0.3 »>
<ota :OTA_AirPriceRQ xmlns= »http://www.opentravel.org/OTA/2003/05 » xmlns :xsi= »http://www.w3.org/2001/XMLSchema-instance » TimeStamp= »2005-11-10T10 :30 :00 » Version= »2.001 »>
<ota :POS>
</ota :POS>
<ota :AirItinerary>
<ota :OriginDestinationOptions>
<ota :OriginDestinationOption>
<ota :DepartureAirport LocationCode= »KIX »/>
<ota :ArrivalAirport LocationCode= »HND »/>
<ota:FlightSegment DepartureDateTime=”2005-11-03T17:00:00” ArrivalDateTime=”2005-11-03T09:10:00” StopQuantity=”0” FlightNumber=”0008” ResBookDesigCode=”L” Status=”13” RPH=”2”>
<ota :DepartureAirport LocationCode= »NRT »/>
<ota :ArrivalAirport LocationCode= »SFO »/>
<ota:FlightSegment DepartureDateTime=”2005-11-03T13:24:00” ArrivalDateTime=”2005-11-03T15:09:00” StopQuantity=”0” FlightNumber=”7234” ResBookDesigCode=”L” Status=”13” RPH=”3”>
<ota :DepartureAirport LocationCode= »SFO »/>
<ota :ArrivalAirport LocationCode= »PDX »/>
<sita:AdditionalSegmentInfos>
</sita:AdditionalSegmentInfos>
</sita:AdditionalPriceRQData>
</sita:SITA_AirfarePriceRQ>
Airfare Terminal Responses
The following table illustrates both the original native pricing response (FSI) and the native follow-up fare component (FSQ) display.
1 2 3 4 5 6
123456789012345678901234567890123456789012345678901234567890
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
01 Y2O CNN 761.40 GBP INCL TAX
***** HISTORICAL PRICING FOR INFORMATION ONLY *****
*VERIFY AGE REQUIREMENTS
OSA
FARE JPY 143000 EQUIV GBP 728.00
TAX GBP 0.30HJ GBP 1.30AY GBP 31.80XT
TOTAL GBP 761.40
6000
XT GBP 7.30US GBP 2.60XA GBP 3.60XY GBP 2.60YC GBP 15.70YQ
RATES INPUT 1JPY=0.003271USD INPUT 1USD=1.555530GBP
TKT/TL03NOV05*0955
<sita:SITA_AirfarePriceRS xmlns:sita=”http://www.sita.aero/PTS/fare/2005/11/PriceRS” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:ota=”http://www.opentravel.org/OTA/2003/05” Version=”0.001”>
<ota:Success/>
<ota:Warnings>
<ota:Warning Type=”448”>02033 – CONDITIONS NOT MET FOR FARE BASIS CODE<S></ota:Warning>
</ota:Warnings>
<ota:PricedItineraries>
<ota:DepartureAirport LocationCode=”KIX”/>
<ota :DepartureAirport LocationCode= »NRT »/>
<ota :ArrivalAirport LocationCode= »SFO »/>
<ota:DepartureAirport LocationCode=”SFO”/>
<ota:BaseFare Amount=”143000” CurrencyCode=”JPY” FromCurrency=”JPY” ToCurrency=”USD” Rate=”1.55553”/>
<ota:EquivFare Amount=”728.00” CurrencyCode=”GBP”/>
<ota:Taxes>
</ota:Taxes>
<ota:UnstructuredFareCalc>osa nh x/tyo nh sfo nh pdx m1375.76y2o nuc1375.76end roe103.906000</ota:UnstructuredFareCalc>
<ota :TPA_Extensions>
<ota :SITA_PassengerFareExtension>
</ota :SITA_PassengerFareExtension>
</ota :TPA_Extensions>
<ota :RuleInfo/>
<sita :Ref2>003pancnncons00100114030atp</sita :Ref2>
</sita :References>
</sita :SITA_FareInfoExtension>
</ota :TPA_Extensions>
</ota:FareInfo>
</ota:FareInfos>
</ota:AirItineraryPricingInfo>
<ota:Notes>01013 – RATE USED IN EQU TOTAL IS bbroverride 1usd – 1.55553gbp</ota:Notes>
<ota:Notes>01013 – RATE USED IN EQU TOTAL IS bsroverride 1jpy – 0.003271usd</ota:Notes>
<ota:Notes>02039 – VERIFY AGE REQUIREMENTS</ota:Notes>
<ota:TicketingInfo TicketType=”eTicket” TicketTimeLimit=”2005-11-03T09:55:00”/>
</ota:PricedItinerary>
</ota:PricedItineraries>
</ota:OTA_AirPriceRS>
<sita:AdditionalPriceRSData>
<sita:AdditionalItinerariesData>
<sita:AdditionalSegmentInfos>
<sita:AdditionalSegmentInfo SegmentRPH=”2” FareRPH=”0101” GlobalIndicator=”PA” StopoverPermitted=”true” NotValidBefore=”2005-11-03” NotValidAfter=”2005-11-03” FreeBaggageAllowance=”0K”/>
<sita:AdditionalSegmentInfo SegmentRPH=”3” FareRPH=”0101” GlobalIndicator=”PA” StopoverPermitted=”true” NotValidAfter=”2005-11-03” FreeBaggageAllowance=”0K”>
<sita:RebookResBookDesigCodes>
Interface Use Cases – Non lowest PNR Pricing – Example 1
In this example, the user has a booked inventory in Y class for a return trip from London to Paris. The user wishes to retrieve up to 10 alternate Y class fares and not just the lowest. Airfare obliges it finds and returns two fares which happen to have the same price, the only practical ascertainable in the response, without checking the rule conditions, being that one of the fares permits a greater baggage allowance on the London to Paris journey.
Airfare Terminal Request
123456789012345678901234567890123456789012345678901234567890
1
2
3
FSI/AF/NORM-C S*AF  2471Y10JAN LHR0645 0905CDG0S S*AF  2670Y20JAN CDG0730 0750LHR0S
Airfare XML Request
<SITA_AirfarePriceRQ xmlns=”http://www.sita.aero/PTS/fare/2005/11/PriceRQ” xmlns:ota=”http://www.opentravel.org/OTA/2003/05” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” Version=”0.001”>
<ota:POS>
</ota:POS>
<ota:AirItinerary>
<ota:OriginDestinationOptions>
<ota:OriginDestinationOption>
<ota :DepartureAirport LocationCode= »LHR »/>
<ota :ArrivalAirport LocationCode= »CDG »/>
<ota:DepartureAirport LocationCode=”CDG”/>
<ota:ArrivalAirport LocationCode=”LHR”/>
<ota:MarketingAirline Code=”AF”/>
Airfare Terminal Responses
The following table illustrates both the original native pricing response (FSI) and the native follow-up fare component (FSQ) display.
1 2 3 4 5 6
123456789012345678901234567890123456789012345678901234567890
1
2
3
4
5
6
7
8
9
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
40
41
42
43
44
45
56
47
48
49
50
51
52
53
54
55
56
57
FSI/AF/NORM-C S*AF  2471Y10JAN LHR0645 0905CDG0S S*AF  2670Y20JAN CDG0730 0750LHR0S 01 C+CRT1            1038.80 USD                    INCL TAX 02 CRT1              1038.80 USD                    INCL TAX *GB TAX MAY APPLY. SEE FXT/GB *ATTN PRICED ON 14DEC05*0540 AFPRICE/XS/FS1REGRESS/FCC=D/PAGE 1/1» Follow up FSQ1 FSI/AF/NORM-C S*AF  2471Y10JAN LHR0645 0905CDG0S S*AF  2670Y20JAN CDG0730 0750LHR0S 01 C+CRT1            1038.80 USD                    INCL TAX 02 CRT1              1038.80 USD                    INCL TAX *GB TAX MAY APPLY. SEE FXT/GB *ATTN PRICED ON 14DEC05*0543  LON  PAR C               NVB      NVA10JAN 30K  LON CRT1            NVB      NVA10JAN 20K FARE  GBP  528.00 EQUIV  USD  982.00 TAX   USD   9.30GB USD  19.30UB USD  28.20XT TOTAL USD 1038.80 LON AF PAR  509.17 AF LON  509.17 NUC1018.34END ROE0.518483 XT USD 16.30FR USD 11.90QX RATE USED 1GBP=1.860200USD TKT/TL10JAN06*0645 AFPRICE/XS/FS1REGRESS/FCC=W/PAGE 1/1» Follow up FSQ2 FSI/AF/NORM-C S*AF  2471Y10JAN LHR0645 0905CDG0S S*AF  2670Y20JAN CDG0730 0750LHR0S 01 C+CRT1            1038.80 USD                    INCL TAX 02 CRT1              1038.80 USD                    INCL TAX *GB TAX MAY APPLY. SEE FXT/GB *ATTN PRICED ON 14DEC05*0543  LON  PAR CRT1            NVB      NVA10JAN 20K  LON CRT1            NVB      NVA10JAN 20K FARE  GBP  528.00 EQUIV  USD  982.00 TAX   USD   9.30GB USD  19.30UB USD  28.20XT TOTAL USD 1038.80 LON AF PAR  509.17 AF LON  509.17 NUC1018.34END ROE0.518483 XT USD 16.30FR USD 11.90QX RATE USED 1GBP=1.860200USD TKT/TL10JAN06*0645 AFPRICE/XS/FS1REGRESS/FCC=W/PAGE 1/1»
Airfare XML Response
The following XML response shows each fare solution as a PricedItinerary with a SequenceNumber of 1 and 2 respectively.
<?xml version=”1.0” encoding=”UTF-8”?>
<sita:SITA_AirfarePriceRS xmlns:sita=”http://www.sita.aero/PTS/fare/2005/11/PriceRS” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:ota=”http://www.opentravel.org/OTA/2003/05” Version=”0.001”>
<ota:Success/>
<ota:PricedItineraries>
<ota:BaseFare Amount=”528.00” CurrencyCode=”GBP” FromCurrency=”GBP” ToCurrency=”USD” Rate=”1.8602”/>
<ota:EquivFare Amount=”982.00” CurrencyCode=”USD”/>
<ota:Taxes>
</ota:Taxes>
<ota:UnstructuredFareCalc>lon af par509.17c af lon509.17crt1 nuc1018.34end roe0.518483</ota:UnstructuredFareCalc>
</ota:PassengerFare>
</ota:PTC_FareBreakdown>
</ota:PTC_FareBreakdowns>
<ota:FareInfos>
<ota :RuleInfo/>
<sita :References>
<sita :Ref1>gepy01(user(atl,&lt ;&gt ;,af,n,dept(&lt ;&gt ;,&lt ;&gt ;),&lt ;&gt ;,&lt ;&gt ;,&lt ;&gt ;),pf2(n,[],[],n,&lt ;&gt ;),&lt ;&gt ;)</sita :Ref1>
<sita :Ref2>021ehnadt0040000100sita</sita :Ref2>
</sita :References>
</sita :SITA_FareInfoExtension>
</ota :TPA_Extensions>
<ota :RuleInfo/>
<sita :References>
<sita :Ref1>gepy01(user(atl,&lt ;&gt ;,af,n,dept(&lt ;&gt ;,&lt ;&gt ;),&lt ;&gt ;,&lt ;&gt ;,&lt ;&gt ;),pf2(n,[],[],n,&lt ;&gt ;),&lt ;&gt ;)</sita :Ref1>
<sita :Ref2>021ehnadt0040000100sita</sita :Ref2>
</sita :References>
</sita :SITA_FareInfoExtension>
</ota :TPA_Extensions>
</ota:FareInfo>
</ota:FareInfos>
</ota:AirItineraryPricingInfo>
<ota:Notes>01164 – SUM IDENTIFIED AS UB IS A PASSENGER SERVICE CHARGE</ota:Notes>
<ota:Notes>01013 – RATE USED IN EQU TOTAL IS bsr 1gbp – 1.8602usd</ota:Notes>
<ota:TicketingInfo TicketType=”eTicket” TicketTimeLimit=”2006-01-10T06:45:00”/>
</ota:PricedItinerary>
<ota:BaseFare Amount=”528.00” CurrencyCode=”GBP” FromCurrency=”GBP” ToCurrency=”USD” Rate=”1.8602”/>
<ota:EquivFare Amount=”982.00” CurrencyCode=”USD”/>
<ota:Taxes>
</ota:Taxes>
<ota:UnstructuredFareCalc>lon af par509.17crt1 af lon509.17crt1 nuc1018.34end roe0.518483</ota:UnstructuredFareCalc>
</ota:PassengerFare>
</ota:PTC_FareBreakdown>
</ota:PTC_FareBreakdowns>
<ota:FareInfos>
<ota :RuleInfo/>
<sita :References>
<sita :Ref1>gepy01(user(atl,&lt ;&gt ;,af,n,dept(&lt ;&gt ;,&lt ;&gt ;),&lt ;&gt ;,&lt ;&gt ;,&lt ;&gt ;),pf2(n,[],[],n,&lt ;&gt ;),&lt ;&gt ;)</sita :Ref1>
<sita :Ref2>021ehnadt0100000300atp</sita :Ref2>
</sita :References>
</sita :SITA_FareInfoExtension>
</ota :TPA_Extensions>
<ota :RuleInfo/>
<sita :References>
<sita :Ref1>gepy01(user(atl,&lt ;&gt ;,af,n,dept(&lt ;&gt ;,&lt ;&gt ;),&lt ;&gt ;,&lt ;&gt ;,&lt ;&gt ;),pf2(n,[],[],n,&lt ;&gt ;),&lt ;&gt ;)</sita :Ref1>
<sita :Ref2>021ehnadt0100000300atp</sita :Ref2>
</sita :References>
</sita :SITA_FareInfoExtension>
</ota :TPA_Extensions>
</ota:FareInfo>
</ota:FareInfos>
</ota:AirItineraryPricingInfo>
<ota:Notes>01164 – SUM IDENTIFIED AS UB IS A PASSENGER SERVICE CHARGE</ota:Notes>
<ota:Notes>01013 – RATE USED IN EQU TOTAL IS bsr 1gbp – 1.8602usd</ota:Notes>
<ota:TicketingInfo TicketType=”eTicket” TicketTimeLimit=”2006-01-10T06:45:00”/>
</ota:PricedItinerary>
</ota:PricedItineraries>
</ota:OTA_AirPriceRS>
<sita:AdditionalPriceRSData>
<sita:AdditionalItinerariesData>
<sita:AdditionalSegmentInfos>
</sita:AdditionalSegmentInfos>
</sita:AdditionalItineraryData>
<sita:AdditionalSegmentInfos>
</sita:AdditionalSegmentInfos>
</sita:AdditionalItineraryData>
</sita:AdditionalItinerariesData>
</sita:AdditionalPriceRSData>
</sita:SITA_AirfarePriceRS>
Open / Informative Pricing
SITA Airfare Open Pricing is a fare calculation tool providing estimated fares for partial itinerary information. Open Pricing does not require a pre-existing PNR.
OTA Compliance
The SITA Airfare Open Pricing request implements and extends the OTA_AirPriceRQ. Note however, that the OTA 2005a specification does not explicitly support open pricing. Refer to the usage notes for conventions on how to use messages for open pricing.
Usage Notes
The following notes provide guidance on how to use AXI itinerary pricing. The notes column of the tables in §4.3 and §4.4 indicate where the following notes apply.
100. Open Segments
The OTA 2005a specification does not explicitly support open segments. The schema requires that travel dates be specified and does not provide a segment status code indicating an open status.
For SITA Airfare Open pricing using the OTA 2005a schema, AXI requires the following conventions:
i. The travel date of the first travel option must be specified. The Airfare terminal request today defaults to the current date at the point of sale.
ii. Set subsequent non-specified travel dates to an open date of “9999-01-01T00:00:00”.
iii. Set the segment status code to “999” in lieu of an OTA defined code to represent an Open segment status.
101. The following travel details are optional:
a) Travel dates, with the exception of the first travel date which must be specified[footnoteRef:2] [2: The first travel date is mandatory in OTA. In the Airfare terminal format, if not supplied then it is defaulted to the current date at the point of sale. ]
b) Flight details
c) Flight numbers
e) Reservation Booking Designator codes
Request
Refer to the pricing request in §4.3 and the open pricing usage notes above (§5.2).
Response
Refer to the pricing request in §4.4 and the open pricing usage notes above (§5.2).
Interface Use Cases – Open Price Example 1
In this example the user wishes to determine possible prices for an open itinerary leaving Auckland on 10th January and arriving at Heathrow via Papeete and Los Angeles with no other specified dates of travel or other flight details.
Airfare Terminal Request
123456789012345678901234567890123456789012345678901234567890
1
2
3
4
AFP:FSI///AKL*AKL O*NZ       10JAN AKL         PPT0U O*NZ             PPT         LAX0U O*NZ             LAX         LHR0S
Airfare XML Request
<sita:SITA_AirfarePriceRQ xmlns:ota=”http://www.opentravel.org/OTA/2003/05” xmlns:sita=”http://www.sita.aero/PTS/fare/2005/11/PriceRQ” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” Version=”0.001”>
<ota :POS>
</ota :POS>
<ota :AirItinerary>
<ota :OriginDestinationOptions>
<ota :OriginDestinationOption>
ArrivalDateTime= »2006-01-10T00 :00 :00 » RPH= »01 »>
<ota :DepartureAirport LocationCode= »AKL »/>
<ota :ArrivalAirport LocationCode= »PPT »/>
<ota :MarketingAirline Code= »NZ »/>
RPH= »02 »>
RPH= »03 »>
</sita:SITA_AirfarePriceRQ>
123456789012345678901234567890123456789012345678901234567890
1
2
3
4
5
6
7
8
9
10
11
12
AFP:FSI///AKL*AKL O*NZ       10JAN AKL         PPT0U O*NZ             PPT         LAX0U O*NZ             LAX         LHR0S 01 F                13122.90 NZD                    INCL TAX 02 C                 9921.90 NZD                    INCL TAX 03 Y+MOW             5294.90 NZD      FL            INCL TAX *GB TAX MAY APPLY. SEE FXT/GB *3*FLIGHT RESTRICTIONS APPLY *ATTN CHANGE TO NO STOPOVER MAY VARY FARE *ATTN PRICED ON 07DEC05*2120 AFPRICE/XS/FS1DEV/FCC=D/PAGE 1/1»
Airfare XML Response
Note that the third pricing solution shows that the fare is subject to flight restrictions.
<?xml version=”1.0” encoding=”UTF-8”?>
<sita:SITA_AirfarePriceRS xmlns:sita=”http://www.sita.aero/PTS/fare/2005/11/PriceRS” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:ota=”http://www.opentravel.org/OTA/2003/05” Version=”0.001”>
<ota:Success/>
<ota:PricedItineraries>
<ota:DepartureAirport LocationCode=”AKL”/>
<ota:ArrivalAirport LocationCode=”PPT”/>
<ota:MarketingAirline Code=”NZ”/>
<ota:DepartureAirport LocationCode=”PPT”/>
<ota :DepartureAirport LocationCode= »LAX »/>
<ota :ArrivalAirport LocationCode= »LHR »/>
<ota:Taxes>
</ota:Taxes>
<ota:UnstructuredFareCalc>akl nz x/ppt nz x/lax nz lon m8642.49f nuc8642.49end roe1.403761</ota:UnstructuredFareCalc>
</ota:PassengerFare&