UpdateReservationRQ v1.19.0 User Guide -...

User Guide UpdateReservationRQ

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.

User Guide January 2019 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 Customer Identification ...........................................................................................................................................1-1

2 U p d a t e R e s e r v a t i o n R e q u e s t 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-3

2.3.1 Ability to mark PNRs as suspicious ..............................................................................................................2-3 2.3.2 New capabilit ies for hotel content (CRUD) ..................................................................................................2-3 2.3.3 Ability to choose PQ (PriceQuoteServicesRQ) service version .................................................................2-4 2.3.4 Additional f ields in UpdateResercationRS ...................................................................................................2-4 2.3.5 New flexible w ay of using View s and Subject Areas ...................................................................................2-4

2.4 UpdateReservation Request Structure ...................................................................................................................2-10 2.4.1 View Names and Subject Areas .................................................................................................................2-11

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

3.1 Updated De sign Documents ...................................................................................................................................3-19

4 E r r o r C o d e s 4 - 20

4.1 Introduction ..........................................................................................................................................................4-20 4.2 Fault Errors ............................................................................................................................................................4-20 4.3 Sample Error Response ..........................................................................................................................................4-22

4.3.1 Invalid “Locator” in RQ message ................................................................................................................4-22 4.3.2 Invalid “View Name” in RQ message ..........................................................................................................4-23 4.3.3 Invalid “RequestType” in RQ message ......................................................................................................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 - 24

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

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

6.1 Introduction ..........................................................................................................................................................6-25 6.2 Phone ....................................................................................................................................................................6-25

User Guide January 2019 iv Table of Contents

6.3 Email .....................................................................................................................................................................6-27

7 G l o s s a r y 1

User Guide January 2019 Table of Contents v

• • •

User Guide January 2019 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

UpdateReservationRQ Web Service. This release covers the XML request and responses which allow

client applications to update PNR data including Itinerary, Passenger information, etc. (details below).

UpdateReservationRS 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 for 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, “UpdateReservation Request Structure” contains descriptions of the attributes and

elements in the response schema.

• Chapter 3, “Documentation Updates” contains the necessary filenames to run

UpdateReservationRQ.

• 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 C u s t o m e r I d e n t i f i c a t i o n

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.

• Third-party customers.

1 Getting Started 1

User Guide January 2019 Customer Identification 1-1

• • •



The Update Itinerary (UpdateReservationRQ) API is used to create, update and delete PNR data including Ancillaries, Profiles, SSRs, OSIs, Remarks and Pre Reserved Seats.

This chapter includes the following:

• Processing Information (see this page).

• Request Updates (see “Overview of Request and Response Updates,” page 2-3).

• Request Structure (see “UpdateReservation Request Structure,” page Error! Bookmark not

defined.).

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 in the Sabre Host, this Web Service offers capabilities allowing Airline or Agency agents to update Logical Records (Lrec) in a particular PNR using Name and Segment Associations. Request payload can be further specified by using “ReturnOptions” which determine response message content.

The UpdateReservationRQ service supports two categories of requests:

• Update – operates on the entire PNR Lrec e.g. Air Extra (AE), SSR

• Partial Update – operates on the Lrec part e.g AE’s action code, SSR’s action code. Partial

update enables change without necessity of deleting entire Lrec and creating it once again.

UpdateReservationRQ Web Service allows client applications to retrieve PNR in STL data format. The PNR will be updated using one of the available request types: Stateless:

• PNR will be retrieved from PNR Reservation Database and unpacked into AAA session;

• After being updated PNR will be committed;

• It is required to provide “Locator” element;

• It is required to provide “ReceivedFrom” element

• Includes UpdateToken from GetReservationRS

Stateful:

2 UpdateReservation Request Structure 2

2-2 Processing Inf ormation User Guide January 2019

• This request type assumes that PNR is already in AAA;

• After being updated PNR will not be committed;

• It can be used to perform serial operations

General rules for using UpdateReservationRQ:

