Task: Retrieve TravelScreen Information

This task allows the user to retrieve various pieces of TravelScreen information.  This information can then be used for additional processing, such as a Car Segment Sell or to process Form of Payment data.

The types of TravelScreen information that can be retrieved are:

Any or all of the above types of data can be retrieved within one request.

Section 1: Short Answer

Transaction Name:

TravelScreen_5_2

Can any other transactions perform this same task?

There is no other transaction that can be used to retrieve TravelScreen information.

Can this task be performed in a sessionless environment?

This task can be performed in a sessioned or sessionless environment.  In either type of environment, the associated PRO-File/Client File must first be retrieved to have access to TravelScreen information. 

Are the request and response identical on both the Apollo and Galileo systems?

The request and response for this task are identical on the Apollo and Galileo systems.

Industry-specific knowledge required to understand this task in terms of the specific business process.

The user should be aware of what business process is being used to determine what types of TravelScreen data are required.  For example, the user would not need to retrieve Car Append Sell information unless they were going to be doing a Car Segment Sell request. 

For certain pieces of information, the user can first issue a Retrieve TravelScreen status request.  The response from this request informs the user if certain types of data are available.  For more information, see the Retrieve TravelScreen Status task.

Special limits or distinct restrictions to the input data that may not be readily apparent.

The user must be authorized for TravelScreen to request any TravelScreen information. 

Section 2: Detailed Description

Request:

For a Retrieve TravelScreen information request, a <TSStatusMods> data record is required, with the appropriate elements for the type of data requested.  Optionally, a <ClientFileMods> data record proceeds <TSStatusMods> to retrieve the associated PRO-File/Client File.

Prerequisite tasks:

The Associated PRO-File/Client File must be retrieved for TravelScreen data to be available.  For information on PRO-File/Client File retrieval, see the PRO-File/ Client File Display task for the ClientFile_1_2 transaction.

Expected responses:

The response from a Retrieve TravelScreen Information request is a <TSStatus> block, with a variety of elements based on the type of data that was requested.  Details on the elements returned are found in Section 3 of this document.  If an error occurred, an <ErrText> element is returned in <TSStatus>. There can be multiple <ErrText> elements returned, one for each type of data requested.

If an optional <ClientFileMods> data record is in the request, there is also be a <ClientFile> data record.  For information on the data in <ClientFileMods>, see the Client File PRO/File Display task for the ClientFile_1_2 transaction.

Error and warning responses:

The main errors that can be returned for a Retrieve TravelScreen information request are because:

All errors are returned in a standard <ErrText> element, and the text explains the error.

Follow-on requests:

There are no follow-on tasks for this transaction. The information returned can be used in subsequent types of calls based on the business process of the user.  For example, the data returned for a Car Append Sell request can be used as information in the actual Car Segment Sell process. 

Section 3: Tables

1) Retrieve Membership Numbers (Air, Car and/or Hotel)

Request (Input) Tags

<TSStatusMods>

Terminal Equivalents:  Apollo _SP*M____   Galileo _CP*M____

 

 

Ordering

KLR

Min/Max

XML Tag

 

 

SPRM

1 – 1

<GetMembership>

Response (Output) Tags

<TSStatus>

If error occurred

 

 

Ordering

KLR

Min/Max

XML Tag

 

 

EROR

1 – 1

<ErrText>

 

<TSStatus>

If no error occurred

 

 

Ordering

KLR

Min/Max

XML Tag

 

A

SPMM

0 – 1

<AirFreqCust>

 

B

SPCM

0 – 1

<CarFreqCust>

 

C

SPHM

0 – 1

<HtlFreqCust>

 

Note: The three response elements are only returned if that type of membership number was requested. If a membership data type is requested, but no data exists for that type, the response element is returned empty.

2) Retrieve Guaranteed Form of Payment Information

Request (Input) Tags

<TSStatusMods>

Terminal Equivalents:   Apollo _SP*G____   Galileo _CP*G____

 

 

Ordering

KLR

Min/Max

XML Tag

 

 

SPFR

1 – 1

<GetFOP>

Response (Output) Tags

<TSStatus>

If error occurred

 

 

Ordering

KLR

Min/Max

XML Tag

 

 

EROR

1 – 1

<ErrText>

 

<TSStatus>

If no error occurred

 

 

Ordering

KLR

Min/Max

XML Tag

 

A

SPFB

1 – 1

<BusinessFOP>

 

B

SPFP

1 – 1

<PersonalFOP>

 

Note: Both <BusinessFOP> and <PersonalFOP> are returned. If no data exists, the elements are returned empty.

 

3) Retrieve Car Append Sell Information

Request (Input) Tags

<TSStatusMods>

Terminal Equivalents:   Apollo _SP01A1____   Galileo _CPN1A1____

 

 

