You are on page 1of 45

Web services User's Guide

Function: CalculateMileage

Amadeus SAS
485, Route du Pin Montard
BP 69
06902 Sophia-Antipolis Cedex
Table of Contents

Table of Contents
Interface: ...............................................................................................................................
Introduction.........................................................................................................................
Function: CalculateMileage..................................................................................................2
Overview.......................................................................................................................... 2
Supported Operations...................................................................................................... 2
Unsupported Operations.................................................................................................. 2
Prerequisites.................................................................................................................... 2
Building A Query.............................................................................................................. 2
Receiving A Reply............................................................................................................ 2
Reply Structure.................................................................................................................2
Error Messages................................................................................................................ 2
Operation: 1. CalculateMileage with combining options...................................................2
Query Structure............................................................................................................ 3
Possible Errors........................................................................................................... 10
Operation: 10. Display surcharge band for a city pair with a global routing and a
currency amount................................................................................................................ 10
Query Structure.......................................................................................................... 11
Possible Errors........................................................................................................... 12
Operation: 2. Calculate Mileage with airline and stopover............................................. 12
Query Structure.......................................................................................................... 13
Possible Errors........................................................................................................... 19
Operation: 3. Calculate Mileage with adjacent city indicator.......................................... 19
Query Structure.......................................................................................................... 19
Possible Errors........................................................................................................... 24
Operation: 4. Calculate Mileage with exclude city pair...................................................25
Query Structure.......................................................................................................... 25
Possible Errors........................................................................................................... 30
Operation: 5.CalculateMileage with no Ticketed Permitted Mileage (TPM) returned.....31

i
Table of Contents

Query Structure.......................................................................................................... 31
Possible Errors........................................................................................................... 33
Operation: 6. Display surcharge band for a city pair...................................................... 33
Query Structure.......................................................................................................... 33
Possible Errors........................................................................................................... 35
Operation: 7. Display surcharge band with mileage amount..........................................35
Query Structure.......................................................................................................... 36
Possible Errors........................................................................................................... 37
Operation: 8. Display surcharge band with currency amount.........................................37
Query Structure.......................................................................................................... 38
Possible Errors........................................................................................................... 39
Operation: 9. Display surcharge band with mileage and currency amounts.................. 39
Query Structure.......................................................................................................... 40
Possible Errors........................................................................................................... 41

ii
User guide for function CalculateMileage

CalculateMileage

Copyright © 1987-2009 Amadeus IT Group SA.


Page 1 of 41
Web services User guide for function CalculateMileage

Function: CalculateMileage.
Overview
The PSP Service CalculateMileage is used to display of point to point mileage for a specific journey. The
response data might include information such as maximum permitted mileage (MPM) and/or ticketed point
mileage (TPM). The response is a result of a standalone transaction. (This PSP service provides the same
information as the cryptic FQM transaction.)
CalculateMileage service general code function is 717 (cryptic transaction code is FQM). Basic entry for this
service is a journey's city pair for which the mileage calculation is asked. It is also possible to add a specific
date, carrier and/or global route code in the request.

Supported Operations
Not applicable

Limitations
Not applicable

Unsupported Operations
Not applicable

Prerequisites
Not applicable

Building A Query

Receiving A Reply

ReplyStructure

XML Error Reply

Error Messages

Operation: 1. CalculateMileage with combining options


This example is equivalent to the following cryptic: FQM NCE/AAF LON/ABA NYC/VUS LAX TYO/20AUG
Explanations of new information

Copyright © 1987-2009 Amadeus IT Group SA.


Page 2 of 41
User guide for function CalculateMileage

INPUT
717: code function for CalculateMileage (FQM).
City pair in origDest (ODI): Departure and arrival cities of the journey.
City pair in all routingInfo (RTG): Start and End cities of the trip' segment.
In dateFlightMovement (DAT): travel date 20AUG08 and ‚¢??B' qualifier meaning "First Travel Date".
In transportService (TRA): carrier specified for this segment.
In segFareDetails (FQU): global direction specified for this segment.
OUTPUT
717: code function for CalculateMileage (FQM).
City pair in originDestination (ODI): Departure and arrival cities of the journey.
City pair in routingInfo (RTG): Start and End cities of the trip' segment followed by their area number
qualifier.
All M in pertinentQuantity (QTY): mileage based on miles.
701: qualifier for Ticketed Point Mileage (TPM) followed by its value.
700: qualifier for Maximum Permitted Mileage (MPM) followed by its value.
714: qualifier that means that the mileage doesn't exceed the 25% surcharge value.
710: qualifier for Higher Level Mileage followed by its value.
709: qualifier for Lower Level Mileage followed by its value.
706: qualifier for 25 percent premium followed by its value.
708: qualifier for Cumulative mileage (current TPM value added to the previous ones).
EMA: qualifier for Extra mileage addition followed by its value (by default no addition).
In qualificationOfFare (FQU): global direction of the segment for the TPM or MPM mileage calculation
(difference made with the qualifier TPM or MPM at the end of the segment).

Query Structure
<Fare_CalculateMileage>
<msgType>
<messageFunctionDetails>
<messageFunction>717</messageFunction>
</messageFunctionDetails>
</msgType>
<tripDescription>
<origDest>
<origin>NCE</origin>
<destination>TYO</destination>
</origDest>
<dateFlightMovement>
<dateAndTimeDetails>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 3 of 41
Web services User guide for function CalculateMileage