• When using RequestType = Stateless you must include an UpdateToken in your RQ.

UpdateToken contains information about PNR version that you had before sending update.

If PSS has newer version of PNR it will return error.

<UpdateReservationRQ Version="1.19"

xmlns:ns5="http://webservices.sabre.com/pnrbuilder/v1_19"> <ns5:RequestType>Stateless< /ns5:RequestType> < /ns5:UpdateToken>4660bda5b6a998426eea20f9c49e12ca38c50e78672e9002<

/ns5:UpdateToken> < ns5:ReservationUpdateList>

• “ReturnOptions” element can be used to specify which data elements will be present in

response payload, as well as how those will be formatted.

• When using pnrbuilder files on versions higher than v1.7.8 you will need to be specify the

version number in the namespace

• “isPast” this attribute has been added to mark air segments where start date is older than

48 hours as past. For the non-air segments (e.g. Car, Rail, Hotel) the flag will be calculated

based on end date. If end date is not available and there is no possibility to calculate it

based on duration time, these will be processed as air segments.

The UpdateReservationRQ service allows users to perform the following operation types on Lrecs:

• insert – is used to add new Lrec;

• update – is used to update existing Lrec by deleting and creating it once again;

• delete – is used to delete existing Lrec;

The following Lrec types can be modified by UpdateReservationRQ:

Create Update Delete

Ancillary Update available not available available

Ancillary Partial Update not available available not available

SSR Update available not available available

SSR Partial Update not available available not available

Profile Update available available available

Pre Reserved Seat Partial

Update not available available not available

Remark Update available not available available If custom made updates are required please request them using

[email protected].

mailto:[email protected]

User Guide January 2019 Ov erview of Request and Response Updates 2-3

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:

• Ability to mark PNRs as suspicious

• New capabilities for hotel content (CRUD)

• Ability to choose PQ (PriceQuoteServicesRQ) service version

• Additional fields in UpdateResercationRS

• New flexible way of using Views and Subject Areas

2.3.1 A b i l i t y t o m ar k P NR s as s us p i c i ou s

Enables authorized users to mark PNRs as suspicious.

This functionality enables to:

• Mark PNR's as suspicious (UpdateRes) - authorized users only (Ice_attribute) • Read (GetRes) and update (UpdateRes) that information stored in PNR:

o Score o Description o Reporter type

• Add multiply records to one PNR - different type of users can add score and description

2.3.2 New capab i l i t i es fo r hot e l cont ent (C R UD )

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.

Sabre integrates multiple sources of content including GDS (referenced as GDS properties) and non-

GDS sources such as aggregators (referenced later as aggregator properties).

In other words, a hotel booking can be done regardless of content source:

• Traditional hoteliers through the GDS path (Hilton, Marriott etc)

• Suppliers through a direct connect, mostly hotel aggregators (Expedia, Bedsonline, Booking.com, etc)

The details about Lodging functionality are available in document: PNRServices For Lodging User Guide.

2-4 Overv iew of Request and Response Updates User Guide January 2019

2.3.3 A b i l i t y t o choos e P Q ( P r i ceQu ot eS e r v i c es R Q ) s er v i ce

v er s i on

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.

2.3.4 A dd i t i ona l f i e l d s i n Updat eR e s e r c at i o nR S

Additional fields are now added to UpdateReservationRQ as a result of aligning gaps between

TravelItineraryRead API GetReservation API.

This project enables UpdateReservationRS and GetReservationRS APIs to populate information:

• Meal codes within Air segment

This information is included in response only when DSS subject area is specified in RQ. This

SubjectArea is already a predefined in Default view and in ACTIVE Subject area (which is a set of

subject areas)

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

associated with the reservation

2.3.5 New f l ex i b l e way o f us i ng V i ews and S ub j ect A r eas

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, 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, STL_ADD_ARUNKS_OPENSEGMENTS, HISTORICAL

ACTIVE, STL_ADD_ARUNKS_OPENSEGMENTS, HISTORICAL

