schema version v1.9.2 release 2015.12 december...

Release Notes Bargain Finder Max

Schema Version v1.9.2

Release 2015.12

December 2015

Schema version 1.9.2

Document Edition 1.0 (December 2015)

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.

© 2015 Sabre Inc. All rights reserved.

Table of Contents Bargain Finder Max Release Notes iii Confidential and Proprietary Sabre

Table of Contents

1 I n t r o d u c t i o n

1.1 Overview........................................................................................................................................................ 1 1.2 Updated Bargain Finder Max Web Services .................................................................................................. 1 1.3 Other Shopping Web Services ...................................................................................................................... 2

2 S c h e m a U p d a t e s

2.1 Overview........................................................................................................................................................ 3 2.2 Total Travel Time and Exclude Overnight Connections ................................................................................. 3

2.2.1 Total Travel Time Parameters ............................................................................................................. 3 2.2.1.1 OTA Schema Changes ........................................................................................................... 4 2.2.1.2 XML2 Schema Changes ......................................................................................................... 4

2.2.2 Support Overnight Connections Exclusion .......................................................................................... 5 2.2.2.1 OTA Schema Changes ........................................................................................................... 5 2.2.2.2 XML2 Schema Changes ......................................................................................................... 6

2.3 Change Fee and Refund Information ............................................................................................................ 7 2.3.1 BargainFinderMaxRQ Changes .......................................................................................................... 7

2.3.1.1 VoluntaryChanges Element .................................................................................................... 8 2.3.1.2 Match Attribute ....................................................................................................................... 8 2.3.1.3 Penalty Element ..................................................................................................................... 8 2.3.1.4 Other Available Attributes ....................................................................................................... 8 2.3.1.5 Filtering Options ..................................................................................................................... 9 2.3.1.6 OTA Request Example ......................................................................................................... 10

2.3.2 BargainFinderMaxRS Changes ......................................................................................................... 11 2.3.2.1 Changes and Refunds Response Information ...................................................................... 11 2.3.2.2 Maximum Penalty ................................................................................................................. 12 2.3.2.3 Other Available Attributes ..................................................................................................... 12 2.3.2.4 OTA Response Example ...................................................................................................... 13

2.3.3 GIR Response Changes .................................................................................................................... 13 2.3.3.1 PenaltiesInfo Element ........................................................................................................... 13 2.3.3.2 GIR Response Example ....................................................................................................... 14

3 D o c u m e n t a t i o n U p d a t e s

3.1 WSDL File ................................................................................................................................................... 15 3.2 Updated Design Documents ........................................................................................................................ 15 3.3 Updated Online Help ................................................................................................................................... 15 3.4 Other Supporting Documents ...................................................................................................................... 15

Table of Contents Bargain Finder Max Release Notes iv Confidential and Proprietary Sabre

4 T e c h n i c a l S u p p o r t

4.1 Overview...................................................................................................................................................... 17 4.2 Phone .......................................................................................................................................................... 17 4.3 Email ........................................................................................................................................................... 17

Introduction

Bargain Finder Max Name Release Notes 1 Confidential and Proprietary Sabre

1 Introduction

1.1 Overview

Bargain FinderSM Max schema version 1.9.2 release 2015.12 is scheduled to be promoted to the Sabre

Dev Studio PROD environment on December 16, 2015

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: https://sws-crt.cert.sabre.com

• Test content system: https://sws-sts.cert.sabre.com

• Production content system: https://webservices.sabre.com/websvc

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 in documents entitled:

• Sabre Web Services System URLs.

• TPFC Sabre Web Services Versioning Standards and Implementation.

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 Total Travel Time and Exclude Overnight Connections

BargainFinderMax_SAPT

BargainFinder_ADRQ

BargainFinderMax_ASRQ

BargainFinderMaxRQ Change Fee and Refund Information

BargainFinderMax_ASRQ

BargainFinderMax_SAPTRQ

BargainFinderMax_ADRQ

1

2

https://sws-crt.cert.sabre.com/https://sws-sts.cert.sabre.com/https://webservices.sabre.com/websvc

Introduction


1.3 Other Shopping Web Services

Service New Features Description

N/A

Schema Updates


2 Schema Updates

2.1 Overview

This chapter includes the following:

• Total Travel Time and Exclude Overnight Connections capabilities (see this page).

• Change Fee and Refund information (see “Change Fee and Refund Information,” page 7).

2.2 Total Travel Time and Exclude Overnight Connections

Sabre has made additional enhancements to Bargain Finder Max capabilities. New Total Travel Time and

Exclude Overnight Connections parameters were added at the request level to allow you to define the

Maximum and Minimum Total Travel time per leg and Exclude Overnight Connections. The new schema

attributes were added to the OTA and XML schemas. The values specified in both parameters can be