<qualifier>B</qualifier>
<date>200809</date>
</dateAndTimeDetails>
</dateFlightMovement>
<routing>
<routingInfo>
<routingDetails>
<station>NCE</station>
<otherStation>LON</otherStation>
</routingDetails>
</routingInfo>
<transportService>
<companyIdentification>
<marketingCompany>AF</marketingCompany>
</companyIdentification>
</transportService>
</routing>
<routing>
<routingInfo>
<routingDetails>
<station>LON</station>
<otherStation>NYC</otherStation>
</routingDetails>
</routingInfo>
<transportService>
<companyIdentification>
<marketingCompany>BA</marketingCompany>
</companyIdentification>
</transportService>
</routing>
<routing>
<routingInfo>
<routingDetails>
<station>NYC</station>
<otherStation>LAX</otherStation>
</routingDetails>
</routingInfo>
<segFareDetails>
<movementType>7US</movementType>
</segFareDetails>
</routing>
<routing>
<routingInfo>
<routingDetails>
<station>LAX</station>
<otherStation>TYO</otherStation>
</routingDetails>
</routingInfo>
</routing>
</tripDescription>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 4 of 41
User guide for function CalculateMileage

</Fare_CalculateMileage>

Reply Structure
<Fare_CalculateMileageReply>
<transactionType>
<messageFunctionDetails>
<messageFunction>717</messageFunction>
</messageFunctionDetails>
</transactionType>
<flightDetails>
<nbOfSegments/>
<odiGrp>
<originDestination>
<origin>NCE</origin>
<destination>TYO</destination>
</originDestination>
<routingGrp>
<routingInfo>
<routingDetails>
<station>NCE</station>
<qualifier>TC2</qualifier>
</routingDetails>
<routingDetails>
<station>LON</station>
<qualifier>TC2</qualifier>
</routingDetails>
</routingInfo>
<qualificationOfFare>
<movementType>7EH</movementType>
<discountDetails>
<fareQualifier>TPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<qualificationOfFare>
<movementType>7EH</movementType>
<discountDetails>
<fareQualifier>MPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<pertinentQuantity>
<quantityDetails>
<qualifier>701</qualifier>
<value>645</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>708</qualifier>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 5 of 41
Web services User guide for function CalculateMileage

<value>645</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>700</qualifier>
<value>774</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>714</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>710</qualifier>
<value>129</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>709</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>706</qualifier>
<value>967</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>EMA</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
</pertinentQuantity>
</routingGrp>
<routingGrp>
<routingInfo>
<routingDetails>
<station>LON</station>
<qualifier>TC2</qualifier>
</routingDetails>
<routingDetails>
<station>NYC</station>
<qualifier>TC1</qualifier>
</routingDetails>
</routingInfo>
<qualificationOfFare>
<movementType>7AT</movementType>
<discountDetails>
<fareQualifier>TPM</fareQualifier>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 6 of 41
User guide for function CalculateMileage

</discountDetails>
</qualificationOfFare>
<qualificationOfFare>
<movementType>7AT</movementType>
<discountDetails>
<fareQualifier>MPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<pertinentQuantity>
<quantityDetails>
<qualifier>701</qualifier>
<value>3458</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>708</qualifier>
<value>4103</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>700</qualifier>
<value>4784</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>714</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>710</qualifier>
<value>681</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>709</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>706</qualifier>
<value>5980</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>EMA</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
</pertinentQuantity>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 7 of 41
Web services User guide for function CalculateMileage

</routingGrp>
<routingGrp>
<routingInfo>
<routingDetails>
<station>NYC</station>
<qualifier>TC1</qualifier>
</routingDetails>
<routingDetails>
<station>LAX</station>
<qualifier>TC1</qualifier>
</routingDetails>
</routingInfo>
<qualificationOfFare>
<movementType>7US</movementType>
<discountDetails>
<fareQualifier>TPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<qualificationOfFare>
<movementType>7AT</movementType>
<discountDetails>
<fareQualifier>MPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<pertinentQuantity>
<quantityDetails>
<qualifier>701</qualifier>
<value>2461</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>708</qualifier>
<value>6564</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>700</qualifier>
<value>7297</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>714</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>710</qualifier>
<value>733</value>
<unit>M</unit>
</quantityDetails>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 8 of 41
User guide for function CalculateMileage

<quantityDetails>
<qualifier>709</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>706</qualifier>
<value>9121</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>EMA</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
</pertinentQuantity>
</routingGrp>
<routingGrp>
<routingInfo>
<routingDetails>
<station>LAX</station>
<qualifier>TC1</qualifier>
</routingDetails>
<routingDetails>
<station>TYO</station>
<qualifier>TC3</qualifier>
</routingDetails>
</routingInfo>
<qualificationOfFare>
<movementType>7PA</movementType>
<discountDetails>
<fareQualifier>TPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<qualificationOfFare>
<movementType>7AP</movementType>
<discountDetails>
<fareQualifier>MPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<pertinentQuantity>
<quantityDetails>
<qualifier>701</qualifier>
<value>5458</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>708</qualifier>
<value>12022</value>
<unit>M</unit>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 9 of 41
Web services User guide for function CalculateMileage

</quantityDetails>
<quantityDetails>
<qualifier>700</qualifier>
<value>12046</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>714</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>710</qualifier>
<value>24</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>709</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>706</qualifier>
<value>15057</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>EMA</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
</pertinentQuantity>
</routingGrp>
</odiGrp>
</flightDetails>
</Fare_CalculateMileageReply>

Possible Errors

Operation: 10. Display surcharge band for a city pair with a global routing and
a currency amount
This example is equivalent to the following cryptic: FQM*HKG/VEHLON*HKD2700.
Explanations of new information
INPUT

Copyright © 1987-2009 Amadeus IT Group SA.


Page 10 of 41
User guide for function CalculateMileage

717: code function for CalculateMileage (FQM).


