Release Notes Bargain Finder Max Schema Version Release December 2014

Transcription

1 Release Notes Bargain Finder Max Schema Version Release December 2014

2 Schema version Document Edition 1.0 (December 2014) This documentation is the confidential and proprietary information of Sabre Inc. Any unauthorized use, reproduction, preparation of derivative works, performance, or display of this document, or software represented by this document, without the express written permission of Sabre Inc., is strictly prohibited. Sabre and Sabre Dev Studio are trademarks and/or service marks of an affiliate of Sabre Corporation. All other trademarks, service marks, and trade names are the property of their respective owners Sabre Inc. All rights reserved.

3 Table of Contents 1 I n t r o d u c t i o n 1.1 Overview Updated Bargain Finder Max Web Services Other Shopping Web Services S c h e m a U p d a t e s 2.1 Introduction Request/Response Updates Shop by Alliance OTA XML Request Enhancement Example Diversity Customization New Capabilities at the Request Level for Bargain Finder Max Users Benefits and Features Functional Details for Bargain Finder Max Price and Travel Time Distribution Percentage Versus Number of Additional Nonstops OTA XML Request Enhancement Examples OTA XML Response Enhancement Examples Example OTA XMLDiversity Customizations Validating Interline Ticketing Agreement GSA Enhancements or Defects Resolved Detail Showing OTA XML Request Enhancement Detail Showing OTA XML Response Enhancement Baggage Allowance OTA XML Response Example Terminal ID Information OTA XML Response Examples D o c u m e n t a t i o n U p d a t e s 3.1 Introduction New WSDL Files Updated WSDL and Schema Documents Updated Design Documents Updated Online Help Other Supporting Documents Obtaining Tools and Artifacts Table of Contents Bargain Finder Max Release Notes iii Confidential and Proprietary Sabre

4 4 T e c h n i c a l S u p p o r t 4.1 Overview Phone Table of Contents Bargain Finder Max Release Notes iv Confidential and Proprietary Sabre

5 1 Introduction Overview Bargain Finder SM Max is scheduled to be promoted to the Sabre Dev Studio PROD environment in December For testing these new services and new versions of Sabre API, use the following Sabre Dev Studio Customer Acceptance Testing Environment URLs: Cert content system: Test content system: Production content system: Per our service versioning procedures, any existing Sabre API that has been updated and/or enhanced will have a new service version number. Therefore, you must include the new service version number in your service request in order to take advantage of any release's service updates or enhancements. Previous service versions remain unchanged. There is no default service version number. A valid service version number must be included with all requests. Complete information about the Sabre Dev Studio URLs and service versioning is published on the Sabre Dev Studio site. 1.2 Updated Bargain Finder Max Web Services This release includes revisions/additions to the following Bargain Finder Max services: Updated Services New Features BargainFinderMaxRQ Shop by Alliance BargainFinderMax_SAPT BargainFinderMax_ADRQ BargainFinderMaxRS Diversity Customization Validating Interline Ticket Agreement General Sales Agent (GSA) Baggage Allowance BargainFinderMax_ADRS BargainFinderMaxRS Response for All BFM Services Terminal ID Information 1.3 Other Shopping Web Services Service New Features Description OTA_AirLowFareSearchLLSRQv1.x/V2.x Web Service Shop by Alliance No new elements simply the addition of the Alliance Codes (*A, *O, *S) Introduction Bargain Finder Max Release Notes 1 Confidential and Proprietary Sabre

6 Service New Features Description OTA_AirLowFareSearchLLSRQv2.x Web Service OTA_AirLowFareSearchLLSRQv2.x Web Service OTA_AirLowFareSearchLLSRQv2.x Web Service OTA_AirLowFareSearchLLSRQv1.x/V2.x Web Service Diversity Customization Diversity Customization Validating Interline Ticket Agreement General Sales Agent (GSA) No new elements simply the addition of the Alliance Codes (*A, *O, *S) <DiversityParameters AdditionalNonStopsNumber="9" AdditionalNonStopsPercentage="10"> <!--Defines how important are various parameters of options in response. Sum of all weightings needs to equal > <Weightings PriceWeight="7" TravelTimeWeight="3"/> No new elements New validating carrier trailer messages will be sent in PRDATA Tag 00Z7. Refer to the DAG posted in SAN BargainFinderPlusLLRSQ Web Service Diversity Customization Bargain Finder Plus search specifying a number of nonstop diversity options to be returned (equivalent Sabre host command WPNI/NS-5) <DiversityCustomization NumNonStopOptions="5" /> BargainFinderPlusLLRSQ Web Service Validating Interline Ticket Agreement General Sales Agent (GSA) Refer to Web Service Release Notes: TPFC Functional Release (Sep 16/18) Introduction Bargain Finder Max Release Notes 2 Confidential and Proprietary Sabre