Asv2DefaultWithSsr HEADER, NAME, ITINERARY, FQTV, ATR, OPEN, AFAX, GFAX, ADD_PARTNERSHIP_AIRLINES, ADD_POC, STL_ADD_ARUNKS_OPENSEGMENTS

HEADER, NAME, ITINERARY, FQTV, ATR, OPEN, AFAX, GFAX, ADD_PARTNERSHIP_AIRLINES, ADD_POC, STL_ADD_ARUNKS_OPENSEGMENTS

DefaultOpenResHistoryLimited

HEADER, NAME, ITINERARY, RECEIVED, PASSENGERDETAILS, AFAX, GFAX, REMARKS, FQTV, TICKETING, SUBSCRIPTION_CARD, LREC_11, ANCILLARY, OPENRESDATA, OPENRESHISTORY, PHONE, ACCOUNTING_LINE, ADD_PARTNERSHIP_AIRLINES, ADD_POC

HEADER, NAME, ITINERARY, RECEIVED, PASSENGERDETAILS, AFAX, GFAX, REMARKS, FQTV, TICKETING, SUBSCRIPTION_CARD, LREC_11, ANCILLARY, OPENRESDATA, OPENRESHISTORY, PHONE, ACCOUNTING_LINE, ADD_PARTNERSHIP_AIRLINES, ADD_POC

DefaultOpenResWithHistory

HEADER, NAME, ITINERARY, RECEIVED, PASSENGERDETAILS, AFAX, GFAX, REMARKS, FQTV, TICKETING, SUBSCRIPTION_CARD, LREC_11, ANCILLARY, OPENRESDATA,

HEADER, NAME, ITINERARY, RECEIVED, PASSENGERDETAILS, AFAX, GFAX, REMARKS, FQTV, TICKETING, SUBSCRIPTION_CARD, LREC_11, ANCILLARY, OPENRESDATA,


OPENRESHISTORY, PHONE, ACCOUNTING_LINE, ADD_PARTNERSHIP_AIRLINES, ADD_POC, HISTORICAL

OPENRESHISTORY, PHONE, ACCOUNTING_LINE, ADD_PARTNERSHIP_AIRLINES, ADD_POC, HISTORICAL

DefaultWithPq FQTV, ADDRESS, DKNUMBER, 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, PRICING_INFORMATION, STL_ADD_ARUNKS_OPENSEGMENTS

ACTIVE, PRICING_INFORMATION, STL_ADD_ARUNKS_OPENSEGMENTS

EmsDefault FQTV, ADDRESS, DKNUMBER, 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,

ACTIVE, USE_RAW_CONTENT


PHONE, ANCILLARY, ORE_COUNT, EQD_DATA, DSS, OPENRESDATA, USE_RAW_CONTENT

FulfillmentDefault FQTV, ADDRESS, DKNUMBER, 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, PRICING_INFORMATION

ACTIVE, ITINERARY, PRICING_INFORMATION

InteractAll HEADER, ITINERARY, STL_ADD_ARUNKS_OPENSEGMENTS

HEADER, ITINERARY, STL_ADD_ARUNKS_OPENSEGMENTS

InteractDefault HEADER, ITINERARY HEADER, ITINERARY

OpenResHistoryOnly HEADER, NAME, OPENRESDATA, OPENRESHISTORY, HISTORICAL, ADD_PARTNERSHIP_AIRLINES

HEADER, NAME, OPENRESDATA, OPENRESHISTORY, HISTORICAL, ADD_PARTNERSHIP_AIRLINES

PssDisplay FQTV, ADDRESS, DKNUMBER, VCR, PASSENGERDETAILS, PRERESERVEDSEAT, AFAX, GFAX, REMARKS, MISC_TICKETING, BSGPROCESSING, TARGETMARKETING, FARETYPE, TICKETINGENTRIES, BAS_EXTENSION, CORPORATE_ID, ACCOUNTING_LINE, SUBSCRIPTION_CARD, GROUP_PLANNER,