In monetaryInfo (MON): qualifier CUR, meaning "Currency Surcharge" followed by base currency amount to
calculate the surcharge currency values and the currency code (in this case HKD).
City pair in origDest (ODI): city pair requested for the surcharge mileage calculation. The base amount of
mileage used for the mileage surcharge band display will be the MPM (Maximum Permitted Mileage)
between these two cities.
City pair in all routingInfo (RTG): city pair requested for the surcharge mileage calculation followed by the
"MTD" qualifier meaning "Mileage Table Display".
In segFareDetails (FQU): route code specified for this segment.
OUTPUT
717: code function for CalculateMileage (FQM).
In monetaryRates (MON):0P: qualifier for currency base amount (used to calculated currency surcharges)
followed by its value and the currency code.
The currency code is just set with the base currency amount since it's the same currency code for all the
surcharges' values.
5P: qualifier for 5 percent surcharge followed by its value.
10P: qualifier for 10 percent surcharge followed by its value.
15P: qualifier for 15 percent surcharge followed by its value.
20P: qualifier for 20 percent surcharge followed by its value.
25P: qualifier for 25 percent surcharge followed by its value.
City pair in originDestination (ODI): city pair requested for the surcharge mileage calculation.
City pair in routingInfo (RTG): city pair requested for the surcharge mileage calculation.
All M in pertinentQuantity (QTY): mileage based on miles.
700: qualifier for MPM base amount followed by its value (for the city pair requested).
702: qualifier for 5 percent premium followed by its value (5% of mileage surcharge).
703: qualifier for 10 percent premium followed by its value (10% of mileage surcharge).
704: qualifier for 15 percent premium followed by its value (15% of mileage surcharge).
705: qualifier for 20 percent premium followed by its value (20% of mileage surcharge).
706: qualifier for 25 percent premium followed by its value (25% of mileage surcharge).
In qualificationOfFare (FQU): global direction of the segment for the MPM mileage calculation (always MPM
in this case), followed by the "MPM" qualifier.

Query Structure
<Fare_CalculateMileage>
<msgType>
<messageFunctionDetails>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 11 of 41
Web services User guide for function CalculateMileage

<messageFunction>717</messageFunction>
</messageFunctionDetails>
</msgType>
<monetaryInfo>
<monetaryDetails>
<typeQualifier>CUR</typeQualifier>
<amount>2700</amount>
<currency>HKD</currency>
</monetaryDetails>
</monetaryInfo>
<tripDescription>
<origDest>
<origin>HKG</origin>
<destination>LON</destination>
</origDest>
<routing>
<routingInfo>
<routingDetails>
<station>HKG</station>
<otherStation>LON</otherStation>
<qualifier>MTD</qualifier>
</routingDetails>
</routingInfo>
<segFareDetails>
<movementType>7EH</movementType>
</segFareDetails>
</routing>
</tripDescription>
</Fare_CalculateMileage>

Reply Structure

Possible Errors

Operation: 2. Calculate Mileage with airline and stopover


This example is equivalent to the following cryptic: FQM BUE/ARG SAO/AAA MIA- ATL
Explanations of new information
INPUT
717: code function for CalculateMileage (FQM).
City pair in origDest (ODI): Departure and arrival cities of the journey.
City pair in all routingInfo (RTG): Start and End cities of the trip' segment.

Copyright © 1987-2009 Amadeus IT Group SA.


Page 12 of 41
User guide for function CalculateMileage

In last RTG segment: "SO" qualifier meaning that a stopover occurs at this departure city pair (i.e. MIA).
In transportService (TRA): carrier specified for this segment.
OUTPUT
717: code function for CalculateMileage (FQM).
City pair in originDestination (ODI): Departure and arrival cities of the journey.
City pair in routingInfo (RTG): Start and End cities of segment followed by their area number qualifier.
In flightErrorText (IFT): Back message post mileage calculation. (due to the stopover).
All M in pertinentQuantity (QTY): mileage based on miles.
701: qualifier for Ticketed Point Mileage (TPM) followed by its value.
700: qualifier for Maximum Permitted Mileage (MPM) followed by its value.
714: qualifier that means that the mileage doesn't exceed the 25% surcharge value.
710: qualifier for Higher Level Mileage followed by its value.
709: qualifier for Lower Level Mileage followed by its value.
706: qualifier for 25 percent premium followed by its value.
708: qualifier for Cumulative mileage (current TPM value added to the previous ones).
EMA: qualifier for Extra mileage addition followed by its value (by default no addition).
In qualificationOfFare (FQU): global direction of the segment for the TPM or MPM mileage calculation
(difference made with the qualifier TPM or MPM at the end of the segment).

Query Structure
<Fare_CalculateMileage>
<msgType>
<messageFunctionDetails>
<messageFunction>717</messageFunction>
</messageFunctionDetails>
</msgType>
<tripDescription>
<origDest>
<origin>BUE</origin>
<destination>ATL</destination>
</origDest>
<routing>
<routingInfo>
<routingDetails>
<station>BUE</station>
<otherStation>SAO</otherStation>
</routingDetails>
</routingInfo>
<transportService>
<companyIdentification>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 13 of 41
Web services User guide for function CalculateMileage

<marketingCompany>RG</marketingCompany>
</companyIdentification>
</transportService>
</routing>
<routing>
<routingInfo>
<routingDetails>
<station>SAO</station>
<otherStation>MIA</otherStation>
</routingDetails>
</routingInfo>
<transportService>
<companyIdentification>
<marketingCompany>AA</marketingCompany>
</companyIdentification>
</transportService>
</routing>
<routing>
<routingInfo>
<routingDetails>
<station>MIA</station>
<otherStation>ATL</otherStation>
<qualifier>SO</qualifier>
</routingDetails>
</routingInfo>
</routing>
</tripDescription>
</Fare_CalculateMileage>

Reply Structure
<Fare_CalculateMileageReply>
<transactionType>
<messageFunctionDetails>
<messageFunction>717</messageFunction>
</messageFunctionDetails>
</transactionType>
<flightDetails>
<nbOfSegments/>
<odiGrp>
<originDestination>
<origin>BUE</origin>
<destination>ATL</destination>
</originDestination>
<flightErrorText>
<freeTextQualification>
<textSubjectQualifier>BCK</textSubjectQualifier>
<informationType>13</informationType>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 14 of 41
User guide for function CalculateMileage