7 2 Schema Updates Introduction This section provides information about Sabre Dev Studio existing services. The schema is the same as v1.8.1 and provides support documentation for the current production schema v Request/Response Updates The following new features are described: Shop by Alliance (see this page). Diversity Customization (see Diversity Customization, page 4). Validating Interline Ticketing Agreement GSA (see Validating Interline Ticketing Agreement GSA, page 9). Baggage allowance (see Baggage Allowance, page 11). Terminal ID information (see Terminal ID Information, page 11) Shop by Alliance Sabre has enhanced this new Air Shopping capability to allow you to specify Alliance Partners in the shopping request and receive options that pertain to those alliance partners. Bargain Finder Max release contains updates to the following schemas. BargainFinderMaxRS BargainFinderMaxRQ The Shop by Alliance enhancement includes the following: Ability to shop for options that are on a specific preferred alliance group (such as OneWorld, Star Alliance, and SkyTeam). Use the same alliance codes for Shopping that already exist with Availability by Alliance as follows: o o o *A = Star Alliance *O = OneWorld *S = Skyteam Online and interline options for the carriers in the alliance program will be returned Ability to specify preferred alliance and non-preferred alliance in the same manner as preferred carrier and non-preferred carrier as it works today. Applicable and combinable with all same qualifiers as preferred carrier and non-preferred carrier. Applicable with all of the same services as preferred carrier and non-preferred carrier (such as Shop Across Passenger Type and Alternate Dates). Schema Updates Bargain Finder Max Release Notes 3 Confidential and Proprietary Sabre

8 Applicable with all of the same product capabilities as preferred carrier and non-preferred carrier (such as Alternate city/airport and Customize Routing and Carrier). Applicable at a rule level, with same rules as preferred carriers. Ability to apply at an itinerary level and/or at a leg level, in the same manner as preferred carrier and non-preferred carrier as are being applied today within the different products. Ability to specify multiple alliance codes in one request (more than one alliance code per entry). Ability to specify/combine multiple alliance codes and multiple carrier codes in one request. Ability to handle included (preferred) and excluded (non-preferred) alliance and carrier attributes in one request OTA XML Request Enhancement Example <OriginDestinationInformation RPH="1"> <DepartureDateTime> T00:00:00</DepartureDateTime> <OriginLocation LocationCode="KRK"/> <DestinationLocation LocationCode="LON"/> <TPA_Extensions> <SegmentType Code="O"/> <IncludeAlliancePref Code="*A"/> <IncludeAlliancePref Code="*S"/> </TPA_Extensions> </OriginDestinationInformation> <TravelPreferences> <TPA_Extensions> <IncludeAlliancePref Code="*A"/> <IncludeAlliancePref Code="*S"/> <ExcludeAlliancePref Code="*O"/> <ExcludeAlliancePref Code="*A"/> </TPA_Extensions> </TravelPreferences> Diversity Customization Air Shopping Diversity Customization provides customers new optional qualifiers for Price and /or Travel Time and Additional Nonstop at the shopping request level. The new optional qualifiers allow you to influence the diversity of responses in the results set, thereby reducing multiple queries to reach the desired results. This section includes the following: New Capabilities at the Request Level (see New Capabilities at the Request Level for Bargain Finder Max Users, page 5). Benefits and Features (see Benefits and Features, page 5). Functional Details (see Functional Details for Bargain Finder Max, page 5). Schema Updates Bargain Finder Max Release Notes 4 Confidential and Proprietary Sabre

