GetReservationRQ v1.18.0 User Guide - Sabre Dev...

42
User Guide GetReservationRQ Schema Version 1.18.0 February 2018 Release 1.0

Transcript of GetReservationRQ v1.18.0 User Guide - Sabre Dev...

Page 1: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide GetReservationRQ

Schema Version 1.18.0

February 2018

Release 1.0

Page 2: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

© 2012-2018, 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.

Page 3: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 Table of Contents iii

Table of Contents

1 G e t t i n g S t a r t e d 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 G e t R e s e r v a t i o n 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 2 - 1

2.1 Introduction .................................................................................................................................................... 2-1 2.2 Processing Information .................................................................................................................................. 2-1 2.3 Overview of Request and Response Updates ............................................................................................... 2-2

Alignment of gaps between TIR and GetRes API .................................................................................. 2-3 New version of Price Quote service ....................................................................................................... 2-7

2.4 Service version and Response formats ......................................................................................................... 2-7 2.5 Request and response structure .................................................................................................................... 2-7

GetReservationRQ request message (RQ) ........................................................................................... 2-8 Detailed description of parameters for GetReservationRQ .................................................................... 2-8 GetReservationRS response message (RS) ....................................................................................... 2-15

2.6 Views ........................................................................................................................................................... 2-18 2.7 Subject Areas .............................................................................................................................................. 2-19 2.8 Service Security ........................................................................................................................................... 2-21

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

3.1 Updated Design Documents ........................................................................................................................ 3-22

4 E r r o r C o d e s 4 - 2 3

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

5 T e c h n i c a l S u p p o r t – T r a v e l A g e n c i e s a n d 3 r d p a r t y d e v e l o p e r s 5 - 2 6

5.1 Introduction .................................................................................................................................................. 5-26 5.2 Phone .......................................................................................................................................................... 5-26 5.3 Email ........................................................................................................................................................... 5-26

6 T e c h n i c a l S u p p o r t – S a b r e H o s t e d A i r l i n e s 6 - 2 7

6.1 Introduction .................................................................................................................................................. 6-27

Page 4: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 iv Table of Contents

6.2 Phone .......................................................................................................................................................... 6-27 6.3 Email ........................................................................................................................................................... 6-30

7 G l o s s a r y 1

Page 5: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 Table of Contents v

• • •

Page 6: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external
Page 7: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 Introduction 1-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.

1 Getting Started 1

Page 8: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 1-2 High-level design

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

Page 9: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 Key changes comparing to the previous version 1-3

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.18 User Guide introduced a couple of changes:

• Alingment of gaps between TravelItineraryReadRQ and GetReservationRQ API – a number

of fields are now supported via GetReservaionRQ:

o Credit Card Holder information

o Point of Sale information

o Air segment

o Vehicle segment

o Hotel segment

o General segment

• New version of Price quote service (GetPriceQuoteRQ 3.2.0):

o Account code and corporate ID

o Extended information on fare component level

Page 10: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external
Page 11: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 Introduction 2-1

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

2 GetReservation Request and Response Structure 2

Page 12: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 2-2 Overview of Request and Response Updates

– 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

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.18.0" xmlns="http://webservices.sabre.com/pnrbuilder/v1_18">

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.18 was introduced with the following main items included in the

response:

• Alignment of gaps between TravelItineraryReadRQ and GetReservationRQ API – a number

of fields are now supported via GetReservaionRQ

• New version of Price quote service (GetPriceQuoteRQ 3.2.0):

Page 13: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 Overview of Request and Response Updates 2-3

A l i g n m e n t o f g a p s b e t w e e n T I R a n d G e t R e s A P I

Missing fields are only implemented in getReservationRQ – this will give the ability to retrieve

reservation – related data, that were available in TravelItineraryReadRQ service, but not in GetRes.

New functionalities will only be available in newest version of getRes (1.18)

This project enables GetRes API to populate information within:

o Credit Card Holder information

▪ Short text,

▪ Name of Credit Card Holder,

▪ Address of Credit Card Holder

<stl18:FormsOfPayment>

<stl18:CreditCardPayment ShortText="CREDIT CARD DATA EXISTS *CC TO DISPLAY">