</freeTextQualification>
<freeText>EMA APPLIED - AA</freeText>
</flightErrorText>
<routingGrp>
<routingInfo>
<routingDetails>
<station>BUE</station>
<qualifier>TC1</qualifier>
</routingDetails>
<routingDetails>
<station>SAO</station>
<qualifier>TC1</qualifier>
</routingDetails>
</routingInfo>
<qualificationOfFare>
<movementType>7WH</movementType>
<discountDetails>
<fareQualifier>TPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<qualificationOfFare>
<movementType>7WH</movementType>
<discountDetails>
<fareQualifier>MPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<pertinentQuantity>
<quantityDetails>
<qualifier>701</qualifier>
<value>1055</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>708</qualifier>
<value>1055</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>700</qualifier>
<value>1266</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>714</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>710</qualifier>
<value>211</value>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 15 of 41
Web services User guide for function CalculateMileage

<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>709</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>706</qualifier>
<value>1582</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>EMA</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
</pertinentQuantity>
</routingGrp>
<routingGrp>
<routingInfo>
<routingDetails>
<station>SAO</station>
<qualifier>TC1</qualifier>
</routingDetails>
<routingDetails>
<station>MIA</station>
<qualifier>TC1</qualifier>
</routingDetails>
</routingInfo>
<qualificationOfFare>
<movementType>7WH</movementType>
<discountDetails>
<fareQualifier>TPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<qualificationOfFare>
<movementType>7WH</movementType>
<discountDetails>
<fareQualifier>MPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<pertinentQuantity>
<quantityDetails>
<qualifier>701</qualifier>
<value>4070</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>708</qualifier>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 16 of 41
User guide for function CalculateMileage

<value>4615</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>700</qualifier>
<value>5300</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>714</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>710</qualifier>
<value>685</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>709</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>706</qualifier>
<value>6625</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>EMA</qualifier>
<value>510</value>
<unit>M</unit>
</quantityDetails>
</pertinentQuantity>
</routingGrp>
<routingGrp>
<routingInfo>
<routingDetails>
<station>MIA</station>
<qualifier>TC1</qualifier>
</routingDetails>
<routingDetails>
<station>ATL</station>
<qualifier>TC1</qualifier>
</routingDetails>
</routingInfo>
<qualificationOfFare>
<movementType>7US</movementType>
<discountDetails>
<fareQualifier>TPM</fareQualifier>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 17 of 41
Web services User guide for function CalculateMileage

</discountDetails>
</qualificationOfFare>
<qualificationOfFare>
<movementType>7WH</movementType>
<discountDetails>
<fareQualifier>MPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<pertinentQuantity>
<quantityDetails>
<qualifier>701</qualifier>
<value>596</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>708</qualifier>
<value>5211</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>700</qualifier>
<value>6013</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>714</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>710</qualifier>
<value>802</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>709</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>706</qualifier>
<value>7516</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>EMA</qualifier>
<value>510</value>
<unit>M</unit>
</quantityDetails>
</pertinentQuantity>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 18 of 41
User guide for function CalculateMileage

</routingGrp>
</odiGrp>
</flightDetails>
</Fare_CalculateMileageReply>

Possible Errors
See "Error Messages" section.

Operation: 3. Calculate Mileage with adjacent city indicator


This example is equivalent to the following cryptic: FQM LON DUS--CGN ZRH
Explanations of new information
INPUT
717: code function for CalculateMileage (FQM).
City pair in origDest (ODI): Departure and arrival cities of the journey.
City pair in all routingInfo (RTG): Start and End cities of the trip' segment.
Second routingInfo (RTG) describes the SURFACE case between arrival city of the previous segment and
departure city of the next segment. "SU" qualifier is put to confirm that this segment is a "surface".
OUTPUT
717: code function for CalculateMileage (FQM).
City pair in originDestination (ODI): Departure and arrival cities of the journey.
City pair in routingInfo (RTG): Start and End cities of the segment followed by their area number qualifier.
All M in pertinentQuantity (QTY): mileage based on miles.
701: qualifier for Ticketed Point Mileage (TPM) followed by its value.
700: qualifier for Maximum Permitted Mileage (MPM) followed by its value.
714: qualifier that means that the mileage doesn't exceed the 25% surcharge value.
710: qualifier for Higher Level Mileage followed by its value.
709: qualifier for Lower Level Mileage followed by its value.
706: qualifier for 25 percent premium followed by its value.
708: qualifier for Cumulative mileage (current TPM value added to the previous ones).
EMA: qualifier for Extra mileage addition followed by its value (by default no addition).
In qualificationOfFare (FQU): global direction of the segment for the TPM or MPM mileage calculation
(difference made with the qualifier TPM or MPM at the end of the segment).

Query Structure

Copyright © 1987-2009 Amadeus IT Group SA.


Page 19 of 41
Web services User guide for function CalculateMileage

<Fare_CalculateMileage>
<msgType>
<messageFunctionDetails>
<messageFunction>717</messageFunction>
</messageFunctionDetails>
</msgType>
<tripDescription>
<origDest>
<origin>LON</origin>
<destination>ZRH</destination>
</origDest>
<routing>
<routingInfo>
<routingDetails>
<station>LON</station>
<otherStation>DUS</otherStation>
</routingDetails>
</routingInfo>
</routing>
<routing>
<routingInfo>
<routingDetails>
<station>DUS</station>
<otherStation>CGN</otherStation>
<qualifier>SU</qualifier>
</routingDetails>
</routingInfo>
</routing>
<routing>
<routingInfo>
<routingDetails>
<station>CGN</station>
<otherStation>ZRH</otherStation>
</routingDetails>
</routingInfo>
</routing>
</tripDescription>
</Fare_CalculateMileage>

Reply Structure
<Fare_CalculateMileageReply>
<transactionType>
<messageFunctionDetails>
<messageFunction>717</messageFunction>
</messageFunctionDetails>
</transactionType>
<flightDetails>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 20 of 41
User guide for function CalculateMileage

