USER GUIDE GETRESERVATIONRQ - SABRE

 
USER GUIDE GETRESERVATIONRQ - SABRE
User Guide
 GetReservationRQ

      Schema Version 1.19.0
              January 2019

                Release 1.0
© 2012-2019, Sabre Inc. All rights reserved.

This documentation is the confidential and proprietary intellectual
property 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 Travel Network and the Sabre Travel Network logo design are
trademarks and/or service marks of an affiliate of Sabre Inc. All other
trademarks, service marks, and trade names are owned by their
respective companies.
Table of Contents

1     Getting Started 1-1

1.1 Introduction .................................................................................................................................................... 1-1
1.2 About This Guide ........................................................................................................................................... 1-1
1.3 Availability...................................................................................................................................................... 1-1
1.4 High-level design ........................................................................................................................................... 1-2
1.5 Key changes comparing to the previous version ........................................................................................... 1-3

2     GetReservation Request and Response Structure                                                         2-1

2.1 Introduction .................................................................................................................................................... 2-1
2.2 Processing Information .................................................................................................................................. 2-1
2.3 Overview of Request and Response Updates ............................................................................................... 2-2
             Additional fields in GetReservationRS ................................................................................................... 2-3
             New fields for storing additional information regarding PNR (for authorized users only) ....................... 2-4
             Informational segment flag inclusion ...................................................................................................... 2-5
             Views and subject areas: ....................................................................................................................... 2-7
             Ability to choose PQ (PriceQuoteServicesRQ) service version ........................................................... 2-12
             Ability to retrieve PayInfo from PNR..................................................................................................... 2-13
2.4 Service version and Response formats ....................................................................................................... 2-15
2.5 Request and response structure .................................................................................................................. 2-16
             GetReservationRQ request message (RQ) ......................................................................................... 2-16
             Detailed description of parameters for GetReservationRQ .................................................................. 2-18
             GetReservationRS response message (RS) ....................................................................................... 2-25
2.6 Views ........................................................................................................................................................... 2-28
2.7 Subject Areas .............................................................................................................................................. 2-29
2.8 Service Security........................................................................................................................................... 2-31

3     Documentation Updates                                         3-33

3.1 Updated Design Documents ........................................................................................................................ 3-33

4     Error Codes                       4-34

4.1 Introduction .................................................................................................................................................. 4-34
4.2 Fault Errors .................................................................................................................................................. 4-34

5     Technical Support – Travel Agencies and 3rd party developers 5-37

5.1 Introduction .................................................................................................................................................. 5-37
5.2 Phone .......................................................................................................................................................... 5-37

User Guide       January 2019                                                                                                                  Table of Contents       iii
5.3 Email ........................................................................................................................................................... 5-37

6     Technical Support – Sabre Hosted Airlines 6-38

6.1 Introduction .................................................................................................................................................. 6-38
6.2 Phone .......................................................................................................................................................... 6-38
6.3 Email ........................................................................................................................................................... 6-41

7     Glossary             1

User Guide       January 2019                                                                                                                iv   Table of Contents
•   ••

User Guide   January 2019            Table of Contents   v
1   Getting Started                                                                                  1
    1.1 I n t r o d u c t i o n

    This guide is for architects and developers to learn how to compose XML formatted requests for
    GetReservationRQ Web Service. This release covers the XML request and responses which allow client
    applications to retrieve PNR data including Itinerary, Passenger information, etc. (details below).
    GetReservationRS message can be returned in STL, respective details can be found in the WSDL file.

    1.2 A b o u t T h i s G u i d e

    The purpose of this document is to describe how the web service works and provide details how to
    create a successful request transaction. This document also provides details on the response
    transaction, including any errors. Each chapter is as follows:
    •    Chapter 1, “Getting Started” explains the purpose of the document, details critical information,
         and provides a functional overview.
    •    Chapter 2, “GetReservationRead Request and Response structure” contains descriptions of the
         attributes and elements in the response schema.
    •    Chapter 3, “Documentation Updates” contains the necessary filenames to run
         GetReservationRQ.
    •    Chapter 4, “Error Codes” contains error codes and descriptions.
    •    Chapter 5, “Technical Support” contains information on where to get help.
    •    The Glossary provides a glossary of terms used in this document.

    1.3 A v a i l a b i l i t y

    This service can be used by:
    •    Sabre Dev Studio subscribers.
    •    Sabre Travel Network customers – travel agencies working on Sabre® Red Workspace™ and
         other Sabre user interfaces.
    •    Airlines
    •    Third-party customers.

    User Guide   January 2019                                                                Introduction   1-1
Both internal and external consumers can take benefits from GetReservationRQ as a part of Sabre
API. The service runs in 24x7 mode. In case of any planned maintenance windows, we send the wide
standard notifications in advance.
We offer the standard service functionalities to all the clients, but availability varies depending on
the type of request used:
     •       Stateless request can be used by airlines only
     •       Stateful request can be used by both airlines and travel agencies.
Specific service capabilities may require dedicated activations.
In case of any doubts, we recommend contacting our Technical Support. Please contact us also if
you plan to start using the service intensively with a high volume of requests, so that we will be able
to tune the service fit for your purposes and ensure the search process will always run smoothly.

1.4 H i g h - l e v e l d e s i g n

User Guide     January 2019                                                             1-2   High-level design
1.5 K e y c h a n g e s c o m p a r i n g t o t h e p r e v i o u s v e r s i o n

GetReservationRQ 1.19 User Guide introduced a couple of changes:

     •       New fields for storing additional information regarding PNR (for authorized users only)
             Enables authorized users to mark PNRs as suspicious using UpdateReservationRQ API and
             read that information using GetReservationRQ.

     •       Informational segment flag inclusion
             Introduces new indicator to identify OA flights that are 3rd party booked.

     •       New capabilities for hotel content (CRUD)
             The new Lodging Platform will enable customers to connect to different sources of content.
             They will be able to provide rates from different suppliers for the same hotel and allow the
             customer to choose which one to book.
             Ability to create hotel bookings in a stateless way regardless of content source:
                 •    Traditional hoteliers through the GDS path (Hilton, Marriott etc)
                 •    Suppliers through a direct connect, mostly hotel aggregators (EAN, GTA, HotelBeds
                      etc)
                 •    Agency sourced content, loaded into our extranet – agency private rates.
     The functionality will be available in Q42018. Description will be provided after activation on
     PROD.
     •       Views and subject areas:
                • Default and Full views will now support adding SubjectAreas into the request
                • New subject areas ACTIVE and HISTORICAL have been added to enable custom
                    views creation

     •       Ability to choose PQ (PriceQuoteServicesRQ) service version
             Supports the ability to specify the PriceQuoteServicesRQ service version instead of
             defaulting to the latest version in PROD

     •       Ability to retrieve PayInfo from PNR
             PayInfo contains data in the PAY field in the PNR