9 New Capabilities at the Request Level for Bargain Finder Max Users Price and Travel Time Distribution: Allows you to define weight value for either price and/or travel time. Percentage or Number of Additional Nonstop: Allows you to define a percentage or number of additional nonstop itineraries to be returned Benefits and Features Benefits and features are as follows: Diversity logic that applies today will remain in effect, but the customer will have opportunity to influence the rule parameters at a request level. All applicable segments on any trip type request and response, including one-way, round-trip, open jaw, and multi-destination. Applicable to itineraries shopping single and multiple passengers. Applicable to itineraries shopping public and private fares. Applicable to Alternate City shopping. Applicable to Shop Across Passenger Type. Applicable for Response Restructure (GIR). Additional Nonstops also includes direct flights. Note If a developer decides to invoke Price and Travel Time and Additional Nonstop qualifiers, customer development work will be required on the Sabre request, but no development work required on the Sabre response. The response changes are the additional nonstop, and price and travel time weighting will be within the results sets returned based on Bargain Finder Max tier level 50, 100, or 200 options Functional Details for Bargain Finder Max Functional details include the following: Price and Travel Time distribution (see this page). Percentage Versus Number of Additional Nonstops (see Percentage Versus Number of Additional Nonstops, page 7) Price and Travel Time Distribution You can now define a weight value for either price and/or travel time as follows: PriceWeight defines the importance of the price of the options (on a scale of 0 to 10). TravelTimeWeight defines the importance of travel time (on a scale of 0 to 10). This enhancement applies to Sabre s Air Shopping diversity model, and a static 65 percent is set for all customers for the lowest options and short travel time in the result sets returned. Schema Updates Bargain Finder Max Release Notes 5 Confidential and Proprietary Sabre

10 For Price and Travel Time, the weighted measure controls the options for short travel time but more expensive and options for the lowest options but with long travel time (35 percent of the options). You can control 35 percent of the weight value for price and travel time parameters. The 35 percent will appear within the mixture of Bargain Finder Max result sets returned. The shopping logic determines which option should be selected (only if there are two or more options with the same price). Price has top priority. Sum of all values for price and travel time parameters must equal 10. All values cannot be negative. Single values cannot exceed 10. This section includes the following examples: Example Defining Weighting for Price and Travel Time (see this page). Example Request XML for Price and Travel Time (see this page). Examples Scenarios Weightings for Price versus Travel Time (see this page). Example Defining Weighting for Price and Travel Time PriceWeight defines the importance of the price of the options (on a scale of 0 to 10). TravelTimeWeight defines the importance of travel time (on a scale of 0 to 10). Diversity/Weightings@PriceWeight= 3 Diversity/Weightings@TravelTimeWeight= 7 Example Request XML for Price and Travel Time <DiversityParameters> <Weightings PriceWeight= 2 TravelTimeWeight= 8 /> </DiversityParameters> Results of this weighting can vary per market, and users should test various scenarios to determine what fits their business needs. For best results, it is recommended to add extreme values to see an effect on the options returned. Examples Scenarios for Weightings for Price Versus Travel Time The customer can define 35 percent of results sets, which will appear within the mixture of the results set in the response. 1. Weightings PriceWeight 10 and TravelTimeWeight 0 In this example, Price Weight is most important, and BFM result sets will include a mixture of the lowest fares and combinations of flight schedules that may include longer travel times. 2. Weightings PriceWeight 0 and TravelTimeWeight 10 In this example, Travel Time Weight is most important, and BFM result sets will still include the lowest fares and combinations of flight schedules that may include shortest travel times. 3. Weightings PriceWeight 8 and TravelTimeWeight 2 4. Weightings PriceWeight 2 and TravelTimeWeight 8 Schema Updates Bargain Finder Max Release Notes 6 Confidential and Proprietary Sabre