<nbOfSegments/>
<odiGrp>
<originDestination>
<origin>LON</origin>
<destination>ZRH</destination>
</originDestination>
<routingGrp>
<routingInfo>
<routingDetails>
<station>LON</station>
<qualifier>TC2</qualifier>
</routingDetails>
<routingDetails>
<station>DUS</station>
<qualifier>TC2</qualifier>
</routingDetails>
</routingInfo>
<qualificationOfFare>
<movementType>7EH</movementType>
<discountDetails>
<fareQualifier>TPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<qualificationOfFare>
<movementType>7EH</movementType>
<discountDetails>
<fareQualifier>MPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<pertinentQuantity>
<quantityDetails>
<qualifier>701</qualifier>
<value>298</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>708</qualifier>
<value>298</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>700</qualifier>
<value>357</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>714</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 21 of 41
Web services User guide for function CalculateMileage

<quantityDetails>
<qualifier>710</qualifier>
<value>59</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>709</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>706</qualifier>
<value>446</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>EMA</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
</pertinentQuantity>
</routingGrp>
<routingGrp>
<routingInfo>
<routingDetails>
<station>DUS</station>
<qualifier>TC2</qualifier>
</routingDetails>
<routingDetails>
<station>CGN</station>
<qualifier>TC2</qualifier>
</routingDetails>
</routingInfo>
<qualificationOfFare>
<movementType>7EH</movementType>
<discountDetails>
<fareQualifier>MPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<pertinentQuantity>
<quantityDetails>
<qualifier>708</qualifier>
<value>298</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>700</qualifier>
<value>382</value>
<unit>M</unit>
</quantityDetails>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 22 of 41
User guide for function CalculateMileage

<quantityDetails>
<qualifier>714</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>710</qualifier>
<value>84</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>709</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>706</qualifier>
<value>477</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>EMA</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
</pertinentQuantity>
</routingGrp>
<routingGrp>
<routingInfo>
<routingDetails>
<station>CGN</station>
<qualifier>TC2</qualifier>
</routingDetails>
<routingDetails>
<station>ZRH</station>
<qualifier>TC2</qualifier>
</routingDetails>
</routingInfo>
<qualificationOfFare>
<movementType>7EH</movementType>
<discountDetails>
<fareQualifier>TPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<qualificationOfFare>
<movementType>7EH</movementType>
<discountDetails>
<fareQualifier>MPM</fareQualifier>
</discountDetails>
</qualificationOfFare>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 23 of 41
Web services User guide for function CalculateMileage

<pertinentQuantity>
<quantityDetails>
<qualifier>701</qualifier>
<value>245</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>708</qualifier>
<value>543</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>700</qualifier>
<value>579</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>714</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>710</qualifier>
<value>36</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>709</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>706</qualifier>
<value>723</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>EMA</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
</pertinentQuantity>
</routingGrp>
</odiGrp>
</flightDetails>
</Fare_CalculateMileageReply>

Possible Errors

Copyright © 1987-2009 Amadeus IT Group SA.


Page 24 of 41
User guide for function CalculateMileage

Operation: 4. Calculate Mileage with exclude city pair


This example is equivalent to the following cryptic: FQM LON NYC**MSP CHI
Explanations of new information
INPUT
717: code function for CalculateMileage (FQM).
City pair in origDest (ODI): Departure and arrival cities of the journey.
City pair in all routingInfo (RTG): Start and End cities of the trip' segment.
Second routingInfo (RTG) describes the "exclude city pair" case between arrival city of the previous segment
and departure city of the next segment. "EX" qualifier is put to confirm that this segment is excluded of the
CalculateMileage.
OUTPUT
717: code function for CalculateMileage (FQM).
City pair in originDestination (ODI): Departure and arrival cities of the journey.
City pair in routingInfo (RTG): Start and End cities of the segment followed by their area number qualifier.
All M in pertinentQuantity (QTY): mileage based on miles.
701: qualifier for Ticketed Point Mileage (TPM) followed by its value.
700: qualifier for Maximum Permitted Mileage (MPM) followed by its value.
714: qualifier that means that the mileage doesn't exceed the 25% surcharge value.
710: qualifier for Higher Level Mileage followed by its value.
709: qualifier for Lower Level Mileage followed by its value.
706: qualifier for 25 percent premium followed by its value.
708: qualifier for Cumulative mileage (current TPM value added to the previous ones).
EMA: qualifier for Extra mileage addition followed by its value (by default no addition).
In qualificationOfFare (FQU): global direction of the segment for the TPM or MPM mileage calculation
(difference made with the qualifier TPM or MPM at the end of the segment).

Query Structure
<Fare_CalculateMileage>
<msgType>
<messageFunctionDetails>
<messageFunction>717</messageFunction>
</messageFunctionDetails>
</msgType>
<tripDescription>
<origDest>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 25 of 41
Web services User guide for function CalculateMileage

<origin>LON</origin>
<destination>CHI</destination>
</origDest>
<routing>
<routingInfo>
<routingDetails>
<station>LON</station>
<otherStation>NYC</otherStation>
</routingDetails>
</routingInfo>
</routing>
<routing>
<routingInfo>
<routingDetails>
<station>NYC</station>
<otherStation>MSP</otherStation>
<qualifier>EX</qualifier>
</routingDetails>
</routingInfo>
</routing>
<routing>
<routingInfo>
<routingDetails>
<station>MSP</station>
<otherStation>CHI</otherStation>
</routingDetails>
</routingInfo>
</routing>
</tripDescription>
</Fare_CalculateMileage>

Reply Structure
<Fare_CalculateMileageReply>
<transactionType>
<messageFunctionDetails>
<messageFunction>717</messageFunction>
</messageFunctionDetails>
</transactionType>
<flightDetails>
<nbOfSegments/>
<odiGrp>
<originDestination>
<origin>LON</origin>
<destination>CHI</destination>
</originDestination>
<flightErrorText>
<freeTextQualification>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 26 of 41
User guide for function CalculateMileage