User Guide     January 2019                                          Key changes comparing to the previous version   1-3
2       GetReservation Request and Response Structure                                                  2
    2.1 I n t r o d u c t i o n

    The Retrieve Itinerary (GetReservationRQ) API is used to retrieve and display a passenger name
    record (PNR) and data that ae related to PNR.
    This chapter includes the following:
    •    Processing Information (see this page).
    •    Overview of Request and Response Updates (see “Overview of Request and Response
         Updates”).
    •    Service version and response formats (see “Service version and response formats “).
    •    Request and Response structure (see “Request and Response structure”).
    •    Views (see “Views”).
    •    Subject Areas (see “Subject Areas”).
    •    Service security (see “Service security”).

    2.2 P r o c e s s i n g I n f o r m a t i o n

    Once a PNR has been created on the Sabre Host, this Web Service offers capabilities allowing Airline
    or Agency to retrieve PNR data using PNR Locator as a search criterion. It also enables retrieving PNR
    from AAA session. 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; 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 “ReceivedFrom” element.
         – “Locator” element will be returned in the RS.
    •    Stateful: Data provided at creation, NO ET at end, no Locator

    User Guide   January 2019                                                                  Introduction   2-1
– 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 PNR will not be committed.
     – It is required to provide “ReceivedFrom” element in the RQ.
     – Remaining details for completing the PNR are entered via 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 response (Itinerary,
       Pricing Information, etc.)
     – “ViewName” – enables to use predefined set of Subject Areas
     – “PriceQuoteServiceVersion” - is 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
             
2.3 O v e r v i e w o f R e q u e s t a n d R e s p o n s e U p d a t e s

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

User Guide    January 2019                                            2-2   Overview of Request and Response Updates
•       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:
                o    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)

          LAX
          IATA
          TERMINAL 7
          7
          IAD
          IATA
          UA
          UNITED AIRLINES
          0324
          739
          UA
          0324
          T
          T
          
                   0
                   2
                   1
          
          DCUA*H2X3ME
          true
          2018-10-06T08:28:00
          2018-10-06T16:25:00

User Guide    January 2019                                         Overview of Request and Response Updates   2-3
0324
          T
          HK
          2
          
          false
          true
          false
          2018-01-19T19:55:00
          04.57
          2288
          false
          false
          
          MARKETED BY UNITED AIRLINES
          false
     
     •       PrimeHostID - an identification code for the prime host (global distribution system)
             associated with the reservation
Sample GetReservationRQ:

ns7:GetReservationRQ xmlns:ns7 = "http://webservices.sabre.com/pnrbuilder/v1_19" Version = "1.19.0">
        TUTLPR
        Stateless
        
                 Full
                 STL
        
Sample PrimeHostID element in GetReservationRS:

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