11 The default is approximately: PriceWeight 4 and TravelTimeWeight 6 (control state) Percentage Versus Number of Additional Nonstops This allows the customer to define a percentage or a number of additional nonstop itineraries to be returned. For The following applies Example Additional Nonstop Percentage Defines the percentage of additional nonstop options that should be added to response. The nonstop percentage would be additive options. It means that the customer will receive as more options as it was requested. Additional Nonstops Maximum Percentage will be set as a default value of 50 percent. Users cannot request 100 percent nonstop. For example, a BFM100 user can request 50 percent nonstop, and the Sabre system will return their 100 lowest fare options, plus an additional 50 nonstop options. The new qualifier nonstop is combinable with other qualifiers (unless there is a conflict), including, but not limited to: o o o o o o Forced connection using current connect points. Maximum number of connections. Long connection. No connection to/from/through specified airport. Maximum number of flight stops. Specified routing/carrier. Additional Nonstop percentage request parameter: <TPA_Extensions> <DiversityParameters AdditionalNonStopsPercentage= 25 /> Schema Updates Bargain Finder Max Release Notes 7 Confidential and Proprietary Sabre

12 For The following applies Example Additional Nonstop Number Defines the number of additional nonstop options that should be added to the response. The additional number of nonstops requested by this parameter will be additive options as well. It means that when the user of BFM100 sends a request with 20 additional nonstops, the Sabre system will return their 100 lowest fare options, plus an additional 20 nonstop options. Maximum of Additional Nonstops to receive is set to 50 percent of the total returned options (by default). Additional Nonstop number request parameter: <TPA_Extensions> <AdditionalNonStopsNumber= 20 /> OTA XML Request Enhancement Examples Not applicable OTA XML Response Enhancement Examples Additional Nonstop <DiversityParameters AdditionalNonStopsNumber="9" AdditionalNonStopsPercentage="10"> Price Weight and Travel Time <!--Defines how important are various parameters of options in response. Sum of all weightings needs to equal 10.--> <Weightings PriceWeight="7" TravelTimeWeight="3"/> Example OTA XMLDiversity Customizations <!--Optional--> <!--Repeat Factor=0-1--> <!--Diversity Parameters elements --> <!--AdditionalNonStopsNumber (attribute), Defines how many additional non-stop options should be added to response. <!--AdditionalNonStopsPercentage (attribute), Defines how many additional non-stop options should be added to response as a percentage of requested number of options.--> <DiversityParameters AdditionalNonStopsNumber="9" AdditionalNonStopsPercentage="10"> <!--Optional--> <!--Repeat Factor=0-1--> <!--Defines how important are various parameters of options in response. Sum of all weightings needs to equal 10.--> <Weightings PriceWeight="7" TravelTimeWeight="3"/> </DiversityParameters> Schema Updates Bargain Finder Max Release Notes 8 Confidential and Proprietary Sabre

13 2.2.3 Validating Interline Ticketing Agreement GSA The Validating Interline Ticketing Agreement General Sales Agent (GSA) feature is for specific beta clients only Enhancements or Defects Resolved Reference Applies to Enhancements or Defects Resolved SAN 7952 Request and Response Sabre is making substantial changes to validating carrier logic to align it across Shopping, Pricing, Ticketing, and Exchanges for consistent application to return ticketable options. The changes in this enhancement include improvements in how the validating carrier is selected, expanded abilities for a carrier to designate a General Sales Agent (GSA) for ticketing within a settlement plan by country, new trailer messages, and improved Interline Agreement displays. Validations performed for itinerary options to be returned are: The selected validating carrier participates in the ticket issuance settlement plan, such as ARC or BSP. The validating carrier allows for the ticket to be issued with all marketing and operating carriers for the itinerary segment being fulfilled; interline agreements. For additional detail, refer to the DAG attached to the SAN Note Only Activated for GSA Validating Interline Ticketing Agreement BETA clients Detail Showing OTA XML Request Enhancement Request/Response Type Format/Example OTA XML Request Settlement Method Override OTA_AirLowFareSearchRQ/TravelPreferences/SettlementMe thod/text() Example <TravelPreferences> - <TPA_Extensions> <SettlementMethod>ARC</SettlementMethod> </TPA_Extensions> - </TravelPreferences> Schema Updates Bargain Finder Max Release Notes 9 Confidential and Proprietary Sabre

