ug wbs ticket displaytst 15.1

8/18/2019 UG WBS Ticket DisplayTST 15.1

1/69

Amadeus SAS

485, Route du Pin Montard

BP 69

06902 Sophia-Antipolis Cedex

Web Services User's Guide

Ticket_DisplayTST 15.1


2/69


3/69

Table of Contents

i

Table of ContentsPreface.................................................................................................................................. 4

1 Purpose of this document..............................................................................................4

2 Intended Audience......................................................................................................... 4

3 Associated Documents.................................................................................................. 4

4 Structure of this document............................................................................................ 4

Function: Ticket_DisplayTST.................................................. .............................................. 6

1 Overview........................................................................................................................ 61.1 Supported Operations............................................................................................. 6

1.2 Limitations................................................................................................................6

1.3 Unsupported Operations......................................................................................... 6

1.4 Prerequisites............................................................................................................6

2 Building A Query............................................................................................................8

3 Receiving A Reply....................................................................................................... 10

4 Error Messages............................................................................................................11

4.1 Error Reply............................................................................................................ 12

5 Operations....................................................................................................................13

5.1 Operation: Baggage Allowance Update................................................................ 13

5.1.1 Query Structure........................................................................................................................... 13

5.1.2 Reply Structure............................................................................................................................ 13

5.1.3 Possible Errors............................................................................................................................ 17

5.2 Operation: Display all TST(s)................................................................................18

5.2.1 Query Structure........................................................................................................................... 18

5.2.2 Reply Structure............................................................................................................................ 18

5.2.3 Possible Errors............................................................................................................................ 18

5.3 Operation: Display by Passenger selection.......................................................... 19

5.3.1 Quer y Structure........................................................................................................................... 19

5.3.2 Reply Structure............................................................................................................................ 19

5.3.3 Possible Errors............................................................................................................................ 19

5.4 Operation: Display by segment selection..............................................................20


4/69

Table of Contents

ii

5.4.1 Query Structure........................................................................................................................... 20

5.4.2 Reply Structure............................................................................................................................ 20

5.4.3 Possible Errors............................................................................................................................ 20

5.5 Operation: Display by TST selection.....................................................................21

5.5.1 Query Structure........................................................................................................................... 21

5.5.2 Reply Structure............................................................................................................................ 21

5.5.3 Possible Errors............................................................................................................................ 21

5.6 Operation: Display TST Related to Adult only (without infant): example 1............22

5.6.1 Query Structure........................................................................................................................... 22

5.6.2 Reply Structure............................................................................................................................ 22

5.6.3 Possible Errors............................................................................................................................ 22


5.7.1 Query Structure........................................................................................................................... 23

5.7.2 Reply Structure............................................................................................................................ 23

5.7.3 Possible Errors............................................................................................................................ 23


5.8.1 Query Structure........................................................................................................................... 24

5.8.2 Reply Structure............................................................................................................................ 24

5.8.3 Possible Errors............................................................................................................................ 24

5.9 Operation: Display TST related to either adult only or infant only.........................25

5.9.1 Query Structure........................................................................................................................... 25

5.9.2 Reply Structure............................................................................................................................ 25

5.9.3 Possible Errors............................................................................................................................ 25

5.10 Oper ation: Display TST with non-ticketable fare.................................................26

5.10.1 Quer y Structure......................................................................................................................... 26

5.10.2 Reply Structure.......................................................................................................................... 26

5.10.3 Possible Errors.......................................................................................................................... 34

5.11 Oper ation: Display with 2 segments for one Fare Component........................... 35

5.11.1 Quer y Structure......................................................................................................................... 35

5.11.2 Reply Structure.......................................................................................................................... 35

5.11.3 Possible Errors.......................................................................................................................... 41

5.12 Oper ation: Display with Fare Component........................................................... 42


5/69

Table of Contents

iii

5.12.1 Query Structure......................................................................................................................... 42

5.12.2 Reply Structure.......................................................................................................................... 42

5.12.3 Possible Errors.......................................................................................................................... 49

5.13 Operation: Display with Fare Family name.........................................................50

5.13.1 Query Structure......................................................................................................................... 50

5.13.2 Reply Structure.......................................................................................................................... 50

5.13.3 Possible Errors.......................................................................................................................... 58

5.14 Operation: Display with Service Component.......................................................59

5.14.1 Query Structure......................................................................................................................... 59

5.14.2 Reply Structure.......................................................................................................................... 59

5.14.3 Possible Errors.......................................................................................................................... 66

5.15 Operation: Scrolling.............................................................................................67

5.15.1 Query Structure......................................................................................................................... 67