ACTIVE, HISTORICAL, OPENRESDATA, OPENRESHISTORY, STL_ADD_ARUNKS_OPENSEGMENTS, ADD_POC


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_OPENSEGMENTS, ADD_POC

PssDisplayWithoutHistory FQTV, ADDRESS, DKNUMBER, 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, HISTORICAL, STL_ADD_ARUNKS_OPENSEGMENTS

ACTIVE, HISTORICAL, OPENRESDATA, STL_ADD_ARUNKS_OPENSEGMENTS

SimpleWithCvs HEADER HEADER

SswDefault FQTV, ADDRESS, DKNUMBER, VCR, PASSENGERDETAILS, PRERESERVEDSEAT, AFAX, GFAX, REMARKS, MISC_TICKETING, BSGPROCESSING, TARGETMARKETING, FARETYPE, TICKETINGENTRIES, BAS_EXTENSION, CORPORATE_ID,

ACTIVE, USE_RAW_CONTENT, ADD_TKT_NAME_SEG_ASSOC


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

ACTIVE

VaDefaultWithPq FQTV, ADDRESS, DKNUMBER, VCR, PASSENGERDETAILS, PRERESERVEDSEAT, AFAX, GFAX, REMARKS, MISC_TICKETING, BSGPROCESSING, TARGETMARKETING, FARETYPE, TICKETINGENTRIES, BAS_EXTENSION, CORPORATE_ID, ACCOUNTING_LINE, SUBSCRIPTION_CARD,

ACTIVE, PRICING_INFORMATION, STL_ADD_ARUNKS_OPENSEGMENTS. DSS

2-10 UpdateReservation Request Structure User Guide January 2019

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_OPENSEGMENTS. DSS

2.4 U p d a t e R e s e r v a t i o n R e q u e s t S t r u c t u r e

The PNR data present in the response payload depends on the parameters used in the request. The

parameters can be used to reduce the number of elements returned.

Following there is a list of request parameters (RQ) which can be combined to create a request

message. Mandatory elements are marked in red.

This section contains the following:

• View Names and Subject Areas (see “View Names and Subject Areas,” page 2-11).

• Parameters (see “Parameters for UpdateReservationRQ”, page 2-14).

This section contains the following:

• RequestType (see “RequestType,” page 2-14).

• ReturnOptions (see “ReturnOptions,” page 2-14).

• ReservationUpdateList (see “ReservationUpdateList”, page 2-16).

• AsscociationUpdate (see “AsscociationUpdate”, page 2-16).

• UpdateToken (see “UpdateToken”, page 2-16).

• PnrContnt (see “PnrContnt”, page 2-17).

• Partition (see “Partition”, page 2-17).

• ResultAction (see “ResultAction”, page 2-17).

• ClientContext (see “ClientContext,” page 2-17).

User Guide January 2019 UpdateReservation Request Structure 2-11

2.4.1 V i ew Nam es and S ub j ect A r eas

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.

2.4.1.1 V i ews

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.

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

Yes No

Full

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

Includes: SIMPLE VIEW; all PRIMARY SUBJECT AREAS, DSS4, AIR_CABIN4, OPENRESDATA

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

4This functionality will be available starting from September release.

2.4.1.2 S ub j ect A r eas

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.

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_COMP ACT 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.

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

https://developer.sabre.com/docs/soap_apis/air/fulfill/manage_price_quote_details/resources


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.4.1.3 P ar am et e r s fo r Updat eR es er 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.

UpdateReservationRQ/RequestType

Element Attribute Description HOME

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.

commitTransaction commitTransaction allows control if ET

should be called at the end of STATEFUL

call. This option is ignored in STATELESS

mode. Set to False by default.

initialIgnore "initialIgnore" Allows to control if IG

should be called at the beginning of STATEFUL call. This option is ignored in

STATELESS mode. By default it is set to

false

UpdateReservationRQ/ReturnOptions

Element Element Attribute Description HOME

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; in the response the credit card

information will be presented in