between 0 and 7200. These new capabilities are available for both standard connections and long

connections.

These new enhancements will be available December 16, 2015.

Capabilities include the following:

• All applicable segments on any trip type request and response, including one-way, round-trip, open jaw, and multi-destination.

• Multi-Ticket.

• Multiple Fares Per Itineraries.

• Multiple passenger types.

• Alternate City Shopping.

• Alternate Dates Multiple Fares.

• Alternate Dates Shopping.

This section includes the following:

• Total travel time parameters (see this page).

• Support overnight connections exclusions (see “Support Overnight Connections Exclusions,” page 5).

2.2.1 Total Travel Time Parameters

To provide the capability to define the Maximum and Minimum Total Travel time per leg, the new

schema attributes were added to the OTA and XML schemas. The values specified in both parameters can

be between 0 and 7200.

2

Schema Updates



• OTA schema changes (see this page).

• XML2 schema changes (see this page).

2.2.1.1 OTA Schema Changes

Request

• OTA_AirLowFareSearchRQ/OriginDestinationInformation/TPA_Extensions/TotalTravelTime/ @Min

• OTA_AirLowFareSearchRQ/OriginDestinationInformation/TPA_Extensions/TotalTravelTime/ @Max

Sample Request

…

…

2.2.1.2 XML2 Schema Changes

• LFS/SGI/TTS/@TMN – Specifies minimum total travel time.

• LFS/SGI/TTS/@TMX – Specifies maximum total travel time.

Sample LTS Request

Schema Updates


2.2.2 Support Overnight Connections Exclusion

This section includes:

• OTA schema changes (see this page).

• XML2 schema changes (see “XML Schema Changes,” page 6).

The capability to define a Time Window within which the connection should not take place was

implemented. This functionality affects both standard and long connections at the same time.

The format for Time Window is HHMM, for example:

• Time Window start: 2300

• Time Window end: 0100

When you specify this Time Window in the shopping request, the following schedule will not be returned

because the connection in FRA takes place in the excluded Time Window.

1XX/K0 5715 J C D Y B WAWFRA 1030P 1150P E95 R 0 DC /E

M U H Q V W S

2XX/YY 9762 J C D Z P * SIN 245A 450A‡1 388 M 0 DC /E

Y B M U H Q V W S

3XX/YY 9784 J C D Z P * SYD 940A 830P 773 M 0 DC /E

Y B M U H Q V W S

However, if you specify the same Time Window and the system finds the following schedule, it will be

returned because this is a hidden stop (flight number of both flight segments is the same). The stop in

IAH is not treated as a connection, so the “no Time Window exclusion” does not apply.

15NOV SUN SNA/PST FLL/EST‡3

1U0 3 F C A D Z *SNAIAH 6 845P 1130P 320 LR 0 DC /E

P Y B M E U H Q V

U0 3 F C A D Z * FLL 6 120A 725A 752 0 DC /E

P Y B M E U H Q V

2.2.2.1 OTA Schema Changes

New parameters added to request

To allow you to exclude connections that occur within the specified Time Window at the request level,

new Request schema attributes were added on a leg level.

This capability is available for both Long Connections and standard connections. This means that, when

you specify this exclusion in the request or in the rule, this will affect both requests for standard and Long

Connections.

Attribute Description

OTA_AirLowFareSearchRQ/OriginDestinationInformation/TPA_Extensions/ConnectionTime/@ExcludedConnectionBegin

Attribute to specify when the excluded connection time window starts.

OTA_AirLowFareSearchRQ/OriginDestinationInformation/TPA_Extensions/ConnectionTime/@ExcludedConnectionEnd

Attribute to specify when the excluded connection time window ends.

Schema Updates



OTA_AirLowFareSearchRQ/OriginDestinationInformation/TPA_Extensions/ConnectionTime/@EnableExcludedConnection

Attribute to enable connection time window exclusion; default value is “True.”

Sample Request

…

2016-01-01T00:00:00

2016-01-01T00:00:00

…

The sample specifies the excluded ConnectionTime window for both the outbound and inbound leg.

To specify the excluded connection time window for the whole trip (on each leg), you must specify the

same excluded connection time window.

2.2.2.2 XML2 Schema Changes

Request


LFS/SGI/ECT/@ZE1 Attribute to specify when the excluded connection time window starts.

LFS/SGI/ECT/@ZE2 Attribute to specify when the excluded connection time window ends.

LFS/SGI/ECT/@EEC Attribute enabling connection time window exclusion; the default value in the code is “True” when nothing is provided in the request.

Schema Updates


Sample Request

2.3 Change Fee and Refund Information

Changes and Refunds in Bargain Finder Max release 2015.12 is scheduled to be promoted to the Sabre

Dev Studio PROD environment on December 16, 2015.