User Guide     January 2019                                           2-4   Overview of Request and Response Updates
Sabre Travel Network (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 PNR and later reviewed.
The functionality is designed for security reasons and the use is regulated through access control at
the level of specific entitlements. If you need the access o this functionality, please contact
helpdesk.

Sample GetReservationRQ:

         FTAZPQ
         Stateful
         
           FullWithOpenRes
           STL
         
Sample Review element in GetReservationRS

                 true
                 TN
                 99
                 Money Fraud
               
                Informational segment flag inclusion

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

       SPBIAP
       Stateless

User Guide   January 2019                                           Overview of Request and Response Updates   2-5
AIR_CABIN
                
                Simple
                STL
        
Sample Air segment element with informational flag inclusion in GetReservationRS:

         LAX
         IATA
         IAD
         IATA
         UA
         UNITED AIRLINES
         0324
         320
         UA
         0324
         T
         T
          
                   0
                   2
                   1
         
         DCUA*H2X3ME
         true
         2018-10-06T08:28:00
         2018-10-06T16:25:00
         0324
         T
         HK
         2
         
         false
         true
         false
         2018-01-19T19:55:00
         
         MARKETED BY UNITED AIRLINES
         false

User Guide   January 2019                                      2-6   Overview of Request and Response Updates
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:
                  o ACTIVE - set of subject areas that include information about airline booking,
                  o HISTORICAL
Those changes were made to enable 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 GetRerservationRQ
starting from 1.19 version.

 View name                         Stateful and Stateless mode        Stateless mode (simplified
                                                                      mapping)
 AcsDefault                        HEADER, NAME, PROFILE              HEADER, NAME, PROFILE
 AebsoFullView                     FQTV, ADDRESS, DKNUMBER,           ACTIVE,
                                   VCR, PASSENGERDETAILS,             STL_ADD_ARUNKS_OPENSEGME
                                   PRERESERVEDSEAT, AFAX, GFAX,       NTS, HISTORICAL
                                   REMARKS, MISC_TICKETING,
                                   BSGPROCESSING,
                                   TARGETMARKETING, FARETYPE,
                                   TICKETINGENTRIES,
                                   BAS_EXTENSION,
                                   CORPORATE_ID,
                                   ACCOUNTING_LINE,
                                   SUBSCRIPTION_CARD,
                                   GROUP_PLANNER,
                                   TRAVEL_POLICY,
                                   CUST_INSIGHT_PROFILE,
                                   TICKETING, TKT_ON_DEMAND,
                                   ITINERARY,
                                   DESCRIPTIVE_BILLING_INFO,
                                   EXT_FQTV, HEADER, NAME,
                                   RECORD_LOCATOR, RECEIVED,
                                   PHONE, ANCILLARY,
                                   ORE_COUNT, EQD_DATA, DSS,
                                   OPENRESDATA,

User Guide     January 2019                                          Overview of Request and Response Updates   2-7
STL_ADD_ARUNKS_OPENSEGME
                            NTS, HISTORICAL
 Asv2DefaultWithSsr         HEADER, NAME, ITINERARY,        HEADER, NAME, ITINERARY,
                            FQTV, ATR, OPEN, AFAX, GFAX,    FQTV, ATR, OPEN, AFAX, GFAX,
                            ADD_PARTNERSHIP_AIRLINES,       ADD_PARTNERSHIP_AIRLINES,
                            ADD_POC,                        ADD_POC,
                            STL_ADD_ARUNKS_OPENSEGME        STL_ADD_ARUNKS_OPENSEGME
                            NTS                             NTS
 DefaultOpenResHistoryLim   HEADER, NAME, ITINERARY,        HEADER, NAME, ITINERARY,
 ited                       RECEIVED, PASSENGERDETAILS,     RECEIVED, PASSENGERDETAILS,
                            AFAX, GFAX, REMARKS, FQTV,      AFAX, GFAX, REMARKS, FQTV,
                            TICKETING,                      TICKETING,
                            SUBSCRIPTION_CARD, LREC_11,     SUBSCRIPTION_CARD, LREC_11,
                            ANCILLARY, OPENRESDATA,         ANCILLARY, OPENRESDATA,
                            OPENRESHISTORY, PHONE,          OPENRESHISTORY, PHONE,
                            ACCOUNTING_LINE,                ACCOUNTING_LINE,
                            ADD_PARTNERSHIP_AIRLINES,       ADD_PARTNERSHIP_AIRLINES,
                            ADD_POC                         ADD_POC
 DefaultOpenResWithHistor   HEADER, NAME, ITINERARY,        HEADER, NAME, ITINERARY,
 y                          RECEIVED, PASSENGERDETAILS,     RECEIVED, PASSENGERDETAILS,
                            AFAX, GFAX, REMARKS, FQTV,      AFAX, GFAX, REMARKS, FQTV,
                            TICKETING,                      TICKETING,
                            SUBSCRIPTION_CARD, LREC_11,     SUBSCRIPTION_CARD, LREC_11,
                            ANCILLARY, OPENRESDATA,         ANCILLARY, OPENRESDATA,
                            OPENRESHISTORY, PHONE,          OPENRESHISTORY, PHONE,
                            ACCOUNTING_LINE,                ACCOUNTING_LINE,
                            ADD_PARTNERSHIP_AIRLINES,       ADD_PARTNERSHIP_AIRLINES,
                            ADD_POC, HISTORICAL             ADD_POC, HISTORICAL
 DefaultWithPq              FQTV, ADDRESS, DKNUMBER,        ACTIVE,
                            VCR, PASSENGERDETAILS,          PRICING_INFORMATION,
                            PRERESERVEDSEAT, AFAX, GFAX,    STL_ADD_ARUNKS_OPENSEGME
                            REMARKS, MISC_TICKETING,        NTS
                            BSGPROCESSING,
                            TARGETMARKETING, FARETYPE,
                            TICKETINGENTRIES,
                            BAS_EXTENSION,
                            CORPORATE_ID,
                            ACCOUNTING_LINE,
                            SUBSCRIPTION_CARD,
                            GROUP_PLANNER,
                            TRAVEL_POLICY,
                            CUST_INSIGHT_PROFILE,
                            TICKETING, TKT_ON_DEMAND,
                            ITINERARY,
                            DESCRIPTIVE_BILLING_INFO,
                            EXT_FQTV, HEADER, NAME,
                            RECORD_LOCATOR, RECEIVED,

User Guide   January 2019                                  2-8   Overview of Request and Response Updates
PHONE, ANCILLARY,
                            ORE_COUNT, EQD_DATA, DSS,
                            OPENRESDATA,
                            PRICING_INFORMATION,
                            STL_ADD_ARUNKS_OPENSEGME
                            NTS
 EmsDefault                 FQTV, ADDRESS, DKNUMBER,        ACTIVE, USE_RAW_CONTENT
                            VCR, PASSENGERDETAILS,
                            PRERESERVEDSEAT, AFAX, GFAX,
                            REMARKS, MISC_TICKETING,
                            BSGPROCESSING,
                            TARGETMARKETING, FARETYPE,
                            TICKETINGENTRIES,
                            BAS_EXTENSION,
                            CORPORATE_ID,
                            ACCOUNTING_LINE,
                            SUBSCRIPTION_CARD,
                            GROUP_PLANNER,
                            TRAVEL_POLICY,
                            CUST_INSIGHT_PROFILE,
                            TICKETING, TKT_ON_DEMAND,
                            ITINERARY,
                            DESCRIPTIVE_BILLING_INFO,
                            EXT_FQTV, HEADER, NAME,
                            RECORD_LOCATOR, RECEIVED,
                            PHONE, ANCILLARY,
                            ORE_COUNT, EQD_DATA, DSS,
                            OPENRESDATA,
                            USE_RAW_CONTENT
 FulfillmentDefault         FQTV, ADDRESS, DKNUMBER,        ACTIVE, ITINERARY,
                            VCR, PASSENGERDETAILS,          PRICING_INFORMATION
                            PRERESERVEDSEAT, AFAX, GFAX,
                            REMARKS, MISC_TICKETING,
                            BSGPROCESSING,
                            TARGETMARKETING, FARETYPE,
                            TICKETINGENTRIES,
                            BAS_EXTENSION,
                            CORPORATE_ID,
                            ACCOUNTING_LINE,
                            SUBSCRIPTION_CARD,
                            GROUP_PLANNER,
                            TRAVEL_POLICY,
                            CUST_INSIGHT_PROFILE,
                            TICKETING, TKT_ON_DEMAND,
                            ITINERARY,
                            DESCRIPTIVE_BILLING_INFO,
                            EXT_FQTV, HEADER, NAME,
                            RECORD_LOCATOR, RECEIVED,

User Guide   January 2019                                  Overview of Request and Response Updates   2-9
PHONE, ANCILLARY,
                            ORE_COUNT, EQD_DATA, DSS,
                            OPENRESDATA,
                            PRICING_INFORMATION
 InteractAll                HEADER, ITINERARY,               HEADER, ITINERARY,
                            STL_ADD_ARUNKS_OPENSEGME         STL_ADD_ARUNKS_OPENSEGME
                            NTS                              NTS
 InteractDefault            HEADER, ITINERARY                HEADER, ITINERARY
 OpenResHistoryOnly         HEADER, NAME, OPENRESDATA,       HEADER, NAME, OPENRESDATA,
                            OPENRESHISTORY, HISTORICAL,      OPENRESHISTORY, HISTORICAL,
                            ADD_PARTNERSHIP_AIRLINES         ADD_PARTNERSHIP_AIRLINES
 PssDisplay                 FQTV, ADDRESS, DKNUMBER,         ACTIVE, HISTORICAL,
                            VCR, PASSENGERDETAILS,           OPENRESDATA,
                            PRERESERVEDSEAT, AFAX, GFAX,     OPENRESHISTORY,
                            REMARKS, MISC_TICKETING,         STL_ADD_ARUNKS_OPENSEGME
                            BSGPROCESSING,                   NTS, ADD_POC
                            TARGETMARKETING, FARETYPE,
                            TICKETINGENTRIES,
                            BAS_EXTENSION,
                            CORPORATE_ID,
                            ACCOUNTING_LINE,
                            SUBSCRIPTION_CARD,
                            GROUP_PLANNER,
                            TRAVEL_POLICY,
                            CUST_INSIGHT_PROFILE,
                            TICKETING, TKT_ON_DEMAND,
                            ITINERARY,
                            DESCRIPTIVE_BILLING_INFO,
                            EXT_FQTV, HEADER, NAME,
                            RECORD_LOCATOR, RECEIVED,
                            PHONE, ANCILLARY,
                            ORE_COUNT, EQD_DATA, DSS,
                            OPENRESDATA, HISTORICAL,
                            OPENRESHISTORY,
                            STL_ADD_ARUNKS_OPENSEGME
                            NTS, ADD_POC
 PssDisplayWithoutHistory   FQTV, ADDRESS, DKNUMBER,         ACTIVE, HISTORICAL,
                            VCR, PASSENGERDETAILS,           OPENRESDATA,
                            PRERESERVEDSEAT, AFAX, GFAX,     STL_ADD_ARUNKS_OPENSEGME
                            REMARKS, MISC_TICKETING,         NTS
                            BSGPROCESSING,
                            TARGETMARKETING, FARETYPE,
                            TICKETINGENTRIES,
                            BAS_EXTENSION,
                            CORPORATE_ID,
                            ACCOUNTING_LINE,

User Guide   January 2019                                  2-10   Overview of Request and Response Updates
SUBSCRIPTION_CARD,
                            GROUP_PLANNER,
                            TRAVEL_POLICY,
                            CUST_INSIGHT_PROFILE,
                            TICKETING, TKT_ON_DEMAND,
                            ITINERARY,
                            DESCRIPTIVE_BILLING_INFO,
                            EXT_FQTV, HEADER, NAME,
                            RECORD_LOCATOR, RECEIVED,
                            PHONE, ANCILLARY,
                            ORE_COUNT, EQD_DATA, DSS,
                            OPENRESDATA, HISTORICAL,
                            STL_ADD_ARUNKS_OPENSEGME
                            NTS
 SimpleWithCvs              HEADER                            HEADER
 SswDefault                 FQTV, ADDRESS, DKNUMBER,          ACTIVE, USE_RAW_CONTENT,
                            VCR, PASSENGERDETAILS,            ADD_TKT_NAME_SEG_ASSOC
                            PRERESERVEDSEAT, AFAX, GFAX,
                            REMARKS, MISC_TICKETING,
                            BSGPROCESSING,
                            TARGETMARKETING, FARETYPE,
                            TICKETINGENTRIES,
                            BAS_EXTENSION,
                            CORPORATE_ID,
                            ACCOUNTING_LINE,
                            SUBSCRIPTION_CARD,
                            GROUP_PLANNER,
                            TRAVEL_POLICY,
                            CUST_INSIGHT_PROFILE,
                            TICKETING, TKT_ON_DEMAND,
                            ITINERARY,
                            DESCRIPTIVE_BILLING_INFO,
                            EXT_FQTV, HEADER, NAME,
                            RECORD_LOCATOR, RECEIVED,
                            PHONE, ANCILLARY,
                            ORE_COUNT, EQD_DATA, DSS,
                            OPENRESDATA,
                            USE_RAW_CONTENT,
                            ADD_TKT_NAME_SEG_ASSOC
 TktDefault                 FQTV, ADDRESS, DKNUMBER,          ACTIVE
                            VCR, PASSENGERDETAILS,
                            PRERESERVEDSEAT, AFAX, GFAX,
                            REMARKS, MISC_TICKETING,
                            BSGPROCESSING,
                            TARGETMARKETING, FARETYPE,
                            TICKETINGENTRIES,
                            BAS_EXTENSION,

User Guide   January 2019                                  Overview of Request and Response Updates   2-11
CORPORATE_ID,
                              ACCOUNTING_LINE,
                              SUBSCRIPTION_CARD,
                              GROUP_PLANNER,
                              TRAVEL_POLICY,
                              CUST_INSIGHT_PROFILE,
                              TICKETING, TKT_ON_DEMAND,
                              ITINERARY,
                              DESCRIPTIVE_BILLING_INFO,
                              EXT_FQTV, HEADER, NAME,
                              RECORD_LOCATOR, RECEIVED,
                              PHONE, ANCILLARY,
                              ORE_COUNT, EQD_DATA, DSS,
                              OPENRESDATA,
 VaDefaultWithPq              FQTV, ADDRESS, DKNUMBER,           ACTIVE,
                              VCR, PASSENGERDETAILS,             PRICING_INFORMATION,
                              PRERESERVEDSEAT, AFAX, GFAX,       STL_ADD_ARUNKS_OPENSEGME
                              REMARKS, MISC_TICKETING,           NTS. DSS
                              BSGPROCESSING,
                              TARGETMARKETING, FARETYPE,
                              TICKETINGENTRIES,
                              BAS_EXTENSION,
                              CORPORATE_ID,
                              ACCOUNTING_LINE,
                              SUBSCRIPTION_CARD,
                              GROUP_PLANNER,
                              TRAVEL_POLICY,
                              CUST_INSIGHT_PROFILE,
                              TICKETING, TKT_ON_DEMAND,
                              ITINERARY,
                              DESCRIPTIVE_BILLING_INFO,
                              EXT_FQTV, HEADER, NAME,
                              RECORD_LOCATOR, RECEIVED,
                              PHONE, ANCILLARY,
                              ORE_COUNT, EQD_DATA, DSS,
                              OPENRESDATA,
                              PRICING_INFORMATION,
                              STL_ADD_ARUNKS_OPENSEGME
                              NTS. DSS

                Ability to choose PQ (PriceQuoteServicesRQ) service version

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

User Guide   January 2019                                      2-12   Overview of Request and Response Updates
IJKZUQ
        Stateless
        
                         PRICE_QUOTE
                
                Simple
                STL
                
                         M
                         PQ
                         < ResultType>S
                
                Ability to retrieve PayInfo from PNR

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

                  VI
         
                  4XXXXXXXXXXX1111
         
                  0119
         
                  VI
         
                  4XXXXXXXXXXX1111
         
                  0119
         
                  VI

User Guide   January 2019                                           Overview of Request and Response Updates   2-13
4XXXXXXXXXXX1111
             
                      0119
             
                      JT
             
                      8279003198058032
             
                      0919
             
                      BOSLAX0287X08NOV
             
                      AWP10000
             
                      AWN709736324
             
                      2792107549361
             
                      3198058032
             
                      LAXBOS0688X16NOV
             
                      AWP11800
             
                      AWN709736324
             
                      2792107549361
             
                      3198058032
             
                      BOSBOS0287X08NOV
             
User Guide     January 2019                                            2-14   Overview of Request and Response Updates
2790610866790
         
                  USD25.00
         
                  APAY
         
                  BOSLAX0287X08NOV
         
                  2790610866791
         
                  USD101.00
         
                  AWP1200
         
                  AWN709736325
         
                  3198058032
         
2.4 S e r v i c e v e r s i o n a n d R e s p o n s e f o r m a t s

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

...
2.5 R e q u e s t a n d r e s p o n s e s t r u c t u r e

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 (see “View Names,” page 2-28).
•    Subject Areas (see “Subject Areas,” page 2-19).
                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.

User Guide   January 2019                                              2-16   Request and response structure
HEADER:
 It contains e.g. BinarySecurityToken obtained when authorizing user’s web service session.

 BODY:
  required block, some its attributes like Version are required too.

          is required attribute (starting from version 1.7.8)

         < Locator > required block for stateless and trip calls;

          required block;

          optional block; PNR creation date used to retrieve inactive PNR

          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 Steteful - "SubjectAreas" is
               used as a container for "SubjectAreas" which can be used within “View”.

               < ViewName > required block for stateless and Trip calls; optional for Steteful; 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

         < POS >
               < Source> Source holds details regarding the requestor. It may be repeated to also accommodate the
               delivery system.;

          optional block – default; Point of Commencement is the first point of departure amongst all of
         segments present in the PNR.
         "Poc" can be used to explicitly specify journey's Point of Commencement in case itinerary contains other
         segments than air segments as well. Provided values will be present in the RS payload in case they are earlier
         than those defined by the first air segment.

          ClientContext is required when calling the downline services: Web Check In; Web RES;
         Interact Check In; Interact RES; Kiosk Check In; TTY; PRS; GSM; SSCI
         If context is set in GetReservation request - master PNR is retrieved

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

 Issuing Network            IIN Ranges                                   Active       Length            Validation

 American Express 34, 37                                                 Yes          15                Luhn algorithm

 Bankcard                   5610, 560221-560225                          No           16                Luhn algorithm

User Guide   January 2019                                                                    Request and response structure   2-17
China UnionPay             62                               Yes   16               unknown

 Diners Club Carte          300-305                          Yes   14               Luhn algorithm
 Blanche

 Diners Club                2014, 2149                       No    15               no validation
 enRoute

 Diners Club                36                               Yes   14               Luhn algorithm
 International

 Diners Club                54, 55                           Yes   16               Luhn algorithm
 United States &
 Canada

 Discover Card              6011, 622126-622925, 644-        Yes   16               Luhn algorithm
                            649, 65

 InstaPayment               637-639                          Yes   16               Luhn algorithm

 JCB                        3528-3589                        Yes   16               Luhn algorithm

 Laser                      6304, 6706, 6771, 6709           Yes   16-19            Luhn algorithm

 Maestro                    5018, 5020, 5038, 6304, 6759,    Yes   12-19            Luhn algorithm
                            6761, 6763

 MasterCard                 51-55                            Yes   16               Luhn algorithm

 Solo                       6334, 6767                       Yes   16, 18, 19       Luhn algorithm

 Switch                     903, 4905, 4911, 4936, 564182,   Yes   16, 18, 19       Luhn algorithm
                            633110, 6333, 6759

 Visa                       4                                Yes   16               Luhn algorithm

 Visa Electron              4026, 417500, 4508, 4844,        Yes   16               Luhn algorithm
                            4913, 4917

                Detailed description of parameters for GetReservationRQ

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

GetReservationRQ/Locator

User Guide   January 2019                                               2-18    Request and response structure
Element                         Description

   Locator                         Locator is used to identify a particular PNR.

                                   Locator is optional only if RequestType is set to Stateful, in such case information is
                                   taken from current user session (AAA).

                                   Web Service design allows to process only one Locator per request. Request
                                   containing multiple Locators will not be processed correctly.

GetReservationRQ/RequestType

   Element                         Description

   RequestType                     RequestType is used to define how PNR data will be retrieved. It can be set to:
                                   Stateless, Trip, Stateful.

                                   Stateful request mainly deals with PNRs that have not been committed; therefore,
                                   Locator cannot be mandatory.

                                   Stateless/Trip request deals with PNRs that have been committed and stored in
                                   database. This request type requires PNR Locator.

GetReservationRQ/ReturnOptions

   Element              Element             Attribute                      Description

   ReturnOptions                                                           Return Options are used to define format and
                                                                           data range of response payload.

                                            UnmaskCreditCard               ReturnOptions contains the attribute
                                                                           UnmaskCreditCard and by default the value of
                                                                           the attribute is false. When a request is made
                                                                           with this attribute as true the user must have
                                                                           the EPR keyword CCVIEW; credit card
                                                                           information in the response will be presented
                                                                           in unmasked format, else the credit card
                                                                           information will always be in masked format.

                                            PriceQuoteServiceVersion       ReturnOptions contains the attribute
                                                                           PriceQuoteServiceVersion and by default the
                                                                           value of the attribute is set to 3.2.0. This
                                                                           attribute defines the version of the external
                                                                           webservice (PriceQuoteServicesRQ) called
                                                                           using an PRICE_QUOTE Subject Area.

                        SubjectAreas                                       "SubjectAreas" specifies particular information
                                                                           to be included in response message if they are
                                                                           stored in the PNR.

                        ViewName                                           The PNR data present in the response payload
                                                                           depends on the specified View Name used in
                                                                           the request (see “View Names and Subject
                                                                           Areas,” page 2-28).
                                                                           Number of data elements returned in each
                                                                           View can be further narrowed using the

User Guide   January 2019                                                                  Request and response structure    2-19
optional values of RetrievePNR = true/false or
                                                                         IncludeUpdateDetails = true/false.

                            ResponseFormat                               ResponseFormat enables to define how
                                                                         response payload will be formatted and value
                                                                         should be STL.

GetReservationRQ/ReturnOptions/SubjectAreas

   Element                         Element                 Description

   SubjectAreas                    SubjectArea             "SubjectAreas" specifies particular information to be
                                                           included in response message if they are stored in the PNR
                                                           (see “View Names and Subject Areas,” page 2-28).

GetReservationRQ/POS

   Element                            Element              Description

   POS                                Source               Source holds details regarding the requestor. It may be
                                                           repeated to also accommodate the delivery system.

GetReservationRQ/POS/Source

   Element             Attribute                 Element              Description

   Source                                                             This holds details regarding the requestor. It
                                                                      may be repeated to also accommodate the
                                                                      delivery systems.
                       BookingSource                                  Identifies the booking source within the
                                                                      requesting entity.

                       AgentSine                                      Identifies the party within the requesting
                                                                      entity.

                       PseudoCityCode                                 An identification code assigned to an office
                                                                      agency by a reservation system.

                       ISOCountry                                     The country code of the requesting party.

                       ISOCurrency                                    The currency of the country of the requesting
                                                                      party.

                       AgentDutyCode                                  An authority code assigned to a requestor.

                       AirlineVendorID                                The IATA assigned airline code.

                       AirportCode                                    The IATA assigned airport code.

                       FirstDepartPoint                               The point of first departure in a trip.

                       SourceSystem                                   e.g., CSS or CSI

User Guide   January 2019                                                                2-20   Request and response structure
TerminalID                                  The electronic address of the device from which
                                                                   information is entered.

                       HomePseudoCityCode                          An identification code assigned to the
                                                                   office/agency home city by a reservation
                                                                   system.
                                            RequestorID            An identifier of the entity making the request
                                                                   e.g., ATA/IATA/ID number, Electronic
                                                                   Reservation Service Provider (ERSP),
                                                                   Association of British Travel Agents (ABTA).

                                            BookingChannel         Specifies the booking channel type and
                                                                   whether it is the primary means of connectivity
                                                                   of the source.

                                            TTYRecordLocator       Received via TeleType, the Locator is used to
                                                                   identify a particular PNR.

                                            OAC                    The Office Account Code defines the agency
                                                                   PCC extension.

GetReservationRQ/POS/Source/RequestorID

   Element              Attribute           Element            Description

   RequestorID                                                 An identifier of the entity making the request (e.g.
                                                               ATA/IATA/ID number, Electronic Reservation
                                                               Service Provider (ERSP), Association of British Travel
                                                               Agents (ABTA)).

                        URL                                    URL that identifies the location associated with the
                                                               record identified by the UniqueID.

                        Type                                   A reference to the type of object defined by the
                                                               UniqueID element. Refer to OTA Code
                                                               List Unique ID Type (UIT).

                        Instance                               The identification of a record as it exists at a point
                                                               in time. An instance is used in update messages
                                                               where the sender must assure the server that the
                                                               update sent refers to the most recent modification
                                                               level of the object being updated.

                        ID                                     A unique identifying value assigned by the creating
                                                               system. The ID attribute may be used to reference a
                                                               primary-key value within a database or in a
                                                               particular implementation.

                        ID_Context                             Used to identify the source of the identifier (e.g.,
                                                               IATA, ABTA).

                        MessagePassword                        This password provides an additional level of
                                                               security that the recipient can use to validate the
                                                               sending party's authority to use the message.

                                            CompanyName        Identifies the company that is associated with the
                                                               UniqueID.

                                            ArrangerDetails    Contact information for the person that makes the
                                                               arrangements of the PNR.

User Guide   January 2019                                                           Request and response structure    2-21
GetReservationRQ/POS/Source/RequestorID/CompanyName
GetReservationRQ/POS/Source/BookingChannel/CompanyName

   Element                  Attribute          Description

   CompanyName                                 Identifies the company that is associated with the
                                               UniqueID.

                            CompanyShortName   Used to provide the company common name.

                            TravelSector       Refers to OTA Code List Travel Sector (TVS).

                            Code               Identifies a company by the company code.

                            CodeContext        Identifies the context of the identifying code, such as
                                               DUNS, IATA or internal code.

                            Division           The division name or ID with which the contact is
                                               associated.

                            Department         The department name or ID with which the contact is
                                               associated.

GetReservationRQ/POS/Source/RequestorID/ArrangerDetails

   Element                  Element            Description

   ArrangerDetails                             Used to identify the details of the requestor.

                            PersonName         Used to identify the contact name details of the requestor.

                            Telephone          Used to identify the telephone number details of the
                                               requestor.

                            Email              Used to identify the email address details of the requestor.

GetReservationRQ/POS/Source/RequestorID/ArrangerDetails/PersonName

   Element                  Element            Description

   PersonName                                  Used to identify the contact name details of the
                                               requestor.

                            Prefix             A salutation of honorific e.g., Mr., Mrs., Ms., Miss., Dr.

                            Given              The given name, first name or names.

                            Middle             The middle name of the person name.

                            Surname            The family name also known as last name

                            Suffix             Holds various name suffixes and letters e.g., Jr., Sr., III.,
                                               Ret., Esq.

                            Type               Values include ADT or INF

User Guide   January 2019                                                   2-22   Request and response structure
Element                          Element                  Description

                                    PreferredFirstName       Any preferred name for first name used instead of the
                                                             Given Name.

                                    PreferredSurname         Any preferred names for last name used instead of
                                                             Surname.

GetReservationRQ/POS/Source/RequestorID/ArrangerDetails/Telephone

   Element                          Element                  Description

   Telephone                                                 Used to identify the telephone details of the requestor.

                                    PhoneUseType             Describes the type of telephone number, in the context of
                                                             its general use (e.g. Home, Business, Emergency Contact,
                                                             Travel Arranger, Day, Evening). Refer to OpenTravel Code
                                                             List
                                                             Phone Use Type (PUT).

                                    PhoneCountryCode         Describes the Country Code for the telephone number of
                                                             the requestor.

                                    PhoneCountryName         Describes the Country Name for the telephone number of
                                                             the requestor.

                                    PhoneNumber              Telephone number assigned to a single location.

GetReservationRQ/POS/Source/RequestorID/ArrangerDetails/Email

   Element                          Description

   Email                            Address of arranger, e.g. jdoe125@travelgo.com

GetReservationRQ/POS/Source/BookingChannel

   Element              Attribute             Element            Description

   Booking Channel                                               Specifies the booking channel type and whether it is
                                                                 the primary means of connectivity of the source.

                        Type                                     The type of booking channel (e.g. Global Distribution
                                                                 System (GDS), Alternative Distribution System (ADS),
                                                                 Sales and Catering System (SCS),           Property
                                                                 Management System (PMS), Central Reservation
                                                                 System (CRS), Tour Operator System (TOS), Internet
                                                                 and ALL). Refer to OTA Code           List Booking
                                                                 Channel Type (BCT).

                        Primary                                  Indicates whether the enumerated booking channel is
                                                                 the primary means of connectivity used by the source.

                                              CompanyName        Identifies the company that is associated with the
                                                                 booking channel.

User Guide   January 2019                                                               Request and response structure   2-23
GetReservationRQ/POS/Source/TTYRecordLocator

   Element                     Element                    Description

   TTYRecordLocator                                       Received via TeleType, the Locator is used to identify a
                                                          particular PNR.

                               CRSLocator                 If the PNR was received from OAL (from CRS or OAL), the
                                                          Record Locator of the PNR in the creating system. Occurs
                                                          only for TTY created PNRs. Value for this optional field
                                                          can be populated if available. This optional field is used
                                                          for information and display purposes only.

                               CRSCode                    Airline Code of the RES System or CRS system that created
                                                          this PNR. This optional field is not used in any processing.
                                                          This optional field is used for information and display
                                                          purposes only.

                               RecordLocator              Used to identify a particular PNR.

                               AgencyId                   The booking source arranger.

                               IataNumber                 The booking source location IATA number.

                               AgencyLocation             The booking source agent location.

                               UserType                   Includes the values of A-Airline, E-ERSP, N-no user ID
                                                          assigned by IATA, T-user ID assigned by IATYA other than
                                                          ERSP.

                               CountryCode                Describes the Country Code for the telephone number of
                                                          the requestor.

                               Currency                   The currency of the country of the requesting party.

                               DutyCode                   Duty code of the agent that issued a
                                                          ticket/refund/exchange /void.

                               ERSPUserId                 The Electronic Reservation Service Provider number.

                               FirstPointOfDeparture      The first point of departure for the booking.

GetReservationRQ/POS/Source/OAC

   Element                  Element                               Description

   OAC                                                            Office Account Code. Defines agency PCC
                                                                  extension.

                            PartitionId                           Default partition code from the OAC data

                            AccountingCityCode                    The personal account city code associated with
                                                                  the user AAA city during the original PNR create
                                                                  session.

                            AccountingCode                        The personal account code associated with the
                                                                  user AAA city during the original PNR create
                                                                  session.

                            AccountingOfficeStationCode           The station code from the OAC line used in this
                                                                  PNR Create Session

User Guide   January 2019                                                            2-24   Request and response structure
GetReservationRQ/Poc

   Element                      Element                  Description

   Poc                                                   Point of Commencement is the first point of departure
                                                         amongst all of segments present in the PNR.
                                                         Poc can be used to explicitly specify journey's Point of
                                                            Commencement in case itinerary contains other
                                                            segments than air segments as well.
                                                         Provided values will be present in the RS payload in case
                                                            they are earlier than those defined by the first air
                                                            segment.

                                Airport                  Airport name.

                                Departure                Date and Time of departure.

GetReservationRQ/ClientContext

   Element                      Element                  Description

   ClientContext                                         It is required to provide ClientContext when calling the
                                                         downline services: Web Check In; Web RES; Interact Check
                                                         In; Interact RES; Kiosk Check In; TTY; PRS; GSM; SSCI
                                                         If context is set in GetReservation request - master PNR is
                                                         retrieved

                                Name                     Allows users to provide information about the caller to the
                                                         service.
                                                         This parameter is currently only available with
                                                         customization and it is not a standard service.

                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:
   
    Stateful
    
      Full
      STL
    
User Guide   January 2019                                                            Request and response structure   2-25
Sample response:

        GADLPQ
        2015-09-16T13:36:00
        2015-09-16T13:36:00
        DTZ
        2015-09-16T13:36:51
        2
        
        2015-10-15T00:00:00
        -57b7e7b52c59dae59ff958e2a4b48683fe2ce5a822cfa248
      
           SBAQ
           RMQ
           
           AUH
           2015-10-15T10:25:00
         
            AUH
            IATA
            SYD
            IATA
            EY
            ETIHAD AIRWAYS
            77W
            EY
            0450
            B
            B
            
            RLEY*OCBVXG
            true
            2015-10-15T10:25:00

User Guide   January 2019                                                      2-26   Request and response structure
2015-10-16T07:30:00
            0450
            B
            HK
            1
            
            false
            false
            false
            2015-09-16T13:36:00
          
          TAW
          *
         
       QA TESTING
      
         HDQ
         1800123456
       
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

User Guide   January 2019                                                   Request and response structure   2-27
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.

2.6 V i e w s

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.

                                                                       Allow Custom
 View                 Description                                                          History
                                                                       Subject Areas3

User Guide     January 2019                                                                   2-28   Views
Always used, regardless of whether it is provided in
    Simple            the request.                                                      Yes               No
                      Includes: HEADER (Booking and Point of Sale details).

                      It contains PNR data specified by all ACTIVE1 SUBJECT
    Default           AREAS.                                                            Yes               No
                      Includes: SIMPLE VIEW; all PRIMARY SUBJECT AREAS

                      It contains PNR data spec

    Full              ified by all PRIMARY2 and HISTORY SUBJECT AREAS.                  Yes4              Yes
                      Includes: SIMPLE VIEW; all PRIMARY SUBJECT AREAS,
                      DSS4, AIR_CABIN4, OPENRESDATA

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.

2.7 S u b j e c t A r e a s

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.

     Subject Areas                         Description

     ACCOUNTING_LINE                       Agency accounting lines stored in the PNR.

     ACTIVE                                This SA is an aggregator for a wide group of other Subject Areas: FQTV,
                                           ADDRESS, DKNUMBER, VCR, PASSENGERDETAILS, PRERESERVEDSEAT, AFAX,
                                           GFAX, REMARKS, MISC_TICKETING, BSGPROCESSING, FARETYPE,
                                           TICKETINGENTRIES, BAS_EXTENSION, CORPORATE_ID, ACCOUNTING_LINE,
                                           SUBSCRIPTION_CARD, GROUP_PLANNER, TRAVEL_POLICY,
                                           CUST_INSIGHT_PROFILE, TICKETING, TKT_ON_DEMAND, ITINERARY,
                                           DESCRIPTIVE_BILLING_INFO, EXT_FQTV, HEADER, NAME, RECORD_LOCATOR,
                                           RECEIVED, PHONE, ANCILLARY, ORE_COUNT, EQD_DATA, DSS, OPENRESDATA
                                           - Available only in stateless mode

     ADDRESS                               Agency address data stored in the PNR.

User Guide    January 2019                                                                        Subject Areas   2-29
ADD_SSR_RPH                     RPH attribute for particular SSR

   AIR_CABIN                       Air Cabin supplements segment information with Air Cabin Class information
                                   and adds Product nodes (Itinerary Products stored in Open Res)

   AFAX                            AFAX allows to display hosted facts under GenericSpecialRequests and
                                   OpenReservationElemets nodes (any SSR or OSI; DOCS, DOCO, WCHR, VGML,
                                   PETC); All American Airlines facts (AFAX) excluding Pre-reserved seats

   ANCILLARY                       Ancillary Items (Air Extra) stored in the PNR. Ancillaries are displayed in the
                                   response only when NAME subject area is used in request.

   BAS_EXTENSION                   BAS_EXTENSION supplements itinerary data with some additional data,
                                   mainly connected to Hotels and Cars e.g. confirmation number in Hotel,
                                   credit card inf.

   BSGPROCESSING                   Block Space Group data stored in the PNR.

   CARRIER_INFORMATION_CALCULATE   Using this Subject Area display of operating airline is chanaged in response:
                                   information from DSS are used to recalculate the information of operating
                                   airline.

   CARRIER_INFORMATION_COMPACT     Using this Subject Area display of operating airline is chanaged in response: if
                                   operating Airline is equal marketing airline only marketing airline is
                                   displayed.

   CORPORATE_ID                    Agency ID for Corporate Client stored in the PNR.

   CUST_INSIGHT_PROFILE            Allows to display Profile information (Customer and Corporate)

   DK_NUMBER                       Customer number stored in the PNRagencies use DK number primarily as
                                   an account reference identifier for billing purposes.

   DSS                             DSS supplements segment information with data stored in DSS (those are
                                   elapsed time, Air Miles Flown, Funnel Flight, Change of Gauge, Operating
                                   Airline Code, Stop Quantity) and updates Equipment Type with current data.

   EXT_FQTV                        External Frequent Traveler Number

   FARETYPE                        Fare data stored in the PNR.

   FQTV                            Frequent Flyer details stored in PNR.

   GFAX                            GFAX allows to display general facts; All airline facts

   HEADER                          PNR header data.

   HISTORICAL                      - Displays history of the PNR
                                   - Available only in stateless mode
                                   - Allows to display PNR history

   ITINERARY                       Itinerary data stored in the PNR including Air, Rail, Car, Hotel, etc. To display
                                   full Itinerary information request should also include additional Subject
                                   areas: DSS, AIR_CABIN, OPENRESDATA, BAS_EXTENSION

   NAME                            Passenger Name stored in the PNR.

   PASSENGERDETAILS                Profile data, passenger type, email address, and other details stored in the
                                   PNR.

   PAY_INFO                        PayInfo contains data in the PAY field in the PNR

   PHONE                           Phone data stored in the PNR.

User Guide   January 2019                                                                          2-30   Subject Areas
POPULATE_IS_PAST                 To determine if a particular segment is active or in past

    PRICE_QUOTE1                     PQ data received from PQ web service. The service is applicable for all price
                                     quote users (basic and enhanced PQ).

    PRERESERVEDSEAT                  Pre reserved seat data stored in the PNR.

    PRICING_INFORMATION              Itinerary pricing information stored in PNR. This subject area is used to
                                     retrieve price quote information. This is a legacy way of retrieving those data
                                     and is no longer recommended. The recommended way to obtain this
                                     information is to use PRICE_QUOTE subject area.

    RECEIVED                         Received From Field stored in the PNR.

    RECORD_LOCATOR                   Allows to display TTY Record Locator

    REMARKS                          Allows to display remark information (supported types: REG, HD, HS, CLIADR,
                                     DELADR, INVOICE, ITINERARY, INTERFACE, CODED_A, PRTONTKT,
                                     CORPORATE, FOP, QQ, FILLER, ITINSEGASSOC)

    REMARK_ACTION_CODE               GetRes will return ActionCode as a prefix in RemarkLine text for
                                     types: SBUDIDS (INVOICE), SBPRINTONTICKET (PRTONTKT), SBCORPORATE
                                     (CORPORATE), SBBILLING (INTERFACE) only when REMARK_ACTION_CODE
                                     subject area is provided

    TICKETING                        Ticketing information stored in the PNR.

    VCR                              Virtual Coupon Record

*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

2.8 S e r v i c e S e c u r i t y

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 a 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:

User Guide   January 2019                                                                        Service Security   2-31
• 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 used Stateless, Stateful or Trip request viewership rules may differ. In particular, a stateless
request is not possible to receive history of the PNR.
As PNR viewership are 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.

User Guide   January 2019                                                             2-32   Service Security
3    Documentation Updates                                                                             3
    Sabre Web Services are currently available on the Sabre Dev Studio site
    https://developer.sabre.com.
    GetReservationRQ will be stored in the Trip Management folder as Retrieve Itinerary.
    Common schema files listed below are available on the Sabre Dev Studio site
    https://developer.sabre.com/docs/read/soap_basics/development_patterns

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

     WSDL                       GetReservation_1.19.0.wsdl

                                GetReservationSTLRQ_v1.19.0.xsd
                                GetReservationSTLRS_v1.19.0.xsd
                                Ancillaries.1.14.0.xsd
     Schema                     Pricing.1.14.0
                                Lodging.1.14.0
                                PNRBuilderTypes_v1.19.0.xsd;
                                OpenReservation.1.14.0.xsd
                                envelope.xsd;
                                msg-header-2_0.xsd;
                                wsse.xsd;
     Common Schemas
                                xlink.xsd;
                                xml.xsd;
                                xmldsig-core-schema.xsd

     Payload Design             GetReservationRQ_1.19.0_Design.xml
     Documents                  GetReservationRS_1.19.0_Design.xml
     Additional
     Documentation              GetReservationRQ_1.19.0_User Guide.pdf

     Sample XML
     Payloads                   GetReservationListRQRS_SamplePayload_v1.19.xml

    User Guide   January 2019                                                    Updated Design Documents   3-33
4    Error Codes                                                                           4
    4.1 I n t r o d u c t i o n

    This chapter contains the list of most common error codes and descriptions.

    4.2 F a u l t E r r o r s

       Message                                                        OTA Code

       General PNR error                                              700001

       Invalid PNR locator                                            700002

       Invalid request                                                700003

       Invalid request format                                         700004

       Invalid request view                                           700005

       No PNR was found with the specified record locator             700101

       Viewership is restricted for the PNR                           700102

       No data for the PNR in DB                                      700103

       Error parsing PNR                                              700104

       PNR Connector unknown                                          700201

       PNR Connector communication error                              700202

       PNR Connector communication timeout error                      700203

       JAXB marshalling error                                         700204

       JAXB unmarshalling error                                       700205

       Unexpected request type                                        700206

       MOM messaging error                                            700207

       PNRC service invocation error                                  700208

       Error response from PNRC reaccomodation search service         700209

       Unknown response format                                        700210

       OTA parsing error                                              700211

       Cannot unpack request from request root element                700212

    User Guide   January 2019                                                     4-34   Introduction
You can also read
Next slide ... Cancel