14 Detail Showing OTA XML Response Enhancement Enhancement Trailer Message - OTA Response Tag Sterilized Alternate and Neutral Validating Carrier Serialize alternate and neutral validating carrier in a separate XML element. Description OTA_AirLowFareSearchRS/PricedItineraries/PricedItinerary/AirItineraryPricingIn fo/ptc_farebreakdowns/ptc_farebreakdown/passengerfare/tpa_extension s/messages) Message Type - W Existing Tag new trailers will be seen here <AirItineraryPricingInfo> : <TPA_Extensions> : <ValidatingCarrier SettlementMethod="BSP" NewVcxProcess="true"> <Default>XX</Default> <Alternate>YY</Alternate> <Alternate>ZZ</Alternate> </ValidatingCarrier> </TPA_Extensions> </AirItineraryPricingInfo> Example OTA Message Type W -<Messages> <Message Type="W" Info="VALIDATING CARRIER -" FailCode="0"/> <Message Type="W" Info="OPTIONAL VALIDATING CARRIERS - YY ZZ" FailCode="0"/> </Messages> Example Serialized <AirItineraryPricingInfo> - <TPA_Extensions> - <ValidatingCarrier SettlementMethod="ARC" NewVcxProcess="true"> <Default>XX</Default> <Alternate>YY</Alternate> <Alternate>ZZ</Alternate> </ValidatingCarrier> </TPA_Extensions> </AirItineraryPricingInfo> Schema Updates Bargain Finder Max Release Notes 10 Confidential and Proprietary Sabre

15 The <Alternate>YY</Alternate> tag will be used to return Alternate Validating Carrier or Optional Validating Carrier as follows: Alternate Validating Carrier A marketing carrier who participates in the itinerary and returns the same fare solution as the default/primary validating carrier Optional Validating Carrier Describes a condition when there are two or more neutral validating carriers that can be assigned to the same lowest fare solution. One of these carriers must be chosen as the validating carrier because a Default Validating Carrier cannot be assigned by the system Baggage Allowance Sabre has enhanced the response for two BargainFinderMax services to now include baggage allowance. The new baggage allowance information includes number of bags allowed (from 0 99) and weight limitations. Activation of this feature will be by request only. Following are the services that include baggage allowance: BargainFinderMaxRS BargainFinderMax_ADRS OTA XML Response Example </Messages> <BaggageInformationList> <BaggageInformation> <Segment Id="0"/> <Segment Id="1"/> <Segment Id="2"/> <Allowance Pieces="1"/> </BaggageInformation> </BaggageInformationList> Terminal ID Information Sabre has enhanced all Bargain Finder Max OTA responses to include the departure airport and arrival airport terminal ID information. This is included in BargainFinderMaxRS All BFM Services OTA XML Response Examples The following example shows departure airport location terminal ID: <FlightSegment DepartureDateTime=" T14:30:00" ArrivalDateTime=" T16:35:00" StopQuantity="0" FlightNumber="3098" ResBookDesigCode="E" ElapsedTime="125"> <DepartureAirport LocationCode="TPE" TerminalID="2"/> <ArrivalAirport LocationCode="CAN"/> <OperatingAirline Code="CZ" FlightNumber="3098"/> <Equipment AirEquipType="772"/> <MarketingAirline Code="CZ"/> <MarriageGrp>O</MarriageGrp> <DepartureTimeZone GMTOffset="8"/> Schema Updates Bargain Finder Max Release Notes 11 Confidential and Proprietary Sabre

16 <ArrivalTimeZone GMTOffset="8"/> <TPA_Extensions> <eticket Ind="true"/> </TPA_Extensions> </FlightSegment> The following example shows arrival airport location terminal ID: <FlightSegment DepartureDateTime=" T21:55:00" ArrivalDateTime=" T23:20:00" StopQuantity="0" FlightNumber="275" ResBookDesigCode="K" ElapsedTime="85"> <DepartureAirport LocationCode="BKK" /> <ArrivalAirport LocationCode="HKT" TerminalID="1"/> <OperatingAirline Code="PG" FlightNumber="275"/> <Equipment AirEquipType="320"/> <MarketingAirline Code="PG"/> <MarriageGrp>I</MarriageGrp> <DepartureTimeZone GMTOffset="7"/> <ArrivalTimeZone GMTOffset="7"/> <TPA_Extensions> <eticket Ind="true"/> </TPA_Extensions> </FlightSegment> Schema Updates Bargain Finder Max Release Notes 12 Confidential and Proprietary Sabre