<stl18:CardHolderInfo Name="AMY HILL">

<stl18:AddressLines>

<stl18:AddressLine>

<stl18:Text>123 1ST AVE</stl18:Text>

</stl18:AddressLine>

<stl18:AddressLine>

<stl18:Text>NEW YORK, NY</stl18:Text>

</stl18:AddressLine>

<stl18:AddressLine>

<stl18:Text>12345</stl18:Text>

</stl18:AddressLine>

</stl18:AddressLines>

</stl18:CardHolderInfo>

</stl18:CreditCardPayment>

</stl18:FormsOfPayment>

o Point of Sale information

▪ Air Extrass - is used to indicate whether or not air extra-related information

pertains to the particular record,

▪ Inhibit Code - is utilized to return the viewership code associated with the

particular record

Page 14: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 2-4 Overview of Request and Response Updates

<stl18:Reservation numberInParty="1" numberOfInfants="0" NumberInSegment="1">

<stl18:BookingDetails>

<stl18:RecordLocator>QSSJVC</stl18:RecordLocator>

<stl18:CreationTimestamp>2018-02-23T09:50:00</stl18:CreationTimestamp>

<stl18:SystemCreationTimestamp>2018-02-

23T09:50:00</stl18:SystemCreationTimestamp>

(…)

</stl18:BookingDetails>

<stl18:POS AirExtras="true" InhibitCode="U">

<stl18:Source BookingSource="W0H3" AgentSine="VLZ" PseudoCityCode="W0H3"

ISOCountry="US" AgentDutyCode="*" AirlineVendorID="AA"

HomePseudoCityCode="HDQ"/>

</stl18:POS>

(…)

</stl18:Reservation>

o Air segment

▪ Operating Airline Pricing Code,

▪ Marketing Airline Banner,

▪ Day of week ind. - is used to return the day of the week indicator (numbers

1 – 7),

▪ ResBookDesigCode - is used to specify the booking class, it can take on 1-

letter values (e.g. Y),

▪ Smoking allowed - is used to indicate whether or not smoking is permitted

on the particular flight segment (true / false value),

▪ Special meal - is used to indicate whether or not a special meal is associated

with the particular flight segment (true / false value),

▪ Stop quantity - is used to return the number of stops associated with the

particular flight segment,

▪ Code share - is used to indicate if this is a codeshare flight (true / false

value),

▪ Hidden stop support,

▪ Meal codes – this field will be available starting from release 18.4 (it needs

implementation of additional fix to work properly)

Page 15: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 Overview of Request and Response Updates 2-5

<stl18:Segment sequence="1" id="5">

<stl18:Air id="5" sequence="1" segmentAssociationId="2" isPast="false" Code="LA"

DayOfWeekInd="7" CodeShare="false" SpecialMeal="true" SmokingAllowed="false"

ResBookDesigCode="Y" StopQuantity="01">

<stl18:DepartureAirport>MIA</stl18:DepartureAirport>

<stl18:DepartureAirportCodeContext>IATA</stl18:DepartureAirportCodeContext>

<stl18:ArrivalAirport>SCL</stl18:ArrivalAirport>

(…)

<stl18:HiddenStop Airport="PUJ" EquipmentType="789">

<stl18:ArrivalDateTime>2018-05-20T10:55</stl18:ArrivalDateTime>

<stl18:DepartureDateTime>2018-05-20T12:25</stl18:DepartureDateTime>

</stl18:HiddenStop>

<stl18:FunnelFlight>false</stl18:FunnelFlight>

<stl18:ChangeOfGauge>false</stl18:ChangeOfGauge>

<stl18:Banner>MARKETED BY LATAM AIRLINES GROUP</stl18:Banner>

</stl18:Air>

</stl18:Segment>

o Vehicle segment

▪ Day of week - is used to return the day of the week indicator (numbers 1 –

7),

▪ Rental rate - Information on the rates associated with this vehicle. Rate

information can include the distance and the base rental cost, along with

information on the various factors that may influence this rate

<stl18:Vehicle DayOfWeekInd="1" id="210" sequence="1" isPast="false">

<stl18:LineNumber>1</stl18:LineNumber>

<stl18:LineStatus>HK</stl18:LineStatus>