5.15.2 Reply Structure.......................................................................................................................... 67

5.15.3 Possible Errors.......................................................................................................................... 67


6/69

Web services User guide for function Ticket_DisplayTST

Copyright © 1987-2015 Amadeus IT Group SA.

Page 4 of 67

Preface

1 Purpose of this document

The purpose of this document is to provide basic functional overview descriptions and relevant examples for

a better understanding of the functions.

2 Intended Audience

This document is aimed at those who implement this function.

3 Associated Documents

This document has to be combined to its corresponding Technical Reference Guide and possibly to Product

specifications.

4 Structure of this document

This document is composed of the following parts:

• the functional description: overview, supported operations, limitations, unsupported operations,

prerequisites and possibly reference to product specifications

• the detailed description to build the query and to retrieve data from the reply

• a set of relevant examples


7/69



Page 5 of 67

Ticket_DisplayTST A Transitional Stored Ticket (TST) is a pricing record for a given passenger(s)/itinerary association.

Ticket_DisplayTST is used to display the information on an existing TST.


8/69



Page 6 of 67

Function: Ticket_DisplayTST.

1 Overview

A Transitional Stored Ticket (TST) represents the financial part of an itinerary. You can find in the TST

information such as fares, taxes, selling conditions, last date to ticket, creation date, and so on. The TST can

be created automatically via a pricing entry or manually by the user.

A Passenger Name Record (PNR) can contain up to 999 TSTs, and a passenger can be linked to up to 10

TSTs. The message Ticket_DisplayTST allows you to display one or multiple TSTs.

1.1 Supported Operations

The service offers a large panel of selection options to target the appropriate TST(s) to be displayed:• Display every TST: Display up to 20 TSTs appended to a PNR. When there are more than 20 TSTs

appended to the PNR, the message returns the first 20 TSTs in the order they were created, as well as a

warning that there are more TSTs.

• Display by TST number: Select the tattoos of the TSTs to be displayed; a tattoo is an unique reference

ID assigned to the TST by the system.

• Display by passenger selection: Select one or more passengers for whom you want to display the

related TSTs.

• Display by segment selection: Display all the TSTs related to the selected segments.

• Select passengers without infants: Display all TSTs without the infants’ ones.

• Select infants only: Display TSTs for infant passenger(s).

• Scrolling: when the display of more than 20 TSTs is requested, only the first 20 are displayed by

increasing order of tattoo number. Be aware that when all the TSTs were not returned, both the number of remaining TSTs and the last returned TST's tattoo will be given in the response.

1.2 Limitations

• The service returns only TST stored content. i.e. it does not return any of the linked elements that belong

to the PNR such the passengers’ names, the route and the Fare Elements. For instance, commission, form

of payment, tour code, endorsement and original issue/in exchange.

• Up to 20 TSTS can be returned in the Ticket_DisplayTSTReply. When more than 20 TSTs meet the

selection criteria, the scrolling functionality must be used.

• Depending on functionality implemented for the customer who uses this verb, and depending on the

carrier, some information shown in this verb might be empty.

• This service does not return a deleted TST.

• This service does not return the TST index.

1.3 Unsupported Operations

Display of a deleted TST.

Display of the TST index.

1.4 Prerequisites

• A PNR must be active in the context, and contain at least one active TST.


9/69



Page 7 of 67

• If a TST is confidential, only the office that sets the confidentiality can access, read and update it, unlessaccess rights have been given beforehand.


10/69



Page 8 of 67

2 Building A Query

Two options are available when building a request: the option “ALL” - to display all TSTs appended to the

current PNR - and the option “SEL” - to select in a more precise way the TST(s) to be displayed. Use one of

these two options in the “attributeType” element.

For example, the following request will display all TSTs

ALL

When you use the “SEL” option, other sub-options are consequently available:

• “referenceType”: to say whether the choice of the TSTs to be displayed are done by TST reference

ID, passenger number, or segments.

• “uniqueReference” to send the tattoo numbers of the selected objects.

For instance, the following request will display only the TST whose tattoo is “1”:

SEL

TST

1

Additionally the service contains:

-"originInformation" to provide information on the origin of the message;

-"displayMode" to provide either all TSTs or only the information corresponding to the TST/ passenger selection;

-"pnrLocatorData" for PNR record locator information. This PNR record locator is used for tracking purpose.


11/69



Page 9 of 67

-"scrollingInformation" for the scrolling information;

-"tstReference" is used to get TST information for selected TST references.

As we can have up to 10 TSTs per Pax, and that a PNR can contain up to 99 passengers with one infant each,

