Introduction

The Retrieve Itinerary (GetReservationRQ) API is used to retrieve and display a passenger name record (PNR) and PNR related data.

This chapter includes the following:

• Processing Information.
• Overview of Request and Response Updates.
• Service version and response formats.
• Request and Response structure.
• Subject Areas.
• Service security.

Processing Information

Once a PNR has been created on the Sabre Host, this Web Service offers capabilities that allow the Airline or Agency to retrieve PNR data using a PNR Locator as a search criterion. It also enables retrieving the PNR from an AAA session. A request payload can be further specified by using ReturnOptions which determine response message content.

There are three types of requests available:

• Stateless: Full data provided at creation and ET at end with Locator.
  • A Sabre PNR will be returned in the XML response without a AAA being accessed from the PNR Reservation Database.
  • All necessary data is provided in RQ.
  • After being created the PNR will be committed.
  • It is required to provide the ReceivedFrom element.
  • The Locator element will be returned in the RS.
• Stateful: Data provided at creation, NO ET at end and no Locator.
  • A Sabre PNR will be retrieved from the AAA session, if no Record Locator (Locator) was present in the request.
  • If a Record locator is present in the request, the Sabre PNR will be loaded into the AAA session (if the current session does not contain changes to a previously unpacked Sabre PNR.)
  • All necessary data is not provided in RQ.
  • After being created, the PNR will not be committed.
  • It is required to provide the “ReceivedFrom” element in the RQ.
  • Remaining details for completing the PNR are entered in the Host Sabre via commands – or using UpdateReservationRQ.
  • After being updated, the PNR will be committed.
• Trip – NO ET at end, no Locator
  • A Sabre PNR will be returned in the XML response without a AAA being accessed from the PNR Operational Data Store

ReturnOptions element can be used to specify which data elements will be present in response payload, as well as how those will be formatted:

XML`ResponseFormat`– the only available data format for client applications now is STL

SubjectAreas – specifies what kind of information should be returned in the response (Itinerary, Pricing Information, etc.)

ViewName – enables the use of a predefined set of Subject Areas

PriceQuoteServiceVersion - used to specify version of webservice used to obtain PQ content. This attribute defines the version of the external webservice (PriceQuoteServicesRQ) called using an PRICE_QUOTE Subject Area

When using pnrbuilder files on versions higher than v1.7.8 you will need to be specify the version number in the namespace. <GetReservationRQ Version="1.19.0" xmlns="http://webservices.sabre.com/pnrbuilder/v1_19&quot;>

Overview of Request and Response Updates

New schema version for v1.19 was introduced with the following main items included in the response:

• Additional fields in GetReservationRS
• New fields for storing additional information regarding PNR (for authorized users only)
• Informational segment flag inclusion
• New capabilities for hotel content (CRUD)
• Views and subject areas
• Ability to choose PQ (PriceQuoteServicesRQ) service version
• Ability to retrieve PayInfo from PNR

Additional fields in GetReservationRS

Additional fields are now added to GetReservationRQ as a result of aligning gaps between TravelItineraryRead API GetReservation API.

This project enables GetReservationRS APIs to populate information such as:

• Meal codes within Air segment

This information is included in response only when DSS subject area is specified in RQ. This SubjectArea is already a predefined in Default view and in ACTIVE Subject area (which is a set of subject areas)

• PrimeHostID - an identification code for the prime host (global distribution system) associated with the reservation

Sample GetReservationRQ:

Sample PrimeHostID element in GetReservationRS:

New fields for storing additional information regarding PNR (for authorized users only)

Sabre Travel Networks (TN) have agencies that were suspected of making fraudulent PNR bookings. This project enables authorized users to mark such PNRs as suspicious. That information can be stored within the PNR and later reviewed.

This functionality was designed for security reasons and its use is regulated through access control at the level of specific entitlements. If you need to access this functionality, please contact the help desk.

Sample GetReservationRQ

Informational segment flag inclusion

The project introduces new files into GetReservationRQ that is used to display a clear indicator in the face of the PNR in Interact, identifying OA flights that are informational and 3rd party booked.

Sample GetReservationRQ

Sample Air segment element with informational flag inclusion in GetReservationRS:

Views and Subject Areas

STL is now in a transition mode to new model of views and subject areas. Few major changes were introduced in this area in order to make views more flexilble.

• Default and Full views will allow to add custom Subject areas to the request
• Full view will be enhanced to include also information stored in DSS and open systems by default
• New Subject areas are introduced to enable capabilities of views that were previously predefined in some specific views:
  • ACTIVE - set of subject areas that include information about airline booking,
  • HISTORICAL