<stl18:POSRequestorID>45537284</stl18:POSRequestorID>

<stl18:ConfId>GSF4856888-</stl18:ConfId>

<stl18:VendorCode>SC</stl18:VendorCode>

<stl18:PickUpLocation>

<stl18:LocationCode>DEN</stl18:LocationCode>

<stl18:CodeContext>IATA</stl18:CodeContext>

</stl18:PickUpLocation>

<stl18:PickUpDateTime>2018-04-02T14:00:00</stl18:PickUpDateTime>

<stl18:ReturnDateTime>2018-04-05T18:00:00</stl18:ReturnDateTime>

<stl18:RentalRate>

Page 16: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 2-6 Overview of Request and Response Updates

<stl18:VehicleCharges>

<stl18:VehicleChargeAmount>@USD22.00*UNL DY XD22.00 UNL XH5.50

UNL</stl18:VehicleChargeAmount>

<stl18:ApproximateTotalChargeAmount>@USD123.55 UNL 3DY 4HR

35.55MC</stl18:ApproximateTotalChargeAmount>

</stl18:VehicleCharges>

<stl18:RateQualifierCode>FLYDRV</stl18:RateQualifierCode>

</stl18:RentalRate>

(…)

</Vehicle>

o Hotel segment

▪ Day of week - is used to return the day of the week indicator (numbers 1 –

7),

▪ Number in Party - Information on the rates associated with this vehicle.

Rate information can include the distance and the base rental cost, along

with information on the various factors that may influence this rate

<stl18:Segments>

<stl18:Segment sequence="1" id="3">

<stl18:Hotel id="3" sequence="1" isPast="false">

<or112:Reservation DayOfWeekInd="2" NumberInParty="01">

(…)

</or112:Reservation>

<or112:AdditionalInformation>

</or112:AdditionalInformation>

<or112:SegmentText>ANC/OUT5APR/KING

DRAKE/DBLB/MODR/TA45537284/CF-</or112:SegmentText>

</stl18:Hotel>

</stl18:Segment>

</stl18:Segments>

o General segment

▪ Day of week ind. - is used to return the day of the week indicator (numbers

1 – 7)

<stl18:General isPast="false" dayOfWeekInd="5">

<stl18:Line Number="1" Type="ATX" Status="GK"/>

<stl18:Vendor Code="LS"/>

<stl18:NumberInParty>1</stl18:NumberInParty>

<stl18:OriginLocation LocationCode="DFW"/>

<stl18:DestinationLocation LocationCode="ORD"/>

<stl18:DateTime>2018-04-13T00:00:00</stl18:DateTime>

<stl18:Text/>

Page 17: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 Service version and Response formats 2-7

</stl18:General>

N e w v e r s i o n o f P r i c e Q u o t e s e r v i c e

New version of Price quote service (GetPriceQuoteRQ 3.2.0) is called when the user chooses

PRICE_QUOTE Subject Area in the request. New version of the service is supporting now:

o Account code and corporate ID

o Extended information on fare component level

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

<GetReservationRQ Version="{SupportedVersion}" ... >

...

<ReturnOptions ResponseFormat="STL” … />

</GetReservationRQ>

You should specify 1.18.0 as {SupportedVersion}. The version attribute value should not contain any

additional prefixes nor suffixes. Only digits and dots should be provided as 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.

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-18).

• Subject Areas (see “Subject Areas,” page 2-19).

Page 18: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 2-8 Request and response structure

G e t R e s e r v a t i o n R Q r e q u e s t m e s s a g e ( R Q )

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> required block, some its attributes like Version are required too.

<Version> is required attribute (starting from version 1.7.8)

< Locator > required block for stateless and trip calls;

<RequestType> required block;

<CreateDate> optional block; PNR creation date 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.

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

<POC > 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> 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

D e t a i l e d d e s c r i p t i o n o f p a r a m e t e r s f o r G e t R e s e r v a t i o n R Q

The following descriptions contain basic information about particular elements, though primary

source of knowledge should be corresponding XSD files.

Page 19: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 Request and response structure 2-9

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

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.

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-18).

Number of data elements returned in each View can be further narrowed using the optional values

Page 20: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 2-10 Request and response structure

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-18).

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