then the maximum number of TSTs possible is 1980.

-"psaInformation" for passenger/segment references information about TST(s) to retrieve.

- Passenger reference specified : all the TSTs concerning this passenger reference are returned.

- Passenger/segment reference : only the TST having this passenger/segment association is returned.


12/69



Page 10 of 67

3 Receiving A Reply

The system returns all TSTs to be displayed by increasing order of tattoo number if there are less than 20

TSTs to be displayed.

Otherwise, the system returns the first 20, the number of remaining TSTs and the tattoo of the last TST displayed

as follows:

10 20

The response contains:

• "scrollingInformation" which provides Scrolling information used for long messages.

There is either the number of TSTs remaining (0 means that there is no more TST), and the last TST

reference in the list retrieved;

• The ATR segment contains the reason for manual update, in case of taxes and fees updates.

• Error information;

• "fareList", which details all the elements of the TST. Please note that the response may have several

TSTs imbedded. The maximum number of TSTs is: maximum number of passenger in a PNR (99) mulitpliedby 2 (each passenger can have an infant) multiplied by the maximum number of TSTs for one passenger

(10). It has been limited to 10 for message size constraint.


13/69



Page 11 of 67

4 Error Messages

Error code Error messages Explanation

2090 NO TST RECORD EXISTS User attempts to display a TST

when no TST is appended to the

PNR.

2075 INVALID TST NUMBER Tattoo of the request does not

correspond to any TST.

1908 CHECK PASSENGER NUMBER Tattoo of the request does not

correspond to any Passenger

8311 CHECK SEGMENT NUMBER Number of the request does notcorrespond to any segment

3504 COMBINATION NOT ALLOWED Associate in the same query TST

and passenger or TST and

segment selection.

12474 BSR MISSING OR INVALID The Banker’s rate is missing or

invalid.

1856 THIS SCROLLING REQUEST IS

NOT SUPPORTED

When the scrolling request is not

correct.

11 UNABLE TO PROCESS For other technical errors.

00477 INVALID FORMAT For when the entry is notspecified.

10620 RESTRICTED - CONFIDENTIAL

TST

when trying to display

a confidential TST without rights to

display it.

32350

INVALID SELECTION NUMBER If the fare or service

component specified doesn't exist

Example:

Scenario: there is a PNR with some TSTs appended.

In the query, user tries to display the TSTs number 1 and 8 (tattoos). However, the TST number 8 does not exist.

Query

SEL


14/69



Page 12 of 67

TST

8

TST

1

4.1 Error Reply

2075

EC

1M

7

INVALID TST NUMBER


15/69



Page 13 of 67

5 Operations

5.1 Operation: Baggage Allowance UpdateIn case travel Agent perform baggage Allowance modification with TTI or TTK entry, the "*" will be implemented

between TST Pricing indicator and FCPI.

5.1.1 Query Structure

ALL

5.1.2 Reply Structure

I

0

TST

1

1

CRD

2015

6

30

LMD

2015

6

30


16/69



Page 14 of 67

7X

PA

1

F

B

1044.00

EUR

712

1086.16

EUR

TFT

1086.16

EUR

7

X

OY

CB

TAX


17/69



Page 15 of 67

7.50EUR

7

X

DE

SE

TAX

8.24

EUR

7

X

RA

EB

TAX26.42

EUR

FRA

MAD


18/69



Page 16 of 67

O

AIR

Y

OK

YIF

33

W

K

S

1

1

FCA

FRA 7X MAD1142.99NUC1142.99END

ROE0.913391

ADT


19/69



Page 17 of 67

INT

BAU

AA

NCE7X0101

U

NCE7X0101

P

5.1.3 Possible Errors


20/69



Page 18 of 67

5.2 Operation: Display all TST(s)

This example shows how to display all the TSTs in the PNR.


ALL




21/69



Page 19 of 67

5.3 Operation: Display by Passenger selection

Situation: User wants to display all the TSTs related to the passenger with the tattoo 6.


SEL

2

3




22/69



Page 20 of 67

5.4 Operation: Display by segment selection

Situation: User wants to display all TSTs containing the segment which has the tattoo 6.


SEL

S

1

S

2




23/69



Page 21 of 67

5.5 Operation: Display by TST selection

Situation: User wants to display the TST with the tattoo 1.


SEL

TST

3




24/69



Page 22 of 67

5.6 Operation: Display TST Related to Adult only (without infant): example 1

User wants to display all adult TSTs for all passengers and infant TST for the passenger with the tattoo 1.


SEL

PA

PI

2




25/69



Page 23 of 67