17 3 Documentation Updates Introduction This chapter includes references to all documentation updates. 3.2 New WSDL Files The new WSDL files to generate proxy code are: wsdl Updated WSDL and Schema Documents BargainFinderMaxRQRS_v1-8-2.xsd (schema) BargainFinderMaxRQ_v1-8-2.wsdl (wsdl) BargainFinderMaxSAPTRQRS_v1-8-2.xsd (schema) BargainFinderMaxSAPTRQ_v1-8-2.wsdl (wsdl) BargainFinderMaxADRQRS_v1-8-2.xsd (schema) BargainFinderMaxADRQ_v1-8-2.wsdl (wsdl) 3.4 Updated Design Documents BargainFinderMaxRQ_v1-8-2_Design.xml BargainFinderMax_SAPTRQ_v1-8-2_Design.xml BargainFinderMax_ADRQ_v1-8-2_Design.xml 3.5 Updated Online Help BargainFinderMaxRQ XML Help will be updated to match the current XML schemas it describes. BargainFinderMaxRQ XML Help allows clients to find the necessary information to make changes to the preferences set within the XML files. BargainFinderMax XML Help contains detailed information about BargainFinderMaxRQ's XML schemas, including descriptions, data requirements, usage requirements, patterns, children, attributes, and minimum and maximum occurrences. Bargain Finder MaxRQ XML Help also contains frequently asked questions and some basic information about the BargainFinderMaxRQ service. For details about the changes to the online help, refer to the "Revision History" topic under "Getting Started" in the help system. Documentation Updates Bargain Finder Max Release Notes 13 Confidential and Proprietary Sabre

18 3.6 Other Supporting Documents Additional supporting documents include web service descriptions, sample request and response design XML documents, sample request and response payloads, and other service-specific documents. For Bargain Finder Max customer acceptance testing releases, supporting documents for new web services and updated web services (due to enhancements or corrections), will be available in Sabre Dev Studio, denoted by the word "PROD" in the downloadable artifact description. When a new Bargain Finder Max release is deployed to production, all finalized supporting documentation will be available via Sabre Dev Studio. During the testing phase, refer to these release notes for changes to existing services that have been previously released to production so that you can modify and test your client code. 3.7 Obtaining Tools and Artifacts For new Web services and Web services upgraded to a new version, WSDL, schema, and design documents will be available on the Sabre Dev Studio. You can download the WSDL and schema documents on the Sabre Dev Studio at or directly from the environment URL. You need a login in order to access the Dev Studio site. For Bargain Finder Max customer acceptance testing releases, supporting documents for new Web services and updated Web services (due to enhancements or corrections), will be available on the Dev Studio site, denoted by the word "PROD" in the downloadable artifact description. When a new Bargain Finder Max release is deployed to production, all finalized supporting documentation will be available via Sabre Dev Studio. During the testing phase, please refer to these release notes for changes to existing services that have been previously released to production so that you can modify and test your client code. Documentation Updates Bargain Finder Max Release Notes 14 Confidential and Proprietary Sabre

19 4 Technical Support Overview If you have any questions or need assistance, contact our Sabre Dev Studio Global Customer Support Center via any of the methods provided in this chapter. 4.2 Phone When reporting production or other critical/time sensitive issues, contact us via telephone as follows: Location Phone Number USA Canada International or your regional Sabre Software help desk is monitored 24 x 7 with a response within 24 hours or less. The address is: webservices.support@sabre.com Note Please include the Sabre Pseudo City Code (PCC) where the issue is occurring. When reporting an issue with web services, input and output payloads are required. Please attach the payloads as separate files, and name them clearly. Samples of these files are available at: When sending zipped files, please make a note of the following required file naming convention. To help ensure that our environment is free of viruses, our policy mandates that all messages received by Sabre from external sources follow special file name guidelines. File names must end in ".sabre.zip" or the zipped attachment will be removed by the server (for example, docs.zip would need to be renamed to docs.sabre.zip ). If your correspondence is regarding a previously reported issue, please include the service incident ( SI ) number in the subject line of your message. Technical Support Bargain Finder Max Release Notes 15 Confidential and Proprietary Sabre

20 Technical Support Bargain Finder Max Release Notes 16 Confidential and Proprietary Sabre