Page 21: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 Request and response structure 2-11

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.

Page 22: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 2-12 Request and response structure

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

Page 23: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 Request and response structure 2-13

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. [email protected]

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.

Page 24: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 2-14 Request and response structure

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

Page 25: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 Request and response structure 2-15

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.

G e t R e s e r v a t i o n R S r e s p o n s e m e s s a g e ( R S )

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 simple request:

<GetReservationRQ Version="1.18.0" xmlns="http://webservices.sabre.com/pnrbuilder/v1_18">

<RequestType>Stateful</RequestType>

<ReturnOptions>

<ViewName>Full</ViewName>

<ResponseFormat>STL</ResponseFormat>

</ReturnOptions>

</GetReservationRQ>

Page 26: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 2-16 Request and response structure

Sample simple response:

<ns4:GetReservationRS Version="1.18.0" xmlns:ns4="http://webservices.sabre.com/pnrbuilder/v1_18"

xmlns:ns2="http://services.sabre.com/res/or/v1_11" xmlns:ns3="http://tds.sabre.com/itinerary"

xmlns:ns5="http://webservices.sabre.com/pnrconn/ReaccSearch">

<ns4:Reservation numberInParty="1" numberOfInfants="0" NumberInSegment="1">

<ns4:BookingDetails>

<ns4:RecordLocator>GADLPQ</ns4:RecordLocator>

<ns4:CreationTimestamp>2015-09-16T13:36:00</ns4:CreationTimestamp>

<ns4:SystemCreationTimestamp>2015-09-16T13:36:00</ns4:SystemCreationTimestamp>

<ns4:CreationAgentID>DTZ</ns4:CreationAgentID>

<ns4:UpdateTimestamp>2015-09-16T13:36:51</ns4:UpdateTimestamp>

<ns4:PNRSequence>2</ns4:PNRSequence>

<ns4:FlightsRange Start="2015-10-15T10:25:00" End="2015-10-16T07:30:00"/>

<ns4:DivideSplitDetails/>

<ns4:EstimatedPurgeTimestamp>2015-10-15T00:00:00</ns4:EstimatedPurgeTimestamp>

<ns4:UpdateToken>-57b7e7b52c59dae59ff958e2a4b48683fe2ce5a822cfa248</ns4:UpdateToken>

</ns4:BookingDetails>

<ns4:POS>

<ns4:Source BookingSource="A0A0" AgentSine="DTZ" PseudoCityCode="HDQ" ISOCountry="US"

AgentDutyCode="5" AirlineVendorID="AA" HomePseudoCityCode="HDQ"/>

</ns4:POS>

<ns4:PassengerReservation>

<ns4:Passengers>

<ns4:Passenger id="3" nameType="S" nameId="01.01" nameAssocId="1">

<ns4:LastName>SBAQ</ns4:LastName>

<ns4:FirstName>RMQ</ns4:FirstName>

<ns4:Seats/>

</ns4:Passenger>

</ns4:Passengers>

<ns4:Segments>

<ns4:Poc>

<ns4:Airport>AUH</ns4:Airport>

<ns4:Departure>2015-10-15T10:25:00</ns4:Departure>

</ns4:Poc>

<ns4:Segment sequence="1" id="4">

<ns4:Air id="4" sequence="1" segmentAssociationId="2" isPast="false">

<ns4:DepartureAirport>AUH</ns4:DepartureAirport>

<ns4:DepartureAirportCodeContext>IATA</ns4:DepartureAirportCodeContext>

<ns4:ArrivalAirport>SYD</ns4:ArrivalAirport>

<ns4:ArrivalAirportCodeContext>IATA</ns4:ArrivalAirportCodeContext>

<ns4:OperatingAirlineCode>EY</ns4:OperatingAirlineCode>

<ns4:OperatingAirlineShortName>ETIHAD AIRWAYS</ns4:OperatingAirlineShortName>

<ns4:EquipmentType>77W</ns4:EquipmentType>

<ns4:MarketingAirlineCode>EY</ns4:MarketingAirlineCode>

<ns4:MarketingFlightNumber>0450</ns4:MarketingFlightNumber>

<ns4:OperatingClassOfService>B</ns4:OperatingClassOfService>