unmasked format, else the credit card


information will always be in masked

format.

ShowTicketStatus "ShowTicketStatus" is for specifying

whether user wants status for each ticket

or not

Language "Language" is used to translate attributes

(like Cabin name)

PriceQuoteServiceVersion “PriceQuoteServiceVersion" is used to

specify version of webservice used to

obtain PQ content. Set to by default to

3.2.0

RetrievePNR Number of data elements returned in

each response can be further narrowed

using the optional values of RetrievePNR

RetrievePNR=”true” to show details of

PNR.

IncludeUpdateDetails Number of data elements returned in

each response can be further narrowed

using the optional values of

IncludeUpdateDetails.

IncludeUpdateDetails=”true” to show

details

of PNR.

ReturnLocator Determines if the response should contain

locator information if available during

update operation. This setting is

independent of RetrievePNR setting. true

or false

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

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

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


UpdateReservationRQ/ReservationUpdateList


ReservationUpdateList Choice of one of

"ReservationUpdateItem",

"ChangeNbrInParty", or "GMRUpdate"

CreateDate PNR creation date that is used as part of

PNR identifier (both active and inactive

PNRs)

Locator Identifies 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.

ReservationUpdateItem Element to make updates to a

reservation

GMRUpdate Group Management Record to be used

with the Group Mgmt tool.

ChangeNbrInParty Used when the user wants to increase or

reduce the number of passengers in a

PNR.

LinearEntryRequest Linear entry requests such as "CKS*"

coming from Terminal Gateway,

restricted for Internal Use at this time

ReceivedFrom Used to identify the person creating the

PNR.

UpdateReservationRQ/AssociationUpdate


AssociationUpdate

op CREATE, UPDATE, DELETE, KEEP

Parent Parent Key value of the parent item

being associated to

Child Key value of the child item being

associated

UpdateReservationRQ/UpdateToken


Element Element Description HOME

UpdateToken UpdateToken element in request will assure update

attempt on the most recent copy of the PNR. If token used

in RQ message doesn’t match token in the latest PNR’s instance then respective error message will be thrown

“PNR PREVIOUSLY UPDATED ? LATEST CHANGES NOT

APPLIED”.

UpdateToken element will trigger Ignore transaction before unpacking PNR into AAA and as well as after End

Transaction.

UpdateReservationRQ/PnrContent


PnrContent RawContent RawContent is a string used to identify the PNR.

UpdateReservationRQ/Partition


Partition Partition is a string used to identify the partition, e.g. AA,

B6.

UpdateReservationRQ/ResultAction


ResultAction Allow the user to add Queue Placement of where the PNR

should be placed.

UpdateReservationRQ/ClientContext


ClientContext Will need 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 UpdateReservation request - master

PNR is retrieved in response.

Name Allows users to provide information about the caller to the

service.



This parameter is currently only available with

customization.

User Guide January 2019 Updated Design Documents 3-19

Sabre Web Services are currently available on the Sabre Dev Studio site

https://developer.sabre.com.

UpdateReservationRQ will be stored in the Trip Management folder as Update 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 UpdateReservation_1.19.0.wsdl

Schema UpdateReservationSTLRQ_v1.19.0.xsd

UpdateReservationSTLRS_v1.19.0.xsd

Common Schemas

envelope.xsd;

msg-header-2_0.xsd;

wsse.xsd;

xlink.xsd;

xml.xsd;

xmldsig-core-schema.xsd;

Control Schemas

PNRBuilderTypes_v1.19.0.xsd;

OpenReservation.1.14.0.xsd

Ancillaries.1.14.0.xsd

Pricing.1.14.0

Air.1.14.0.xsd

Lodging.1.14.0

Payload Design

Documents

Additional

Documentation UpdateReservationRQ_1.19.0_User Guide.pdf

Sample XML

Payloads UpdateReservationRQRS_1.19.0_SamplePayload.xml;

3 Documentation Updates 3

https://developer.sabre.com/docs/read/soap_basics/development_patterns

