Reminder: use your Qantas Staff Number and Active Directory Password to login.

For password issues contact 48884 option 2. For all other issues,
please email [email protected]
Pages / / API Backlog

/customer/ - flight/frequentflyer/leg
Created by Achim Drescher, last modified on Jul 03, 2017

Name Description

Name Frequentflyer Flightleg

Internal URI /capcre/v1/flight/frequentflyer/leg

API Gateway URI customer/capcre/v1/flight/frequentflyer/leg

Current Version V1.0

Short Description Provides customer details for frequentflyer on a particular leg.

API Overview
Provides customer details for a frequent flyer who boarded a particular AirSegment.
(At this point there are 2 options how this should be implemented) see UC33 - Loyalty Points Accrual - Design

Input Structure
Input Type: Json

Input Structure (Request Payload)

{
"system": "The calling system identifier (mandatory)",

"bookingId":bookingId,
"pnr":Amadeus PNR No,
"createdate":Amadeus Create Date,
"legId": CRE legId,
"passengerid": Amadeus Id of Passenger on PNR
"ffNo": Frequentflyer No,
}

Input Structure (Request Header):

x-request-id= (this correlationID is logged if present)

Field Description

system Idenifier of the application calling this should be set by the system calling. It will be used to identify system that call particular versions
of the API.

bookingid Mandatory (Optional if PNR and CreateDate are provided) Booking Travelplan ID. Booking Travelplan ID is provided by the boarding
event. or can be obtained from the system using the PNR and Create Date

pnr Mandatory (Optional if Booking ID given) Amadeus Booking ID - PNR No

createdate Mandatory (Optional if Booking ID given) Create Date of the PNR This makes the PNR unique.