<ns4:MarketingClassOfService>B</ns4:MarketingClassOfService>

<ns4:Seats/>

<ns4:AirlineRefId>RLEY*OCBVXG</ns4:AirlineRefId>

<ns4:Eticket>true</ns4:Eticket>

<ns4:DepartureDateTime>2015-10-15T10:25:00</ns4:DepartureDateTime>

<ns4:ArrivalDateTime>2015-10-16T07:30:00</ns4:ArrivalDateTime>

Page 27: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 Request and response structure 2-17

<ns4:FlightNumber>0450</ns4:FlightNumber>

<ns4:ClassOfService>B</ns4:ClassOfService>

<ns4:ActionCode>HK</ns4:ActionCode>

<ns4:NumberInParty>1</ns4:NumberInParty>

<ns4:SegmentSpecialRequests/>

<ns4:inboundConnection>false</ns4:inboundConnection>

<ns4:outboundConnection>false</ns4:outboundConnection>

<ns4:ScheduleChangeIndicator>false</ns4:ScheduleChangeIndicator>

<ns4:SegmentBookedDate>2015-09-16T13:36:00</ns4:SegmentBookedDate>

</ns4:Air>

</ns4:Segment>

</ns4:Segments>

<ns4:TicketingInfo>

<ns4:FutureTicketing id="6" index="1">

<ns4:Code>TAW</ns4:Code>

<ns4:Comment>*</ns4:Comment>

</ns4:FutureTicketing>

</ns4:TicketingInfo>

<ns4:ItineraryPricing/>

</ns4:PassengerReservation>

<ns4:ReceivedFrom>

<ns4:Name>QA TESTING</ns4:Name>

</ns4:ReceivedFrom>

<ns4:PhoneNumbers>

<ns4:PhoneNumber id="5" index="1">

<ns4:CityCode>HDQ</ns4:CityCode>

<ns4:Number>1800123456</ns4:Number>

</ns4:PhoneNumber>

</ns4:PhoneNumbers>

<ns4:EmailAddresses/>

</ns4:Reservation>

</ns4:GetReservationRS>

The GetReservationRQ 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

Page 28: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 2-18 Views

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.

Page 29: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 Subject Areas 2-19

View Description Allow Custom Subject Areas3

History

Simple Always used, regardless of whether it is provided in the request.

Includes: HEADER (Booking and Point of Sale details).

Yes No

Default It contains PNR data specified by all ACTIVE1 SUBJECT AREAS.

Includes: SIMPLE VIEW; all PRIMARY SUBJECT AREAS

No No

Full It contains PNR data specified by all PRIMARY2 and HISTORY SUBJECT AREAS.

Includes: SIMPLE VIEW; all PRIMARY SUBJECT AREAS

No Yes

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

2Primary 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

3Allow 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.

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.

ADDRESS Agency address data stored in the PNR.

AIR_CABIN Extended cabin class information about the product.

AFAX All facts stored in PNR.

ANCILLARY Ancillary Items (Air Extra) stored in the PNR.

BAS_EXTENSION Extending segments with additional information from PSS.

Page 30: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 2-20 Subject Areas

BSGPROCESSING Block Space Group data stored in the PNR.

CORPORATE_ID Agency ID for Corporate Client stored in the PNR.

CUST_INSIGHT_PROFILE Customer Profile data stored in the PNR.

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

DSS Additional information about the flight.

EXT_FQTV External Frequent Traveler Number

FARETYPE Fare data stored in the PNR.

FQTV Frequent Flyer details stored in PNR.

GFAX General facts stored in PNR.

HEADER PNR header data.

ITINERARY Full itinerary data stored in the PNR including Air, Rail, Car, Hotel, etc.

NAME Passenger Name stored in the PNR.

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

PHONE Phone data stored in the PNR.

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.

RECEIVED Received From Field stored in the PNR.

RECORD_LOCATOR PNR Record locator (rloc)

REMARKS All Remark Fields stored in the PNR.

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

Page 31: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 Service Security 2-21

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:

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

Page 32: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 3-22 Updated Design Documents

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.18.0.wsdl

Schema

GetReservationSTLRQ_v1.18.0.xsd

GetReservationSTLRS_v1.18.0.xsd