Ordering

KLR

Min/Max

XML Tag

 

 

SPSC

1 – 1

<GetCarSellOpts>

Response (Output) Tags

<TSStatus>

If error occurred

 

 

Ordering

KLR

Min/Max

XML Tag

 

 

EROR

1 – 1

<ErrText>

 

<TSStatus>

If no error occurred

 

 

Ordering

KLR

Min/Max

XML Tag

 

 

SPS1

1 – 1

<CarSellOpts>

 

Note: <CarSellOpts> is always returned.  If no data exists, the element is returned empty.

4) Retrieve Hotel Append Sell Information

Request (Input) Tags

<TSStatusMods>

Terminal Equivalents:   Apollo _SP01A1KCOR____   Galileo _CPN1A1KCOR____

 

 

Ordering

KLR

Min/Max

XML Tag

 

 

SPSH

1 – 1

<GetHtlSellOpts>

Response (Output) Tags

<TSStatus>

If error occurred

 

 

Ordering

KLR

Min/Max

XML Tag

 

 

EROR

1 – 1

<ErrText>

 

<TSStatus>

If no error occurred

 

 

Ordering

KLR

Min/Max

XML Tag

 

 

SPH1

1 – 1

<HtlSellOpts>

 

Note: <HtlSellOpts> is always returned.  If no data exists, the element is returned empty.

 

5) Retrieve Air Sell Information

Request (Input) Tags

<TSStatusMods>

Terminal Equivalents:   Apollo _SPE____    Galileo _CPM____

 

 

Ordering

KLR

Min/Max

XML Tag

 

 

SPDR

1 – 1

<GetAirSellOpts>

Response (Output) Tags

<TSStatus>

If error occurred

 

 

Ordering

KLR

Min/Max

XML Tag

 

 

EROR

1 – 1

<ErrText>

 

<TSStatus>

If no error occurred

 

 

Ordering

KLR

Min/Max

XML Tag

 

A

SPAD

1 – 1

<AirData>

 

B

SPSR

1 – 1

<SSROptions>

 

Note: <AirData> and <SSROptions> are always returned.  If no data exists, the elements are returned empty.

6) Retrieve Car Vendor Data

Request (Input) Tags

5700 5.2

Terminal Equivalents:   Apollo _SPE____    Galileo _CPM____

 

 

Ordering

KLR

Min/Max

XML Tag

 

 

SPVI

1 – 1

<VendorData>

Response (Output) Tags

5701 5.2

If error occurred

 

 

Ordering

KLR

Min/Max

XML Tag

 

 

EROR

1 – 1

<ErrText>

 

5701 5.2

If no error occurred

 

 

Ordering

KLR

Min/Max

XML Tag

 

SPVC

1 – 1

<CarVendorInfo>

 

Note: The <CarVendorInfo>  may be returned empty if there is no Car Vendor Data but there was also no error which occurred.

7) Example of a Combined Request

Request (Input) Tags

<TSStatusMods>

Terminal Equivalents:   Apollo _NA____   Galileo _NA____

 

 

Ordering

KLR

Min/Max

XML Tag

 

A

SPRM

0 – 1

<GetMembership>

 

A

SPFR

0 – 1

<GetFOP>

 

A

SPSC

0 – 1

<GetCarSellOpts>

 

A

SPSH

0 – 1

<GetHtlSellOpts>

 

A

SPDR

0 – 1

<GetAirSellOpts>

 

Note: There is no special order for the elements when multiple types of data are requested.

Response (Output) Tags

<TSStatus>

If error occurred

 

 

Ordering

KLR

Min/Max

XML Tag

 

 

EROR

1 – 1

<ErrText>

 

<TSStatus>

If no error occurred

 

 

Ordering

KLR

Min/Max

XML Tag

 

A

SPMM

0 – 1

<AirFreqCust>

 

A

SPCM

0 – 1

<CarFreqCust>

 

A

SPHM

0 – 1

<HtlFreqCust> 

 

A

SPFB

0 – 1

<BusinessFOP>

 

A

SPFP

0 – 1

<PersonalFOP> 

 

A

SPS1

0 – 1

<CarSellOpts> 

 

A

SPH1

0 – 1

<HtlSellOpts>

 

A

SPAD

0 – 1

<AirData>

 

A

SPSR

0 – 1

<SSROptions> 

 

Note: The order of the response elements is based on the order of the request elements. For all response elements, if data was requested but none exists, the elements is returned empty.

 

Related Samples

 

TravelScreen_5_2_1

TravelScreen_5_2_2

TravelScreen_5_2_3

TravelScreen_5_2_4

TravelScreen_5_2_5

TravelScreen_5_2_6

TravelScreen_5_2_12

TravelScreen_5_2_9

TravelScreen_5_2_8

TravelScreen_5_2_7