<textSubjectQualifier>BCK</textSubjectQualifier>
<informationType>13</informationType>
</freeTextQualification>
<freeText>EMA MAY APPLY - SPECIFY CARRIER/STOP/TRANSFERS </freeText>
</flightErrorText>
<routingGrp>
<routingInfo>
<routingDetails>
<station>LON</station>
<qualifier>TC2</qualifier>
</routingDetails>
<routingDetails>
<station>NYC</station>
<qualifier>TC1</qualifier>
</routingDetails>
</routingInfo>
<qualificationOfFare>
<movementType>7AT</movementType>
<discountDetails>
<fareQualifier>TPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<qualificationOfFare>
<movementType>7AT</movementType>
<discountDetails>
<fareQualifier>MPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<pertinentQuantity>
<quantityDetails>
<qualifier>701</qualifier>
<value>3458</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>708</qualifier>
<value>3458</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>700</qualifier>
<value>4149</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>714</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 27 of 41
Web services User guide for function CalculateMileage

<qualifier>710</qualifier>
<value>691</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>709</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>706</qualifier>
<value>5186</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>EMA</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
</pertinentQuantity>
</routingGrp>
<routingGrp>
<routingInfo>
<routingDetails>
<station>NYC</station>
<qualifier>TC1</qualifier>
</routingDetails>
<routingDetails>
<station>MSP</station>
<qualifier>TC1</qualifier>
</routingDetails>
</routingInfo>
<qualificationOfFare>
<movementType>7AT</movementType>
<discountDetails>
<fareQualifier>MPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<pertinentQuantity>
<quantityDetails>
<qualifier>708</qualifier>
<value>3458</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>700</qualifier>
<value>4813</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 28 of 41
User guide for function CalculateMileage

<qualifier>714</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>710</qualifier>
<value>1355</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>709</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>706</qualifier>
<value>6016</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>EMA</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
</pertinentQuantity>
</routingGrp>
<routingGrp>
<routingInfo>
<routingDetails>
<station>MSP</station>
<qualifier>TC1</qualifier>
</routingDetails>
<routingDetails>
<station>CHI</station>
<qualifier>TC1</qualifier>
</routingDetails>
</routingInfo>
<qualificationOfFare>
<movementType>7US</movementType>
<discountDetails>
<fareQualifier>TPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<qualificationOfFare>
<movementType>7AT</movementType>
<discountDetails>
<fareQualifier>MPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<pertinentQuantity>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 29 of 41
Web services User guide for function CalculateMileage

<quantityDetails>
<qualifier>701</qualifier>
<value>341</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>708</qualifier>
<value>3799</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>700</qualifier>
<value>4743</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>714</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>710</qualifier>
<value>944</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>709</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>706</qualifier>
<value>5928</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>EMA</qualifier>
<value>0</value>
<unit>M</unit>
</quantityDetails>
</pertinentQuantity>
</routingGrp>
</odiGrp>
</flightDetails>
</Fare_CalculateMileageReply>

Possible Errors

Copyright © 1987-2009 Amadeus IT Group SA.


Page 30 of 41
User guide for function CalculateMileage

Operation: 5.CalculateMileage with no Ticketed Permitted Mileage (TPM)


returned
This example is equivalent to the following cryptic: FQM NCE/AAF HKG
Explanations of new information
INPUT
717: code function for CalculateMileage (FQM).
City pair in origDest (ODI): Departure and arrival cities of the journey.
City pair in all routingInfo (RTG): Start and End cities of the trip' segment.
In transportService (TRA): carrier specified for this segment.
OUTPUT
717: code function for CalculateMileage (FQM).
City pair in originDestination (ODI): Departure and arrival cities of the journey.
City pair in routingInfo (RTG): Start and End cities of the trip' segment followed by their area number
qualifier.
M in pertinentQuantity (QTY): mileage based on miles.
700: qualifier for Maximum Permitted Mileage (MPM) followed by its value.
TNF: qualifier meaning that no TPM has been found for the city pair.

Query Structure
<Fare_CalculateMileage>
<msgType>
<messageFunctionDetails>
<messageFunction>717</messageFunction>
</messageFunctionDetails>
</msgType>
<tripDescription>
<origDest>
<origin>NCE</origin>
<destination>HKG</destination>
</origDest>
<routing>
<routingInfo>
<routingDetails>
<station>NCE</station>
<otherStation>HKG</otherStation>
</routingDetails>
</routingInfo>
<transportService>
<companyIdentification>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 31 of 41
Web services User guide for function CalculateMileage

<marketingCompany>AF</marketingCompany>
</companyIdentification>
</transportService>
</routing>
</tripDescription>
</Fare_CalculateMileage>

Reply Structure
<Fare_CalculateMileageReply>
<transactionType>
<messageFunctionDetails>
<messageFunction>717</messageFunction>
</messageFunctionDetails>
</transactionType>
<flightDetails>
<nbOfSegments/>
<odiGrp>
<originDestination>
<origin>NCE</origin>
<destination>HKG</destination>
</originDestination>
<routingGrp>
<routingInfo>
<routingDetails>
<station>NCE</station>
<qualifier>TC2</qualifier>
</routingDetails>
<routingDetails>
<station>HKG</station>
<qualifier>TC3</qualifier>
</routingDetails>
</routingInfo>
<qualificationOfFare>
<movementType>7EH</movementType>
<discountDetails>
<fareQualifier>MPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<pertinentQuantity>
<quantityDetails>
<qualifier>TNF</qualifier>
</quantityDetails>
<quantityDetails>
<qualifier>700</qualifier>
<value>7522</value>
<unit>M</unit>
</quantityDetails>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 32 of 41
User guide for function CalculateMileage

</pertinentQuantity>
</routingGrp>
</odiGrp>
</flightDetails>
</Fare_CalculateMileageReply>

Possible Errors
See "Error Messages" section.

Operation: 6. Display surcharge band for a city pair