Ancillaries.1.12.0.xsd

Pricing.1.12.0

Common Schemas

envelope.xsd;

msg-header-2_0.xsd;

tmp0000.xsd

wsse.xsd;

xlink.xsd;

xml.xsd;

xmldsig-core-schema.xsd

Control Schemas PNRBuilderTypes_v1.18.0.xsd;

OpenReservation.1.12.0.xsd

Payload Design

Documents GetReservationRQ_1.18.0_Design.xml

GetReservationRS_1.18.0_Design.xml

Additional

Documentation GetReservationRQ_1.18.0_User Guide.pdf

Sample XML

Payloads GetReservationRQ_1.18.0_SamplePayload.xml;

GetReservationRS_1.18.0_SamplePayload.xml

3 Documentation Updates 3

Page 33: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 Introduction 4-23

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

4 Error Codes 4

Page 34: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 4-24 Fault Errors

Message OTA Code

Cannot pack response to response root element 700213

Error response from PNRC reaccomodation retrieve service 700214

TPFDF parsing exception 700215

No ATH 700216

Invalid ICE Session 700217

Broken ICE Session 700218

FIT parsing exception 700219

Invalid ICE credentials 700220

Access restricted to flight data 700221

Cannot search past flight data 700222

Access restricted to PNR data 700223

Flight not found 700224

Invalid search options 700225

PNR not found 700226

TVL version not supported 700227

PNR unknown error 700301

PNR communication error 700302

PNR communication timeout error 700303

Unable to read terminal 700404

Unable to Find AAA 700405

Agent not signed in 700406

PNR Locator error 700407

No PNR in AAA 700408

PNR Retrieval error 700409

PSS invalid request 700410

The PNR in the AAA has been modified 700411

Agent is active on a PNR queue 700412

Unable to process in PSS 700414

Parsing error 700415

Access restricted to flight data 700418

Access restricted to PNR data 700419

Page 35: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 Fault Errors 4-25

Message OTA Code

PSS Communication error 700420

PSS Communication timeout 700421

Access restricted to PNR data 700422

PNR Restricted 700423

PNR Not Found 700424

PNRC Timeout Error code 700425

PNR Database unavailable 700426

Link Down Error code 700427

Max message size exceeded 700428

System not in NORM state Error code 700429

Unable to Process error code 700430

Invalid subject area 700431

Reservation Orchestration Error 700432

Page 36: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 5-26 Introduction

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

If you have any questions or need assistance, contact our Sabre Dev Studio Global Customer Support Center via any of the methods provided in this chapter.

5.2 P h o n e

When reporting production or other critical/time sensitive issues, contact us via telephone as follows:

Location Phone Number

USA 800-678-9460

Canada 682-605-5570

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

5.3 E m a i l

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

[email protected]

Caution Please include the Sabre Pseudo City Code (PCC) where the issue is occurring.

When reporting an issue with web services, input and output payloads are required. Please attach the payloads as separate files, and name them clearly. Samples of these files are available at:

https://developer.sabre.com

To help ensure that our environment is free of viruses, our policy mandates that all messages received by Sabre from external sources follow special file name guidelines. When sending zipped files please make a note of the following required file naming convention: File names must end in ".sabre.zip" or the zipped attachment will be removed by the email server (for example, “docs.zip” would need to be renamed to “docs.sabre.zip”).

If your correspondence is regarding a previously reported issue, please include the service incident (“SI”) number in the subject line of your message.

5 Technical Support – Travel Agencies and 3rd party developers

5

Page 37: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 Introduction 6-27

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

If you have any questions or need assistance, contact our SabreSonic Helpdesk via any of the methods provided in this chapter.

6.2 P h o n e

When reporting production or other critical/time sensitive issues, contact us via telephone as follows:

Dial Option #1 for SabreSonic Select Web Services option

Country Toll free number

Antigua 888-832-4738

Argentina 0800-666-1664

Australia 1-800-081-993

Austria 800-291-705

Bahamas 1-800-389-0417

Bahrain 800-00-002 (WSC 5050)

Belarus 880-0114 PIN 375

Belgium 0800-77-029

Bolivia 800-10-0350

Brazil 0800-891-9210