Bargain Finder Max 2015.12 release contains updates to the following schemas for Change Fees and

Refund Information:

• BargainFinderMaxRQ

• BargainFinderMax_ASRQ

• BargainFinderMax_SAPTRQ

• BargainFinderMax_ADRQ


• BargainFinderMaxRQ changes (see this page).

• BargainFinderMaxRS changes (see “BargainFinderMaxRS Changes,” page 11).

• GroupedItineraryResponse changes (see “GIR Response Changes,” page 13).

2.3.1 BargainFinderMaxRQ Changes


• VoluntaryChanges attribute (see “VoluntaryChanges ,” page 8).

• Match attribute (see “Match Attribute,” page 8).

• Penalty element (see “Penalty Element,” page 8).

• Other available attributes (see “Other Available Attributes,” page 8).

• Filtering options (see “Filtering Options,” page 9).

• OTA Request example (see “OTA Request Example,” page 10).

Schema Updates


2.3.1.1 VoluntaryChanges Element

OTA_AirLowFareSearchRQ/TravelerInfoSummary/AirTravelerAvail/PassengerTypeQuantity/TPA_Exten

sions/VoluntaryChanges/@Match=”Info”

When you specify this attribute in the request, the shopping response will return Change Fee and Refund

information for each of the returned fares.

…

1

….

2.3.1.2 Match Attribute

To allow you to search for specific fares based on the Change/Refund penalty criteria, the Match attribute

has been added.


sions/VoluntaryChanges/@Match

The Match attribute is an indicator for whether all criteria or at least one of the penalty criteria must be

met by the fares returned. Valid values are All and Any.

2.3.1.3 Penalty Element

To allow you to search for specific fares based on the Change/Refund penalty criteria, the Penalty

element has been added.


sions/VoluntaryChanges/Penalty

The Penalty element has been added to support Maximum Penalty specification in the request. Up to two

occurrences of this element are supported to allow you to specify Penalty criteria for Exchanges and

Refunds.

2.3.1.4 Other Available Attributes

The following attributes are available:

Schema Updates


Attributes Definition

@Type Indicates which Penalty type should be taken into consideration while searching fares. Valid values are Refund or Exchange.

@Exclude If set to true, it means that fares with specific penalty will be excluded from the response. Valid values are True and False.

@Amount Indicates the maximum acceptable amount of penalty for fares.

@Currency Indicates the currency in which the penalty amount is provided; if no currency is provided in the request, it will default to the PCC currency. Valid value is a three-character alpha code.

@Decimal Places Indicates the number of decimal places for a particular currency.

2.3.1.5 Filtering Options

Filtering Capability Description New BFM Schema Elements

Request Information Information will be returned to you advising whether the fare is refundable and/or changeable, with or without penalty, and amounts.

Refundable Excludes non-refundable fares. Consider any fare that is refundable to be returned.

Changeable Excludes non-changeable fares. Consider any fare that is changeable to be returned.

Either Changeable or Refundable

Excludes only fully non-changeable + non-refundable fares. Consider any fare that is changeable or refundable to be returned.

Definition of Maximum Penalty Amounts

Consider any fare that is changeable or refundable to be returned, meeting the criteria of maximum penalty amount defined in the request.

If you specify a maximum penalty of 0, changeable or refundable fares without any penalties will be returned.

The response will exclude fully non-refundable/non- changeable fares and refundable/changeable fares with penalties.

If no currency is specified, it will default to the applicable currency in the TJR.

Schema Updates


Filtering Capability Description New BFM Schema Elements

Changeable and Refundable

Excludes any fares that are not fully changeable + refundable. Consider only fares that are both changeable and refundable to be returned with any penalty amount.

Changeable (with max penalty) and Refundable

If no currency is specified, it will default to the applicable currency in the TJR.

Non Refundable Excludes refundable fares.

Schema Updates


1

Schema Updates


New optional qualifiers for filtering allow you to exclude non-changeable/non-refundable fares and

will filter fares with no penalties and by maximum penalty amounts in the shopping and pricing

results. Filtering will include the following capabilities (among others):

o Refundable – Excludes non-refundable fares. Considers any fare that is refundable to be

returned.

o Changeable – Excludes non-changeable fares. Considers any fare that is changeable to be

returned.

o Either Changeable or Refundable – Excludes only fully non-changeable or non-refundable

fares. Considers any fare that is changeable or refundable to be returned.

o Specify Maximum Penalty Amount – Considers any fare that is changeable or refundable to be

returned, meeting criteria of maximum penalty amount defined in the request.

o Changeable and Refundable – Excludes any fare that is not fully changeable and refundable.

Considers only fares that are both changeable and refundable to be returned.

2.3.2.2 Maximum Penalty

The response schema has been changed to pass information about the Maximum Penalty for each returned

fare to the user.