legid Mandatory (Optional if FFNo or Passenger ID given) ID of the Passenger Leg requested (this is provided by the Boarding Events

passengerid Mandatory (Optional if FFNo or Leg ID given) ID of the passenger on the PNR. (Amadeus Natural Key)

ffno Mandatory (Optional if Leg Id or Passenger ID is given) Frequentflyer No of the Passenger of interest.

Output Structure
Output Type: Json
Passenger List Output Structure (Response Payload). Response HTTP Code 200
Returns a single leg where leg id is given or all legs for the passenger on the booking.
{
"frequentFlyer": {
"ssrcode": xx,
"ffCarrier": xx,
"ffNo": xx,
"paxLastName": xx,
"paxFirstName": xx
},
associatedAirSegment: {
"mrktgAirlineCode": xx,
"mrkgtAirlineRecordLoc": xx,
"departurePort": xx,
"departureTerm": xx,
"departureDateLoc": xx,
"departureDateUTC": xx,
"departureTimeLoc": xx,
"departureTimeUTC": xx,
"arrivalTerm": xx,
"operatingAirlineCode": xx,
"arrivalPort": xx,
"arrivalDateLoc": xx,
"arrivalDateUTC": xx,
"arrivalTimeLoc": xx,
"arrivalTimeUTC": xx,
"dateChgInd": xx,
"marketingFlightNo": xx,
"marketingFlightSfx": xx,
"cabinClass": xx,
"boardStatusCode": xx,
"boardStatus": xx,
"accCancelReasonCode": xx,
"accCancelReason": xx,
"acctStatusCode": xx,
"cabinClass (what is the fdifference to above": xx,
"onLoadStatus": xx,
"operatingCarrier": xx
},
"fareInformation": {
"farePriceDesignator": xx,
"primaryFarePriceCode": xx,
"fareBasisCode": xx,
"fareQualitfier": xx,
"fareAmount": xx,
"fareCurrencyCode": xx,
"fareTypeCode": xx,
"paymentIdentification": xx,
"redemptionRequest": xx,
"redemptionFFNo": xx,
"redemptionTariffClassId": xx,
"redemptionSequenceNo": xx,
"redemptionCertNo": xx,
"redemptionTariffClass": xx,
"pnrSpecialKeyword": xx,
"loyalityProgCarrier": xx,
"lopyaltyProgFFNo": xx,
"redemptionFFNo": xx,
"pnrElementSK": xx,
"pnrElementName":xx }
}

Error Output Structure (Response Payload). Response HTTP Code 404

This is returned if no flight can be found.
{
"errorCode": 410,
"errorDesc": "No matching flight"
}
This means a flight was found but no passengers are allocated to the flight.
{ "errorCode": 411,
"errorDesc": "Flight found but no passengers found for flight"
}

Error Output Structure. Response HTTP Code 400

Invalid user input

Error Output Structure. Response HTTP Code 500

Bug in code or some other failure, e.g. database error

Error Output Structure. Response HTTP Code 503

Database temporarily unavailable due to pool exceeding connection limit

Configuration
Overview
Configuration options in the server plugin manifest.json that drive how system behaves. The configuration items allow operators to change thresholds and
tune the result sets that are returned to the consumers.

Table and Column Details

Table Name Column Name Notes API Input/Output API
Element

EDHBKG.TMU0150_TP_LOYALTY_SERV SERV_KEYW_CODE SSR code (FQTV, ssrcode

FQTR, FQTS,
FQTU)

EDHBKG.TMU0150_TP_LOYALTY_SERV RQST_CARR_CODE Airline code of the ffCarrier

frequent flyer
account

EDHBKG.TMU0150_TP_LOYALTY_SERV FF_CARD_NUMBER Number of the ffNo

frequent flyer
account

EDHBKG.TMU0110_TP_PAX PAX_LAST_NAME Traveller last name paxLastName

Link Via Passnger
Leg

EDHBKG.TMU0110_TP_PAX PAX_FIRST_NAME Traveller First Name paxFirstName

Link via Passenger
Leg

TMU0120_DATED_AIR_SEG AIR_CARR_ALPHA_CODE?? Air Segment refers to mrktgAirlineCode

a single segment that
is linked to the leg
that was specified int
he input values
Owner Airline Code

TMU0120_DATED_AIR_SEG ?? Ganesh Owner Airline Record mrkgtAirlineRecordLoc

Locator

TMU0120_DATED_AIR_SEG DEPU_AIPC Departure Port departurePort

TMU0120_DATED_AIR_SEG ?? Ganesh DEPU_TRML_CODE Boarding point / departureTerm

Terminal Code

TMU0120_DATED_AIR_SEG DEPU_LOCL_DATE Departure Date Local departureDateLoc

TMU0120_DATED_AIR_SEG DEPU_UTC_DATE Departure Date UTC departureDateUTC

TMU0120_DATED_AIR_SEG DEPU_LOCL_TIME Departure Time departureTimeLoc

Local

TMU0120_DATED_AIR_SEG DEPU_UTC_TIME DepartureTime UTC departureTimeUTC

TMU0120_DATED_AIR_SEG ??Ganesh ARVL_TRML_CODE Off Point arrivalTerm

TMU0120_DATED_AIR_SEG OPRG_CARR_ALPHA_CODE Operator Airline oprtngAirlineCode

Code

TMU0120_DATED_AIR_SEG ARVL_AIPC Arrival Port arrivalPort

TMU0120_DATED_AIR_SEG ARVL_LOCL_DATE Arrival Date Local arrivalDateLoc

TMU0120_DATED_AIR_SEG ARVL_UTC_DATE Arrival Date UTC arrivalDateUTC

TMU0120_DATED_AIR_SEG ARVL_LOCL_TIME Arrival Time Local arrivalTimeLoc

Table Name Column Name Notes API Input/Output API
Element

TMU0120_DATED_AIR_SEG ARVL_UTC_TIME Arrival Time UTC arrivalTimeUTC

TMU0120_DATED_AIR_SEG ??Ganesh Date Change dateChgInd

Indicator

TMU0120_DATED_AIR_SEG MKTG_FLT_NO Marketing Flight mrktngFlightNo

Number

TMU0120_DATED_AIR_SEG MKTG_FLT_NO_SFX Marketing Flight mrktngFlightSfx

Suffix

TMU0122_TP_PAX_SEG; Not sure which field Cabin Class cabinClass

ORGL_CABC
ORGL_RSVN_CLAC
CODE_SHARE_RSVN_CLAC
TMU0123_TP_PAX_SEG_LEG.CABC

TMU0123_TP_PAX_SEG_LEG BRD_STAT_CODE Boarding status boardStatusCode

from reference table Boarding status boardStatus

description (filled
from reference data)

TMU0123_TP_PAX_SEG_LEG ACPT_CAN_RSN_CODE Acceptance accCancelReasonCode

Cancellation reason
code

From Reference table Acceptance accCancelReason

Cancellation reason
description

TMU0123_TP_PAX_SEG_LEG ACPT_STAT_CODE acctStatusCode

TMU0123_TP_PAX_SEG_LEG CABC ?? booking Class cabinClass (what is the

Only filled if needed fdifference to above

TMU0123_TP_PAX_SEG_LEG ONLOAD_STAT_CODE Onload status onLoadStatus

Not used for
PRL/PFS handback
OLD : OK
NOL : NOK
OLR : OK Regrade
RGD : Regrade
OFL : Offload
NA : Not Aplicable

The NA value is used

in case a PTY or
CBD exists but there
is no onload status.

TMU0120_DATED_AIR_SEG OPRG_CARR_ALPHA_CODE Operating Record operatingCarrier

Locator

TMU0170_TKT_DOC_FQ (New) Ticket designator of farePriceDesignator

the fare basis

TMU0170_TKT_DOC_FQ (New) Primary code of the primaryFarePriceCode

fare basis

TMU0170_TKT_DOC_FQ (New) Fare basis code of fareBasisCode

the fare basis

TMU0170_TKT_DOC_FQ (New) Fare qualifier fareQualitfier

T for Total Fare

TMU0170_TKT_DOC_FQ (New) Fare amount fareAmount

TMU0170_TKT_DOC_FQ (New) Fare currency code fareCurrencyCode

TMU0180_TP_PMT_DETL (New) Fare type code fareTypeCode

Information type,
coded
16 for Form of
payment information
Table Name Column Name Notes API Input/Output API
Element

TMU0180_TP_PMT_DETL (New) Fare free text fareText

Passenger type
(PAX, INF)
Original form of
payment (FPO/free
text)Free flow text
(excluding O/)[New]
form of payment free
text (US market
FP*free text)Free
flow text (excluding
*)[New] form of
payment
structuredForm(s) of
payment (CASH,
CHECK, CC,
MS)Credit card
informationCredit
card code Credit
card account number
Extended credit
payment request
Credit card expiry
date Credit card
approval code
Customer account
number Currency
Amount

TMU0180_TP_PMT_DETL (New) Form of payment paymentIdentification

identification
Generic type of the
Mean of Payment
used :
CC credit Card

TMU0180_TP_PMT_DETL (New) Frequent Flyer SSR redemptionRequest

element
Redemption/Upgrade
data
Action Request

TMU0180_TP_PMT_DETL (New) Frequent Flyer SSR redemptionFFNo

element
Redemption/Upgrade
data
Number of the ff
account

TMU0180_TP_PMT_DETL (New) Frequent Flyer SSR redemptionTariffClassId

element
Redemption/Upgrade
data
Rate/tariff class
identification

TMU0180_TP_PMT_DETL (New) Frequent Flyer SSR redemptionSequenceNo

element
Redemption/Upgrade
data
Sequence number

TMU0180_TP_PMT_DETL (New) Frequent Flyer SSR redemptionCertNo

element
Redemption/Upgrade
data
Certificate Number

TMU0180_TP_PMT_DETL (New) Frequent Flyer SSR redemptionTariffClass

element
Redemption/Upgrade
data
Rate/tariff class

TMU0180_TP_PMT_DETL (New) Special Keyword pnrSpecialKeyword

element (SK)`
PNR element name
(SK)
 Table Name Column Name Notes API Input/Output API
Element

TMU0180_TP_PMT_DETL (New) Frequent Flyer SSR loyalityProgCarrier

element
Airline code of the
frequent flyer
account

TMU0180_TP_PMT_DETL (New) Frequent Flyer SSR lopyaltyProgFFNo

element
Number of the
frequent flyer
account

TMU0180_TP_PMT_DETL (New) Frequent Flyer SSR redemptionFFNo

element
Redemption/Upgrade
data
Number of the
frequent flyer
account

TMU0180_TP_PMT_DETL (New) Special Keyword pnrElementSK

element (SK)
PNR element name
(SK)

TMU0180_TP_PMT_DETL (New) Frequent Flyer SSR pnrElementName

element
PNR element name
(SSR)

Fare Basis

Table Name Attribute Category Sub- Name Element Description

Category

QF FQTV Service Special Frequent SSR code (FQTV,

i.e. FF element Service Flyer SSR FQTR, FQTS,
Number Request element FQTU)
element
(SSR)

Service Special Frequent Airline code of the

element Service Flyer SSR frequent flyer
Request element account
element
(SSR)

Service Special Frequent Number of the

element Service Flyer SSR frequent flyer
Request element account
element
(SSR)

Last Name Name Passenger Individual Traveller last name Last name
element Name information
element
(NM)

First Name Name Passenger Individual Traveller first name Traveler first name
& Title element Name information and/or title
element
(NM)

Owner Air Air Air segment Airline code

Airline segment segment information
- flight
details

Amadeus Air Air Reservation Airline Record

Record segment segment control Locator
Locator/Ref information
#

Origin Air Air Air segment Boarding point Place/Location Identification -

Airport segment segment information airport code
Code
 - flight
details

Origin Air Air Air segment Departure date

Departure segment segment information (ddmmyy)
Date - flight
details

Origin Air Air Air segment Departure time

Departure segment segment information (hhmm)
Time - flight
details

Destination Air Air Air segment Off point Place/Location Identification -

Airport segment segment information airport code
Code - flight
details

Airline Air Air Air segment Airline code Company Identification

Code segment segment information
- flight
details

Arrival Air Air Air segment Arrival date

Date segment segment information (ddmmyy)
- flight
details

Arrival Air Air Air segment Arrival time (hhmm)

Time segment segment information
- flight
details

Air Air Air segment Day change indicator

segment segment information (+1, +2, -1)
- flight
details

Flight # Air Air Air segment Flight number Product Identification

segment segment information
- flight
details

Booked Air Air Air segment Class of service - Characteristic Identification

Class segment segment information Booking class
- flight
details

Travelled Product Product Boarding Boarding Status Resolve from reference tables
class Delivery Delivery status Description
Information Information
at Leg
Level

Product Product Boarding Customer Boarding

Delivery Delivery status status
Information Information
at Leg
Level

Product Product Acceptance Reason Code

Delivery Delivery Cancellation
Information Information reason code
at Leg
Level

Product Product Acceptance Description

Delivery Delivery Cancellation
Information Information reason
at Leg description
Level

Product Product Segment booking Class booking Class

Delivery Delivery details Only filled if needed
Information Information
at
Segment
Level

Product Product Onload Onload status Not used for PRL/PFS handback
Delivery Delivery status OLD : OK
Information Information NOL : NOK
at Leg OLR : OK Regrade
Level RGD : Regrade
OFL : Offload
NA : Not Aplicable

The NA value is used in case a

 PTY or CBD exists but there is
no onload status.

Operating Air Air Reservation Marketing or

Airline segment segment control operating Record
information Locator

TMU0170_TKT_DOC_FQ Ticketing Transitional TST Fare basis Ticket designator of

- Fare basis element Stored element information the fare basis
Ticket (New TST)
(ingestion change (New TST)
required)

Ticketing Transitional TST Fare basis Primary code of the

element Stored element information fare basis
Ticket (New TST)
(New TST)

Ticketing Transitional TST Fare basis Fare basis code of

element Stored element information the fare basis
Ticket (New TST)
(New TST)

Ticketing Transitional TST Total Fare Fare qualifier

element Stored element T for Total Fare
Ticket (New TST)
(New TST)

Ticketing Transitional TST Total Fare Fare amount

element Stored element
Ticket (New TST)
(New TST)

Ticketing Transitional TST Total Fare Fare currency code

element Stored element
Ticket (New TST)
(New TST)

TMU0180_TP_PMT_DETL Form of Ticketing Fare Form of Fare subject qualifier Text subject qualifier
- Form of payment Payment element Elements Payment 3 for literal text
element
(ingestion change (FP)
required)

Ticketing Fare Form of Fare type code Information type, coded

element Elements Payment 16 for Form of payment
element information
(FP)

Ticketing Fare Form of Fare free text Passenger type (PAX, INF)
element Elements Payment Original form of payment
element (FPO/free text)Free flow text
(FP) (excluding O/)[New] form of
payment free text (US market
FP*free text)Free flow text
(excluding *)[New] form of
payment structuredForm(s) of
payment (CASH, CHECK, CC,
MS)Credit card informationCredit
card code Credit card account
number Extended credit payment
request Credit card expiry date
Credit card approval code
Customer account number
Currency Amount

Ticketing Fare New Form Form of payment Generic type of the Mean of
element Elements of Payment identification Payment used :
element CC credit Card
(FP)

Upgrade Service Special Frequent Redemption/Upgrade

Voucher # element Service Flyer SSR data
Request element Action request
element
(SSR)

Service Special Frequent Redemption/Upgrade

element Service Flyer SSR data
Request element Number of the
element frequent flyer
(SSR) account

Service Special Frequent Redemption/Upgrade

element Service Flyer SSR data
Request element Rate/tariff class
identification
 element
(SSR)

Service Special Frequent Redemption/Upgrade

element Service Flyer SSR data
Request element Sequence number
element
(SSR)

Service Special Frequent Redemption/Upgrade

element Service Flyer SSR data
Request element Certificate number
element
(SSR)

Service Special Frequent Redemption/Upgrade

element Service Flyer SSR data
Request element Rate/tariff class
element
(SSR)

Amadeus Service Special Special PNR element name PNR element

Keyword element Keyword Keyword (SK) SK
element element
(SK) (SK)

Other Service Special Frequent Airline code of the

Airline FF # element Service Flyer SSR frequent flyer
Request element account
element
(SSR)

Service Special Frequent Number of the

element Service Flyer SSR frequent flyer
Request element account
element
(SSR)

Redeeming Service Special Frequent Redemption/Upgrade

QFF # element Service Flyer SSR data
Request element Number of the
element frequent flyer
(SSR) account

Service Special Special PNR element name PNR element

element Keyword Keyword (SK) SK
element element
(SK) (SK)

Service Special Frequent PNR element name PNR element

element Service Flyer SSR (SSR) SSR
Request element
element
(SSR)

References
UC33 - Loyalty Points Accrual
UC33 - Loyalty Points Accrual - Design

Like Be the first to like this No labels