Brunei 800-013 PIN 673

Canada 1-866-598-1706

Chile 800-412555

China 4001-202-315

Colombia 01-800-954-1326

Cyprus 800-96110

6 Technical Support – Sabre Hosted Airlines 6

Page 38: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 6-28 Phone

Czech Republic 800-700-117

Denmark 808-85884

Egypt - Cairo 7955-770 PIN 5670

El Salvador 800-0000-0011

Estonia 800-12-122 PIN 5047

Finland 0800-914-860

France 0800-909-657

Germany 0800-181-7245

Greece 00800-16-122-055-533

Hong Kong 800-908-742

Iceland 800-8667

India 000-800-100-6116

Indonesia 001-803-016-1722

Ireland 1-800-657-198

Israel 1-809-246-033

Italy 800-787-417

Jamaica 1-866-402-6835

Japan 0053-116-0811

Korea 0030-813-1943

Malaysia 1-800-813-609

Malta 800-90112 PIN 356

Mexico 01-800-123-8537

Netherlands 0800-023-2237

New Zealand 0800-450-960

Norway 800-18-798

Panama 00800-226-0662

Paraguay 009-800-598-1-0004

Peru 0800-52-226

Philippines 1-800-111-00338 or 1-800-111-00339

Poland 800-900-807

Page 39: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 Phone 6-29

Russia 810-800-240-31012

Saudi Arabia 1-800-11 PIN 5671

Singapore 800-101-1651

South Africa 0800-980-981

Spain 900-995-926

Sweden 0200-285-836

Switzerland 0800-894-354

Tahiti 888-832-4738

Thailand 1. Dial 001-999-111-11 (AT&T)

2. Wait for the recording asking for the number you are dialing.

3. Dial 888-832-4738.

Trinidad and Tobago 888-870-9002

UAE 800-035-702-569

UK 0800-0288446

Uruguay 2518-6642

USA 1-888-421-8889

Venezuela 0800-100-3851

Vietnam 1. Dial 1-201-0288 (AT&T Toll Free Number).

2. Wait for the recording asking for the number you are dialing.

3. Dial 866-947-8059.

Page 40: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 6-30 Email

6.3 E m a i l

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

[email protected]

Caution Please include the Sabre Pseudo City Code (PCC) where the issue is occurring.

When reporting an issue with web services, input and output payloads are required. Please attach the payloads as separate files, and name them clearly. Samples of these files are available at:

https://developer.sabre.com

To help ensure that our environment is free of viruses, our policy mandates that all messages received by Sabre from external sources follow special file name guidelines. When sending zipped files please make a note of the following required file naming convention: File names must end in ".sabre.zip" or the zipped attachment will be removed by the email server (for example, “docs.zip” would need to be renamed to “docs.sabre.zip”).

If your correspondence is regarding a previously reported issue, please include the service incident (“SI”) number in the subject line of your message.

Page 41: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 Glossary 1

Following is a glossary of terms (listed in alphabetical order by term):

Term Description

AAA Agent Assembly Area - refers to the buffer in the Sabre system where content is retained

while a Sabre Host session is active

AS Sabre Airline Solutions

FOID Form Of Identification - is used to advise carrier what identification the passenger will present upon check-in for e-ticket travel

GDS Code for the Global Distribution System. For example:

1S – Sabre

1B – Abacus

1J – Axess

1F – Infini

Locator PNR locator

OAC Office Accounting Code

OSI Other Supplementary Information - can be used when action or reply from carrier is not required

PCC Pseudo City Code - uniquely identifies travel agency in the same way that a city code identifies a city

PNR Passenger Name Record

POS Point of Sale

PSS Passenger Service System also known as Sabre Host

SAN Sabre Advance Notification

Segment Itinerary field of a Passenger Name Record holding actual booking (Air, Car, Rail, Hotel etc.)

SSR Special Service Request is used when action or response from carrier is required

STL Sabre XML format

TN Sabre Travel Network

7 Glossary

Page 42: GetReservationRQ v1.18.0 User Guide - Sabre Dev …files.developer.sabre.com/doc/providerdoc/pnrservices/...User Guide February 2017 1-2 High-level design Both internal and external

User Guide February 2017 2 Glossary

• • •