Those changes were made to allow customers to create a custom view using just Subject Areas without a need to extend the view that was previously custom-made.

Below you can see the mapping for Views that will no longer be available in GetReservationRQ starting from 1.19 version.

Ability to choose PQ (PriceQuoteServicesRQ) service version

Customers now have the possibility to choose the version of PriceQuoteServicesRQ API. This will only apply when Subject Area PRICE_QUOTE is used in the request. Default value for this service is set to 3.2.0.

Ability to retrieve PayInfo from PNR

PayInfo contains data in the PAY field in the PNR and can be additionally presented in response.

Service version and Response formats

A correct GetReservationRQ request needs a version number (starting from version 1.7.8) and a provided response format (STL is for now the only supported format).

You should specify 1.19.0 as {SupportedVersion}. The version attribute value should not contain any additional prefixes or suffixes. Only digits and dots should be provided as a version attribute value.

Please note that according to Sabre Versioning Policy only the last five versions of the service is supported, so it is recommended to always use the most recent version.

Request and Response structure

PNR data will be returned depending on the ViewName and SubjectAreas selected. Each View, if permitted, can be extended by Subject Areas. Information from Subject Areas will be provided in response message if the data is present in the PNR.

For more details please review the following:

• View Names
• Subject Areas

GetReservationRQ request message (RQ)

An overview on the GetReservationRQ service design, with the key XML sections highlighted, is presented below. For more information please refer to next paragraphs as well as to the corresponding WSDL and XSD files.

HEADER:

It contains e.g. BinarySecurityToken obtained when authorizing user’s web service session.

BODY:

GetReservatiomRQ is arequired block, some of its attributes like Version are required too.

Version is a required attribute (starting from version 1.7.8)

Locator is a required block for stateless and trip calls

RequestType is a required block

CreateDate is an optional block; PNR creation date is used to retrieve inactive PNR

ReturnOptions this element is used as a container for defining response message format and data range.

UnmaskCreditCard optional attribute for Stateful request; by default, the value of the attribute is set to false.

PriceQuoteServiceVersion - optional attribute; by default, the value of the attribute is set to 3.2.0

SubjectAreas required block for stateless and Trip calls; optional for Stateful - SubjectAreas is used as a container for SubjectAreas which can be used within View.

ViewName required block for stateless and Trip calls; optional for Stateful; Each View includes predefined list of Subject Areas. If permitted, another Subject Areas can be added in the request.

ResponseFormat STL is set as default version and is the only available now

Issuer identification number (IIN) information:

The prefixes and corresponding lengths were based on the following IIN ranges table in http://en.wikipedia.org/wiki/Bank_card_number on 11/30/2010

BankCard and Diners Club enRoute were not considered since they are not Active

Detailed description of parameters for GetReservationRQ

The following descriptions contain basic information about particular elements, though the primary source of knowledge should be the corresponding XSD files. Following there is a list of request parameters (RQ) which can be combined to create a request message. Mandatory elements are in bold letters.

GetReservationRQ/Locator

GetReservationRQ/RequestType

GetReservationRQ/ReturnOptions

GetReservationRQ/ReturnOptions/SubjectAreas

GetReservationRQ/POS

GetReservationRQ/POS/Source

GetReservationRQ/POS/Source/RequestorID

GetReservationRQ/POS/Source/BookingChannel/CompanyName

GetReservationRQ/POS/Source/RequestorID/ArrangerDetails

GetReservationRQ/POS/Source/RequestorID/ArrangerDetails/PersonName

GetReservationRQ/POS/Source/RequestorID/ArrangerDetails/Telephone

GetReservationRQ/POS/Source/RequestorID/ArrangerDetails/Email

GetReservationRQ/POS/Source/BookingChannel

GetReservationRQ/POS/Source/TTYRecordLocator

GetReservationRQ/POS/Source/OAC

GetReservationRQ/Poc

GetReservationRQ/ClientContext

GetReservationRS response message (RS)

The response message consists of elements and attributes, defined in the Schema.

The response is an XML file that contains data stored in PNRs that was requested. PNR data which might be present in response message depends also on the security defined by viewership rules (for more information please review Service Security).

Below you can find a sample of request and response corresponding.

Sample request:

Sample response:

The GetReservationRS service allows client applications can retrieve PNR data including the following:

1. Booking details (Header, Record Locator, Creation Timestamp, Update Timestamp, Flight dates, Itinerary dates, Information about dividing and splitting booking (divided Record, Split to record, split from record)

2. Point of Sale (POS)

   a. Booking Source, Details about agency (PCC and HomePCC) and agent (Agent Duty Code), Airport code, Airline VendorID Source system, TerminalID

   b. Information about requestor – ID, Company details, Arranger details

   c. Booking channel – Company Name

   d. TTY Record Locator (information about Central Reservation System CRS – Locator and Code; Record Locator, Agency ID, IATA Number, Agency Location, User Type, Country Code, Currency, Duty Code, ERSPUserID, First Point Of Departure),

   e. Office Accounting Code (OAC) – Partition ID, Accounting Code, Accounting City Code, Accounting Office Station Code

3. Passenger Reservation

   a. Information about passengers, Information about Frequent Flyer, Email Address, Profiles, Special Requests (Generic special request, Child request, APISRequest, Emergency Contact Request, Special meal request, Passport info message, Seat request, Unaccompanied Minor Message, wheelchair request, Ticketing request

   b. Seats – Prereserved seats, Seat special requests

   c. Prereserved seats

   d. Accounting lines

   e. Passenger Profile ID

   f. Ancillary services

   g. OSI

   h. Remarks

   i. Phone numbers

   j. Ticketing Info

   k. Frequent Traveler Upgrade Requests

   l. Open reservation elements

   m. Segments (In GetReservationRS_v1.11 views (Simple, Default and Full) were adjusted to provide full information about segments (with sequence and id) by default for all segment type. It also allows to combine within one segment e.g. rail/hotel segment and product corresponding to it. This logic will be used in all versions higher than GetReservation _v1.11.)

   n. Forms of payment

   o. Ticketing information

   p. Itinerary Pricing

   q. BSG reservation

4. Reservation Value Score
5. DKNumbers
6. Corporated IDs
7. Received from
8. Reservation extensions\History

Possibility to retrieve information stored in PNR is regulated by viewership rules. For more information please review Service Security.

Views

The PNR data which will be present in the response payload depends on the View Name used in the request. The number of data elements returned in each View can be further narrowed by Subject Areas. If data elements corresponding to a specified Subject Area are not present in the PNR, then those will not be returned in the response payload. The most common View Names and Subject Areas are listed below. Custom made Views and Subject Areas may be developed if required.

1. Active Subject Areas – a set of subject areas that are predefined as default view

2. Primary Subject Areas – a set of subject areas that are predefined as default view (without additional information about the flight that are stored in DSS database

3. Allow Custom Subject Areas – for selected views it is possible to determine what types of data are presented in the web service response by defining SubjectAreas in the request.

4. This functionality will be available starting from September release.

Subject Areas

Subject Areas define what parts of PNR data can be additionally presented in the web service response. Provisioning of Subject Areas in the web service request is optional. Unless Subject Areas are specified in the request, the default Subject Areas defined by the view that was chosen are applied.

Simple view, can be extended by additional SubjectAreas. Information from SubjectAreas will be provided in response message if they were stored in PNR. The most common SubjectAreas are listed in the below.

*Active Subject Areas

1 For more information please go to: https://developer.sabre.com/docs/soap_apis/air/fulfill/manage_price_quote_details/resources, where you can read wide description of the PQ Web Service. The documentation mentioned above is the most up-to date description that is available on dev studio.

User Guide of PriceQuote Web Service (linked above) provides information about types of operations that the service supports and points out the ones that are not valid Price Quote Service requests. It also contains an explanation of essential terms associated with the PriceQuote Web Service transactions.

Service Security

PNR related data retrieving options are available only to authorized users that provided a valid token in the web service request. For most of service views, the getReservationRQ supports branch access and global branch access rules in a consistent manner as the native Sabre application. Users can retrieve data only from the partitions and/or PCCs they have access to. In the most common case, it means that a user of given Airline cannot access data of any other carrier unless it is allowed in the native Sabre system.

Viewership rules suppress the display of PNR or specific information connected to the PNR. The data viewership rules are based on:

• PNR ownership
• Who is trying to view the data (Business Area AS / TN)

In addition, there are some limitations related to the type of Request used. Depending on whether it was Stateless, Stateful or Trip, request viewership rules may differ. In particular, a stateless request cannot receive the history of the PNR.

As PNR viewership is controlled at a PCC level it is not the subject of this User Guide. For more information about particular viewership rules please contact your Accounting manager.