This example is equivalent to the following cryptic: FQM*LON LAX
Explanations of new information
INPUT
717: code function for CalculateMileage (FQM).
City pair in origDest (ODI): city pair requested for the surcharge mileage calculation. The base amount of
mileage used for the mileage surcharge band display will be the MPM (Maximum Permitted Mileage)
between these two cities.
City pair in all routingInfo (RTG): city pair requested for the surcharge mileage calculation followed by the
"MTD" qualifier meaning "Mileage Table Display".
OUTPUT
717: code function for CalculateMileage (FQM).
City pair in originDestination (ODI): city pair requested for the surcharge mileage calculation.
City pair in routingInfo (RTG): city pair requested for the surcharge mileage calculation.
All M in pertinentQuantity (QTY): mileage based on miles.
700: qualifier for MPM base amount followed by its value (i.e. the MPM value for the city pair requested).
702: qualifier for 5 percent premium followed by its value (5% of mileage surcharge).
703: qualifier for 10 percent premium followed by its value (10% of mileage surcharge).
704: qualifier for 15 percent premium followed by its value (15% of mileage surcharge).
705: qualifier for 20 percent premium followed by its value (20% of mileage surcharge).
706: qualifier for 25 percent premium followed by its value (25% of mileage surcharge).
In qualificationOfFare (FQU): global direction of the segment for the MPM mileage calculation (always MPM
in this case), followed by the "MPM" qualifier. In case of surcharge band display for a city pair, a global
direction is always mentioned.

Query Structure

Copyright © 1987-2009 Amadeus IT Group SA.


Page 33 of 41
Web services User guide for function CalculateMileage

<Fare_CalculateMileage>
<msgType>
<messageFunctionDetails>
<messageFunction>717</messageFunction>
</messageFunctionDetails>
</msgType>
<tripDescription>
<origDest>
<origin>LON</origin>
<destination>LAX</destination>
</origDest>
<routing>
<routingInfo>
<routingDetails>
<station>LON</station>
<otherStation>LAX</otherStation>
<qualifier>MTD</qualifier>
</routingDetails>
</routingInfo>
</routing>
</tripDescription>
</Fare_CalculateMileage>

Reply Structure
<Fare_CalculateMileageReply>
<transactionType>
<messageFunctionDetails>
<messageFunction>717</messageFunction>
</messageFunctionDetails>
</transactionType>
<flightDetails>
<nbOfSegments/>
<odiGrp>
<originDestination/>
<routingGrp>
<routingInfo/>
<qualificationOfFare>
<movementType>7AT</movementType>
<discountDetails>
<fareQualifier>MPM</fareQualifier>
</discountDetails>
</qualificationOfFare>
<pertinentQuantity>
<quantityDetails>
<qualifier>700</qualifier>
<value>6538</value>
<unit>M</unit>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 34 of 41
User guide for function CalculateMileage

</quantityDetails>
<quantityDetails>
<qualifier>702</qualifier>
<value>6864</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>703</qualifier>
<value>7191</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>704</qualifier>
<value>7518</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>705</qualifier>
<value>7845</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>706</qualifier>
<value>8172</value>
<unit>M</unit>
</quantityDetails>
</pertinentQuantity>
</routingGrp>
</odiGrp>
</flightDetails>
</Fare_CalculateMileageReply>

Possible Errors

Operation: 7. Display surcharge band with mileage amount


This example is equivalent to the following cryptic: FQM*/9126
Explanations of new information
INPUT
717: code function for CalculateMileage (FQM).
In pertinentQuantity (QTY): base mileage amount to calculate the surcharge mileage values with qualifiers
700, meaning "MPM base amount", and M, meaning "Mileage based".
OUTPUT
717: code function for CalculateMileage (FQM).

Copyright © 1987-2009 Amadeus IT Group SA.


Page 35 of 41
Web services User guide for function CalculateMileage

All M in pertinentQuantity (QTY): mileage based on miles.


700: qualifier for MPM base amount followed by its value.
702: qualifier for 5 percent premium followed by its value (5% of mileage surcharge).
703: qualifier for 10 percent premium followed by its value (10% of mileage surcharge).
704: qualifier for 15 percent premium followed by its value (15% of mileage surcharge).
705: qualifier for 20 percent premium followed by its value (20% of mileage surcharge).
706: qualifier for 25 percent premium followed by its value (25% of mileage surcharge).

Query Structure
<Fare_CalculateMileage>
<msgType>
<messageFunctionDetails>
<messageFunction>717</messageFunction>
</messageFunctionDetails>
</msgType>
<tripDescription>
<origDest/>
<routing>
<routingInfo/>
<pertinentQuantity>
<quantityDetails>
<qualifier>700</qualifier>
<value>9126</value>
<unit>M</unit>
</quantityDetails>
</pertinentQuantity>
</routing>
</tripDescription>
</Fare_CalculateMileage>

Reply Structure
<Fare_CalculateMileageReply>
<transactionType>
<messageFunctionDetails>
<messageFunction>717</messageFunction>
</messageFunctionDetails>
</transactionType>
<flightDetails>
<nbOfSegments/>
<odiGrp>
<originDestination/>
<routingGrp>
<routingInfo/>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 36 of 41
User guide for function CalculateMileage

<pertinentQuantity>
<quantityDetails>
<qualifier>700</qualifier>
<value>9126</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>702</qualifier>
<value>9582</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>703</qualifier>
<value>10038</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>704</qualifier>
<value>10494</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>705</qualifier>
<value>10951</value>
<unit>M</unit>
</quantityDetails>
<quantityDetails>
<qualifier>706</qualifier>
<value>11407</value>
<unit>M</unit>
</quantityDetails>
</pertinentQuantity>
</routingGrp>
</odiGrp>
</flightDetails>
</Fare_CalculateMileageReply>

Possible Errors

Operation: 8. Display surcharge band with currency amount


This example is equivalent to the following cryptic: FQM*JPY25000.
Explanations of new information
INPUT
717: code function for CalculateMileage (FQM).

Copyright © 1987-2009 Amadeus IT Group SA.


Page 37 of 41
Web services User guide for function CalculateMileage