Example 2: User wants to display adult TSTs for all passengers and all TST related to passenger with the

tattoo 1.


SEL

PA

PI

2




26/69



Page 24 of 67


Situation: there is a PNR in which passengers are as follows:

1.USERGUIDE/A 2.USERGUIDE/AA(INF) 3.USERGUIDE/AAA(CHD)

Example 1: User attempts to display all TSTs related to the adult passenger with the tattoo 2 (without the infant).

Note: In this case, the tattoo and the display number are the same (equal to 2). However, they could be different.

To display the TST related to the infant only, the value of the “refQualifier” should be set to “PI”.


SEL

PA

2




27/69



Page 25 of 67

5.9 Operation: Display TST related to either adult only or infant only

Situation: there is a PNR in which passengers are as follows:

1.USERGUIDE/A 2.USERGUIDE/AA(INF) 3.USERGUIDE/AAA(CHD)


SEL

TST

2




28/69



Page 26 of 67

5.10 Operation: Display TST with non-ticketable fareDisplay a TST with the non-ticketable fare indicator.

This option is not available by default, please contact your account manager for more information.


SEL

TST

1


M

1

TST

1

1

NTF

6X


29/69



Page 27 of 67

PA1

F

B

683.00

GBP

E

1212700

KRW

712

1432000

KRW

TFT

1324900KRW

TOF

107100

KRW

7

X

QX

AP


30/69



Page 28 of 67

TAX18700

KRW

7

X

IZ

EB

TAX

1500

KRW

7

X

FR

SE

TAX

6300

KRW

7


31/69



Page 29 of 67

X

FR

TI

TAX

19000

KRW

7

X

GB

AD

TAX

23100

KRW

7

X

UB

AS


32/69



Page 30 of 67

TAX

43600

KRW

1775.42

LON

LON

O

AIR

Y

OK

YIF

1

N

S

1


33/69



Page 31 of 67

1

X

AIR

Y

OK

YIF

1N

S

2

2

FCA

LON 6X PAR534.94 6X LON534.94NUC1069.88END

ROE0.638387


34/69



Page 32 of 67

ADT

INT

AA

NCE6X0100

OB

T01

COM

TESTTKT

TIN

44600

KRW

T02


35/69



Page 33 of 67

COM

TESTTKT2

TIN

22300

KRW

T04

COM

T04GEO8

TIN

22300

KRW

T05

COM

TESTB


36/69



Page 34 of 67

TIN

17900

KRW



37/69



Page 35 of 67

5.11 Operation: Display with 2 segments for one Fare ComponentSituation: a PNR with 1 TST. As in a redemption usecase.

In this request, user asks for the display of the TST.

In the answer, the TST tree structure is shown thanks to the fareComponentDetails Group.

Please note that no change is present in the query with respect to a display without the Fare Component. On

the other hand, in the answer, a new group is present.

In the following example, the TST has one fare component linked to the two segments. It has an amount in

Miles and a high Seasonality.


ALL


I

0

TST

1

1

CRD

2013

2

7

LMD


38/69



Page 36 of 67

20132

7

KE

PA

1

F

B

0.00

KRW

712

243300

KRW

TFT

243300

KRW

7

X

BP

DP


39/69



Page 37 of 67

TAX

28000

KRW

7

X

GB

AD

TAX

152100

KRW

7

X

UB

AS

TAX

63200

KRW


40/69



Page 38 of 67

SELSEL

O

AIR

C

OK

CXR

T

A

20148

15

2

N

S

1

1


41/69



Page 39 of 67

O

AIR

Y

OK

YRT

A

2014

8

15

1

N

S

2

2


42/69



Page 40 of 67

FCASEL KE LON 0.00 KE SEL 0.00 NUC 0.00 END

ROE1175.686000

MIL

MILEAGE SEL LHR8000 LHR

SEL8000TOTAL16000

ADT

INT

AA

SELKE0980

U

SELKE0980

P

16000

1

FAR

MIL

16000


43/69



Page 41 of 67

M

SEA

H

S

2

S

3



44/69



Page 42 of 67

5.12 Operation: Display with Fare ComponentSituation: a PNR with 1 TST.


In the answer, the TST structure shows the fareComponentDetails Group.

Please note that no changes are present in the request with respect to a display without the fare component.

On the other hand, in the answer, a new group is present.

In the example, the TST structure shows two fare components, both with an amount in Miles and a high

Seasonality.


ALL


I

0

TST

1

1

CRD

2013

2

7

LMD


45/69



Page 43 of 67

20132

7

KE

PA

1

F

B

0.00

KRW

712

243300

KRW