Maximum Penalty information will be returned separately per each passenger type and will not be

summed up at any point.

The following schema tags were added for this purpose:

OTA_AirLowFareSearchRS/PricedItineraries/PricedItinerary/AirItineraryPricingInfo/PTC_FareBreakd

owns/PTC_FareBreakdown/PassengerFare/PenaltiesInfo/Penalty

2.3.2.3 Other Available Attributes

The following attributes will be available in the response:


@PenaltyType Specifies if the penalty applies to refund or exchange. Valid values are Refund or Exchange.

@Applicability Specifies if a penalty applies before or after departure. Valid values are After or Before.

@NonApplicable Specifies whether the given penalty applies. Valid values are True or False.

@Cat16Info Indicates that penalty information comes from Category 16. Valid values are True or False.

Note When set to false, it means that the default source of Penalty information was used: Category 31 and Category 33.

@Amount Decimal value to indicate maximum penalty amount.

@CurrencyCode Valid values are three-character currency codes.

@DecimalPlaces Indicates the number of decimal places for a particular currency.

Schema Updates


2.3.2.4 OTA Response Example

….

…

The example shows that the returned fare has the following penalties:

• Exchange Penalty before departure is USD 54.00.

• Exchange Penalty after departure is USD 54.00.

• Fare is non-refundable before and after departure.

2.3.3 GIR Response Changes


• PenaltiesInfo element (see this page).

• GIR response example (see “GIR Response Example,” page 14).

2.3.3.1 PenaltiesInfo Element

A new element has been added to the response schema on the Passenger Info level:

GroupedItineraryResponse/ItineraryGroup/Itinerary/PricingInformation/Fare/PassengerInfo

/PenaltiesInfo

This element can contain multiple occurrences of the Penalty element. The system will return up to four

Penalty elements with the following attributes:


@Type Indicates to which type penalty applies. Valid values are Refund or Exchange.

@Applicability Indicates when before or after itinerary commencement change penalty applies. Valid values are After or Before.

@NonApplicable Indicate whether a fare is non-refundable. Valid values are True or False.

@Amount Decimal value to indicate maximum penalty amount.

@Currency Currency code. Valid values are three-character currency codes.

Schema Updates


2.3.3.2 GIR Response Example

…

…

The sample shows that the returned fare has the following penalty: The fare is non-changeable and non-

refundable before and after departure.

Documentation Updates


3 Documentation Updates

3.1 WSDL File

Use the new WSDL files to generate proxy code:

http://webservices.sabre.com/wsdl/sabreXML1.0.00/BFM/BargainFinderMaxRQ_ v1-9-2.wsdl

http://webservices.sabre.com/wsdl/sabreXML1.0.00/shopping/BargainFinderMaxRQ_v1-9-2.wsdl

http://webservices.sabre.com/wsdl/sabreXML1.0.00/shopping/BargainFinderMax_SAPTRQ_v1-9-2.wsdl

http://webservices.sabre.com/wsdl/sabreXML1.0.00/shopping/BargainFinderMax_ASRQ_v1-9-2.wsdl

http://webservices.sabre.com/wsdl/sabreXML1.0.00/shopping/BargainFinderMax_ADRQ_v1-9-2.wsdl

3.2 Updated Design Documents

• BargainFinderMaxRQ_v1-9-2_Design.xml

• BargainFinderMax_SAPTRQ_v1-9-2_Design.xml

• BargainFinderMaxRS_v1-9-2_Design.xml

• BargainFinderMax_ASRQ_v1-9-2_Design.xml

• BargainFinderMax_ADRQ_v1-9-2_Design.xml

3.3 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.

3.4 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.

3

http://webservices.sabre.com/wsdl/sabreXML1.0.00/BFM/BargainFinderMaxRQ_%20v1-9-2.wsdlhttp://webservices.sabre.com/wsdl/sabreXML1.0.00/shopping/BargainFinderMaxRQ_v1-9-2.wsdlhttp://webservices.sabre.com/wsdl/sabreXML1.0.00/shopping/BargainFinderMax_SAPTRQ_v1-9-2.wsdlhttp://webservices.sabre.com/wsdl/sabreXML1.0.00/shopping/BargainFinderMax_ASRQ_v1-9-2.wsdlhttp://webservices.sabre.com/wsdl/sabreXML1.0.00/shopping/BargainFinderMax_ADRQ_v1-9-2.wsdl

Documentation Updates


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.

Technical Support


4 Technical Support

4.1 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 800-678-9460

Canada 682-605-5570

International 598-2-518-6020 or your regional Sabre Software help desk

4.3 Email

Email is monitored 24 x 7 with a response within 24 hours or less. The email address is:

[email protected]

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:

https://developer.sabre.com

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 email 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.

4

mailto:[email protected]://developer.sabre.com/

Technical Support


• • •