In monetaryInfo (MON): qualifier CUR, meaning "Currency Surcharge" followed by base currency amount to
calculate the surcharge currency values and the currency code (in this case JPY).
OUTPUT
717: code function for CalculateMileage (FQM).
In monetaryRates (MON):0P: qualifier for currency base amount (used to calculated currency surcharges)
followed by its value and the currency code.The currency code is just set with the base currency amount
since it's the same currency code for all the surcharges' values.
5P: qualifier for 5 percent surcharge followed by its value.
10P: qualifier for 10 percent surcharge followed by its value.
15P: qualifier for 15 percent surcharge followed by its value.
20P: qualifier for 20 percent surcharge followed by its value.
25P: qualifier for 25 percent surcharge followed by its value.

Query Structure
<Fare_CalculateMileage>
<msgType>
<messageFunctionDetails>
<messageFunction>717</messageFunction>
</messageFunctionDetails>
</msgType>
<monetaryInfo>
<monetaryDetails>
<typeQualifier>CUR</typeQualifier>
<amount>25000</amount>
<currency>JPY</currency>
</monetaryDetails>
</monetaryInfo>
</Fare_CalculateMileage>

Reply Structure
<Fare_CalculateMileageReply>
<transactionType>
<messageFunctionDetails>
<messageFunction>717</messageFunction>
</messageFunctionDetails>
</transactionType>
<flightDetails>
<nbOfSegments/>
<priceInfo>
<monetaryRates>
<monetaryDetails>
<typeQualifier>0P</typeQualifier>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 38 of 41
User guide for function CalculateMileage

<amount>25000</amount>
<currency>JPY</currency>
</monetaryDetails>
<monetaryDetails>
<typeQualifier>5P</typeQualifier>
<amount>26300</amount>
</monetaryDetails>
<monetaryDetails>
<typeQualifier>10P</typeQualifier>
<amount>27500</amount>
</monetaryDetails>
<monetaryDetails>
<typeQualifier>15P</typeQualifier>
<amount>28800</amount>
</monetaryDetails>
<monetaryDetails>
<typeQualifier>20P</typeQualifier>
<amount>30000</amount>
</monetaryDetails>
<monetaryDetails>
<typeQualifier>25P</typeQualifier>
<amount>31300</amount>
</monetaryDetails>
</monetaryRates>
</priceInfo>
</flightDetails>
</Fare_CalculateMileageReply>

Possible Errors

Operation: 9. Display surcharge band with mileage and currency amounts


This example is equivalent to the following cryptic: FQM*/9126*JPY25000.
Explanations of new information
INPUT
717: code function for CalculateMileage (FQM).
In monetaryInfo (MON): qualifier CUR, meaning "Currency Surcharge" followed by base currency amount to
calculate the surcharge currency values and the currency code (in this case JPY).
In pertinentQuantity (QTY): base mileage amount to calculate the surcharge mileage values with qualifiers
700, meaning "MPM base amount", and M, meaning "Mileage based".
OUTPUT
717: code function for CalculateMileage (FQM).
In monetaryRates (MON):0P: qualifier for currency base amount (used to calculated currency surcharges)

Copyright © 1987-2009 Amadeus IT Group SA.


Page 39 of 41
Web services User guide for function CalculateMileage

followed by its value and the currency code. The currency code is just set with the base currency amount
since it's the same currency code for all the surcharges' values.
5P: qualifier for 5 percent surcharge followed by its value.
10P: qualifier for 10 percent surcharge followed by its value.
15P: qualifier for 15 percent surcharge followed by its value.
20P: qualifier for 20 percent surcharge followed by its value.
25P: qualifier for 25 percent surcharge followed by its value.
All M in pertinentQuantity (QTY): mileage based on miles.
700: qualifier for MPM base amount followed by its value.
702: qualifier for 5 percent premium followed by its value (5% of mileage surcharge).
703: qualifier for 10 percent premium followed by its value (10% of mileage surcharge).
704: qualifier for 15 percent premium followed by its value (15% of mileage surcharge).
705: qualifier for 20 percent premium followed by its value (20% of mileage surcharge).
706: qualifier for 25 percent premium followed by its value (25% of mileage surcharge).

Query Structure
<Fare_CalculateMileage>
<msgType>
<messageFunctionDetails>
<messageFunction>717</messageFunction>
</messageFunctionDetails>
</msgType>
<monetaryInfo>
<monetaryDetails>
<typeQualifier>CUR</typeQualifier>
<amount>25000</amount>
<currency>JPY</currency>
</monetaryDetails>
</monetaryInfo>
</Fare_CalculateMileage>

Reply Structure
<Fare_CalculateMileageReply>
<transactionType>
<messageFunctionDetails>
<messageFunction>717</messageFunction>
</messageFunctionDetails>
</transactionType>
<flightDetails>
<nbOfSegments/>

Copyright © 1987-2009 Amadeus IT Group SA.


Page 40 of 41
User guide for function CalculateMileage

<priceInfo>
<monetaryRates>
<monetaryDetails>
<typeQualifier>0P</typeQualifier>
<amount>25000</amount>
<currency>JPY</currency>
</monetaryDetails>
<monetaryDetails>
<typeQualifier>5P</typeQualifier>
<amount>26300</amount>
</monetaryDetails>
<monetaryDetails>
<typeQualifier>10P</typeQualifier>
<amount>27500</amount>
</monetaryDetails>
<monetaryDetails>
<typeQualifier>15P</typeQualifier>
<amount>28800</amount>
</monetaryDetails>
<monetaryDetails>
<typeQualifier>20P</typeQualifier>
<amount>30000</amount>
</monetaryDetails>
<monetaryDetails>
<typeQualifier>25P</typeQualifier>
<amount>31300</amount>
</monetaryDetails>
</monetaryRates>
</priceInfo>
</flightDetails>
</Fare_CalculateMileageReply>

Possible Errors

Copyright © 1987-2009 Amadeus IT Group SA.


Page 41 of 41

You might also like