TFT

243300

KRW

7

X

BP

DP


46/69



Page 44 of 67

TAX

28000

KRW

7

X

GB

AD

TAX

152100

KRW

7

X

UB

AS

TAX

63200

KRW


47/69



Page 45 of 67

SELSEL

O

AIR

C

OK

CXR

T

A

20148

15

2

N

S

1

1


48/69



Page 46 of 67

O

AIR

Y

OK

YRT

A

2014

8

15

1

N

S

2

2


49/69



Page 47 of 67

FCASEL KE LON 0.00 KE SEL 0.00 NUC 0.00 END

ROE1175.686000

MIL

MILEAGE SEL LHR8000 LHR

SEL8000TOTAL16000

ADT

INT

AA

SELKE0980

U

SELKE0980

P

16000

1

FAR

MIL

8000


50/69



Page 48 of 67

M

SEA

H

S

2

2

FAR

MIL

8000

M

SEA

H

S

3


51/69



Page 49 of 67



52/69



Page 50 of 67

5.13 Operation: Display with Fare Family nameSituation: a PNR with 1 TST. The fare has been previously stored together with the fare family name it belongs

to.


In the response, the TST structure is shown thanks to the fareComponentDetails Group.

Please note that no change is present in the request with respect to a display without the Fare Component.


In the example, the structure has one Fare Component with a fare family name and a fare family owner:

• Fare family name is found in

• Fare family owner is found in


ALL


M

1

TST

1

1

6X

PA


53/69



Page 51 of 67

1

F

B

683.00

GBP

E

1212700

KRW

712

1432000

KRW

TFT

1324900

KRW

TOF

107100

KRW

7

X

QX

AP

TAX


54/69



Page 52 of 67

18700KRW

7

X

IZ

EB

TAX

1500

KRW

7

X

FR

SE

TAX6300

KRW

7


55/69



Page 53 of 67

X

FR

TI

TAX

19000

KRW

7

X

GB

AD

TAX

23100

KRW

7

X

UB

AS


56/69



Page 54 of 67

TAX43600

KRW

1775.42

LON

LON

O

AIR

Y

OK

YIF

1

N

S

1


57/69



Page 55 of 67

1

X

AIR

Y

OK

YIF

1

N

S

2

2

FCA

LON 6X PAR534.94 6X LON534.94NUC1069.88END

ROE0.638387


58/69



Page 56 of 67

ADT

INT

AA

NCE6X0100

OB

T01

COM

TESTTKT

TIN

44600

KRW

T02


59/69



Page 57 of 67

COM

TESTTKT2

TIN

22300

KRW

T04

COM

T04GEO8

TIN

22300

KRW

T05

COM

TESTB


60/69



Page 58 of 67

TIN17900

KRW

1

FAR

FARE FAMILY NAME

6X

S1

S

2



61/69



Page 59 of 67

5.14 Operation: Display with Service ComponentSituation: a PNR with 1 TST in an upgrade use case.


In the answer, the TST structure is shown thanks to the fareComponentDetails Group.

Please note that no change is present in the request with respect to a display without the Fare Component.


In particular, the TST structure shows one Fare Component and one Service component, both with an amount

in Miles and with a high Seasonality.


ALL


I

0

TST

1

1

CRD

2013

2

7

LMD


62/69



Page 60 of 67

20132

7

KE

PA

1

R

B

5336900

KRW

712

0

KRW

TFT

0

KRW

7

O

BP

DP


63/69



Page 61 of 67

TAX

28000

KRW

7

O

GB

AD

TAX

152100

KRW

7

O

UB

AS

TAX

63200

KRW


64/69



Page 62 of 67

SELSEL

O

AIR

C

OK

CXR

T

A

20148

15

2

N

S

1

1


65/69



Page 63 of 67

O

AIR

Y

OK

YRT

A

2014

8

15

1

N

S

2

2


66/69



Page 64 of 67

FCASEL KE LON Q148.00 2759.75KE SEL Q148.00 1483.60NUC4539.35END

ROE1175.686000

MIL

MILEAGE SEL LHR16000TOTAL16000

ADT

INT

AA

SELKE0980

U

SELKE0980

P

16000

1

FAR

700

5336900

KRW


67/69



Page 65 of 67

SEA

H

S

2

S

3

1

SER

MIL

16000

M

SEA

H


68/69



Page 66 of 67

S

2



69/69


5.15 Operation: Scrolling

Situation: A PNR with 30 TSTs numbered from 1 to 30 (tattoos).

In this request, user asks for the display of the two TSTs following TST with the tattoo 25.


SEL

2

25