4-20 Introduction User Guide January 2019


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

This chapter contains the following:

• Fault Errors (see this page.)

• Sample Error Response (see “Sample Error Response”, page 4-4).

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

4 Error Codes 4

User Guide January 2019 Fault Errors 4-21

Message OTA Code

Error response from PNRC reaccomodation search service 700209

Unknown response format 700210

OTA parsing error 700211

Cannot unpack request from request root element 700212

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 fl ight data 700221

Cannot search past fl ight 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

4-22 Sample Error Response User Guide January 2019

Message OTA Code

Unable to process in PSS 700414

Parsing error 700415

Access restricted to fl ight data 700418


PSS Communication error 700420

PSS Communication timeout 700421


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

Examples:

• Reservation Orchestration Error Caused by: [Unable to cancel segment : Host return not valid response: UNABLE TO CANCEL - AIRLINE DENIES CANCELLATION]

700432

4.3 S a m p l e E r r o r R e s p o n s e

4.3.1 Inv a l i d “ Locat or ” i n R Q m es s age

<ns3:GetReservationRS xmlns:ns3="http://webservices.sabre.com/pnrbuilder" xmlns:ns2="http://services.sabre.com/STL/v01" xmlns="http://webservices.sabre.com/triprecord"

xmlns:ns4="http://webservices.sabre.com/sabreXML/2003/07" xmlns:ns5="http://tds.sabre.com/rules"

xmlns:ns6="http://tds.sabre.com/itinerary">

<ns3:Errors> <ns3:Error>

<ns3:Code>700226</ns3:Code>

<ns3:Message>PNR not found, caused by [PNR not found, code: 100123, severity: MODERATE]</ns3:Message>

<ns3:Severity>MODERATE</ns3:Severity>

User Guide January 2019 Sample Error Response 4-23

</ns3:Error> </ns3:Errors>

</ns3:GetReservationRS>

4.3.2 Inv a l i d “ V i ewNam e” i n R Q m es s age

<ns3:GetReservationRS xmlns:ns3="http://webservices.sabre.com/pnrbuilder"

xmlns:ns2="http://services.sabre.com/STL/v01" xmlns="http://webservices.sabre.com/triprecord"

xmlns:ns4="http://webservices.sabre.com/sabreXML/2003/07" xmlns:ns5="http://tds.sabre.com/rules" xmlns:ns6="http://tds.sabre.com/itinerary">

<ns3:Errors>

<ns3:Error>

<ns3:Code>700005</ns3:Code> <ns3:Message>Invalid request view</ns3:Message>


</ns3:Error>

</ns3:Errors> </ns3:GetReservationRS>

4.3.3 Inv a l i d “ R eques t T y p e” i n R Q m es s age

<ns3:GetReservationRS xmlns:ns3="http://webservices.sabre.com/pnrbuilder"

xmlns:ns2="http://services.sabre.com/STL/v01" xmlns="http://webservices.sabre.com/triprecord"

xmlns:ns4="http://webservices.sabre.com/sabreXML/2003/07" xmlns:ns5="http://tds.sabre.com/rules"

xmlns:ns6="http://tds.sabre.com/itinerary"> <ns3:Errors>

<ns3:Error>

<ns3:Code>700003</ns3:Code> <ns3:Message>Invalid request</ns3:Message>


</ns3:Error>

</ns3:Errors> </ns3:GetReservationRS>

5-24 Introduction User Guide January 2019


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


https://developer.sabre.com/



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

Czech Republic 800-700-117

6 Technical Support – Sabre Hosted Airlines 6

6-26 Phone User Guide January 2019

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

Russia 810-800-240-31012

User Guide January 2019 Email 6-27

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.

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


https://developer.sabre.com/

6-28 Email User Guide January 2019

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

User Guide January 2019 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

2 Glossary User Guide January 2019

• • •

UpdateReservationRQ v1.19.0 User Guide -...

Documents

Transcript of UpdateReservationRQ v1.19.0 User Guide -...