UG WBS Fare MasterPricerTravelBoardSearch 16.1

Web Services User's Guide

Fare_MasterPricerTravelBoardSearch 16.1

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

Table of Contents

Table of Contents Preface.............................. Preface .............................................................. ................................................................. .................................................................. ................................. 18 1 Purpose of this document............................................................................................18 document............................................................................................18 2 Intended Audience............................. Audience.............................................................. ................................................................. ......................................... ......... 18 3 Associated Documents................................. Documents................................................................. ............................................................... ............................... 18 4 Structure of this document...........................................................................................18 document...........................................................................................18 Function: Fare_ MasterPricerTravelBoardSearch MasterPricerTravelBoardSearch................................................................20 ................................................................20 1 Overview.... Overview................................. .................................................................................................................. ..................................................................................... 20 1.1 Supported Supported Operations...... Operations.................................... ............................................................... ....................................................... ...................... 22 1.2 Limitations..............................................................................................................29 Limitations..............................................................................................................29 1.3 Unsupported Operations....................................................................................... Operations....................................................................................... 29 1.4 Prerequisites..........................................................................................................30 Prerequisites..........................................................................................................30 2 Building A Query..........................................................................................................31 Query..........................................................................................................31 3 Receiving A Reply............................... Reply................................................................ .................................................................. ....................................... ...... 36 3.1 Reply Sub Structure: Free Baggage Allowance 1 - freeBagAllowanceGrp....... freeBagAllowanceGrp........... .... 70 3.1.1 Description................................................................................................................................... Description................................................................................................................................... 70 3.1.2 Xml Structure............................................................................................................................... Structure............................................................................................................................... 70

3.2 Reply Sub Structure: Free Baggage Allowance 2 - serviceCoverageInfoGrp..... serviceCoverageInfoGrp..... 71 3.2.1 Description................................................................................................................................... Description................................................................................................................................... 71 3.2.2 Xml Structure............................................................................................................................... Structure............................................................................................................................... 71

3.3 Reply Sub Structure: Free Baggage Allowance 3 - segmentFlightRef ..................72 ..................72 3.3.1 Description................................................................................................................................... Description................................................................................................................................... 72 3.3.2 Xml Structure............................................................................................................................... Structure............................................................................................................................... 72

4 Error Messages............................................................................................................74 Messages............................................................................................................74 4.1 Error Reply................................. Reply.................................................................. ................................................................. .......................................... .......... 78 5 Operations....................................................................................................................79 Operations....................................................................................................................79 5.1 Operation: 01 - Search With Mandatory Elements............................................... Elements............................................... 79 5.1.1 Quer y Structure.................................. Structure........................................................................................................................... ......................................................................................... 82 5.1.2 Reply Reply Structure.. Structure............................................................................................................................ .......................................................................................................................... 83 5.1.3 Possible Errors.................................................................... Errors............................................................................................................................ ........................................................ 83 i

Table of Contents

5.2 Operation: 02.01 Flight Option - Airline/Alliance (Include/Exclude).......................87 (Include/Exclude).......................87 5.2.1 Query Structure........................................................................................................................... Structure........................................................................................................................... 87 5.2.2 Reply Structure............................................................................................................................ Structure............................................................................................................................ 89 5.2.3 Possible Errors............................................................................................................................ Errors............................................................................................................................ 89

5.3 Operation: 02.02 Flight Option - Flight Category............................. Category.................................................. ..................... 91 5.3.1 Query Structure........................................................................................................................... Structure........................................................................................................................... 92 5.3.2 Reply Structure............................................................................................................................ Structure............................................................................................................................ 93 5.3.3 Possible Possible Errors..................... Errors............................................................................................................................ ....................................................................................................... 93

5.4 Operation: Operation: 02.03 Flight Option Option - Connection Point........ Point............... .............. ............... ............... .............. .......... ... 94 5.4.1 Query Structure Structure..................... ........................................................................................................................... ...................................................................................................... 96 5.4.2 Reply Structure Reply Structure............................................................................................................................ ............................................................................................................................ 97 5.4.3 Possible Possible Errors..................... Errors............................................................................................................................ ....................................................................................................... 97

5.5 Operation: Operation: 02.04 Flight Option Option - Multicity............................................................. Multicity............................................................. 98 5.5.1 Query Structure Structure..................... ......................................................................................................................... .................................................................................................... 100 5.5.2 Reply Structure Reply Structure......................................................................................................... .......................................................................................................................... ................. 101 5.5.3 Possible Possible Errors..................... Errors.......................................................................................................................... ..................................................................................................... 101

5.6 Operation: Operation: 02.05 Flight Option Option - Origin Destination Area................................... Area................................... 103 5.6.1 Query Structure Structure..................... ......................................................................................................................... .................................................................................................... 105 5.6.2 Reply Structure Reply Structure......................................................................................... .......................................................................................................................... ................................. 106 5.6.3 Possible Possible Errors..................... Errors.......................................................................................................................... ..................................................................................................... 106

5.7 Operation: Operation: 02.06 Flight Option Option - No Slice and Dice............................................108 Dice............................................108 5.7.1 Query Structure Structure..................... ......................................................................................................................... .................................................................................................... 108 5.7.2 Reply Structure Reply Structure................................................................................................... .......................................................................................................................... ....................... 109 5.7.3 Possible Possible Errors..................... Errors.......................................................................................................................... ..................................................................................................... 109

5.8 Operation: Operation: 02.07 Flight Option Option - Disable Biased Preference....... Preference............... ............... .............. ......... 110 5.8.1 Query Structure Structure..................... ......................................................................................................................... .................................................................................................... 110 5.8.2 Reply Structure Reply Structure...................................................................... .......................................................................................................................... .................................................... 111 5.8.3 Possible Possible Errors..................... Errors.......................................................................................................................... ..................................................................................................... 111

5.9 Operation: Operation: 02.081 Flight Option Option - Ticketless Access Carriers recommendation recommendation..112 ..112 5.9.1 Query Structure Structure..................... ......................................................................................................................... .................................................................................................... 112 5.9.2 Reply Structure Reply Structure....................................................................................... .......................................................................................................................... ................................... 114 5.9.3 Possible Possible Errors..................... Errors.......................................................................................................................... ..................................................................................................... 125 ii

Table of Contents

5.10 Operation: 02.082 Flight Option - Exclude Ticketless Access Carriers....... Carriers............. ...... 126 5.10.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 126 5.10.2 Reply Structure........................................................................................................................ Structure........................................................................................................................ 127 5.10.3 Possible Errors........................................................................................................................ Errors........................................................................................................................ 127

5.11 Operation: 02.09 Flight Option - Ignore Availability.......................................... Availability.......................................... 128 5.11.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 128 5.11.2 Reply Structure........................................................................................................................ Structure........................................................................................................................ 128 5.11.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 129

5.12 Operation: Operation: 02.10 Flight Option Option - Number of Connections.................................130 Connections.................................130 5.12.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 130 5.12.2 Reply Reply Structure.................................................................................................................... Structure........................................................................................................................ .... 131 131 5.12.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 131

5.13 Operation: Operation: 02.11 Flight Option Option - Online Option at Itinerary Level..................... Level..................... 132 5.13.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 132 5.13.2 Reply Reply Structure.................................................................................. Structure........................................................................................................................ ...................................... 133 5.13.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 133

5.14 Operation: Operation: 02.12 Flight Option Option - Online Option at Requested Segment Level...134 Level...134 5.14.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 134 5.14.2 Reply Reply Structure..................................................................... Structure........................................................................................................................ ................................................... 135 5.14.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 135

5.15 Operation: Operation: 02.13 Flight option option - Interline.......................................................... Interline.......................................................... 136 5.15.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 136 5.15.2 Reply Reply Structure........................................................................................................................ Structure........................................................................................................................ 137 5.15.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 137

5.16 Operation: Operation: 02.14 Flight option option - Maximum EFT................................................138 EFT................................................138 5.16.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 138 5.16.2 Reply Reply Structure.................................................................................................................. Structure........................................................................................................................139 ...... 139 5.16.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 139

5.17 Operation: Operation: 02.15 Flight option option - Maximum layover per connection....... connection.............. ............ ..... 140 5.17.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 140 5.17.2 Reply Reply Structure.................................................................................................... Structure........................................................................................................................ .................... 141 5.17.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 141 iii

Table of Contents

5.18 Operation: 02.16 Flight option - Total Maximum layover .............. ...................... ............... ............ ..... 142 5.18.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 142 5.18.2 Reply Structure........................................................................................................................ Structure........................................................................................................................ 143 5.18.3 Possible Errors........................................................................................................................ Errors........................................................................................................................ 143

5.19 Operation: 02.17 Flight option - RDI: Radius/multicity at itinerary level............ ............ 144 5.19.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 144 5.19.2 Reply Structure........................................................................................................................ Structure........................................................................................................................ 145 5.19.3 Possible Possible Errors........................................................................................................................ Errors........................................................................................................................ 145

5.20 Operation: Operation: 02.18 Flight option - IR: Radius/multicity at requested segment level.................. level ................................................. .............................................................. ............................................................... ................................................... ................... 146 5.20.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 146 5.20.2 Reply 5.20.2 Reply Structure........................................................................................................................ Structure........................................................................................................................ 147 5.20.3 Possible Possible Errors........................................................................................................................ Errors........................................................................................................................ 165

5.21 Operation: Operation: 02.20 Flight option option - No airport change at itinerary level.................166 level.................166 5.21.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 166 5.21.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 167 5.21.3 Possible 5.21.3 Possible Errors............................. Errors........................................................................................................................ ........................................................................................... 167

5.22 Operation: 02.21 Flight option - No airport change at requested segment level. level. 168 5.22.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 168 5.22.2 Reply Structure........................................................................................................................ Structure........................................................................................................................ 169 5.22.3 Possible Errors........................................................................................................................ Errors........................................................................................................................ 169

5.23 Operation: 02.22 Duplicated recommendations: Keep solutions with more ground time at last connecting connecting point.......... point............................................................................................ .................................................................................. 170 5.23.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 170 5.23.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 171 5.23.3 Possible Possible Errors....................................................................................................................... Errors........................................................................................................................ 171

5.24 Operation: Operation: 02.23 Duplicated Duplicated recommendations: Keep the best solutions per major flight.................. flight ................................................. .................................................................................................................172 ..................................................................................172 5.24.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 172 5.24.2 Reply 5.24.2 Reply Structure........................................................................................................................ Structure........................................................................................................................ 173 5.24.3 Possible Possible Errors........................................................................................................................ Errors........................................................................................................................ 173

5.25 Operation: Operation: 02.24 Flight option option - City or Airport Indicator at itinerary level....... level......... .. 174 iv

Table of Contents

5.25.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 174 5.25.2 Reply Structure........................................................................................................................ Structure........................................................................................................................ 175 5.25.3 Possible Errors........................................................................................................................ Errors........................................................................................................................ 175

5.26 Operation: 02.25 Flight Option - Anchored Search (Basic mode).....................176 mode).....................176 5.26.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 176 5.26.2 Reply Structure........................................................................................................................ Structure........................................................................................................................ 178 5.26.3 Possible Errors........................................................................................................................ Errors........................................................................................................................ 178

5.27 Operation: Operation: 02.26 Flight Option Option - Anchored Search (Full mode without technical stop).................. stop) ................................................. ................................................................................................................ ................................................................................. 179 5.27.1 Query Query Structure....................................................................................................................... Structure....................................................................................................................... 179 5.27.2 Reply Structure Reply Structure.................... ........................................................................................................................ .................................................................................................... 182 5.27.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 182

5.28 Operation: Operation: 02.27 Flight Option - Anchored Search (Full mode with technical stops).............. stops) ....................................................................................................... ...................................................................................................................183 ..........................183 5.28.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 183 5.28.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 188 5.28.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 188

5.29 Oper ation: ation: 02.28 Flight Option - More Overnights................................. Overnights............................................ ........... 189 5.29.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 189 5.29.2 Reply Structure........................................................................................................................ Structure........................................................................................................................ 190 5.29.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 190

5.30 Oper ation: ation: 02.29 Flight Option - Search with Point of Commencement Commencement............191 ............191 5.30.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 191 5.30.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 192 5.30.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 192

5.31 Operati Operation: on: 02.30 Flight Option - Search with CLID...........................................193 CLID...........................................193 5.31.1 Query Query Structure....................................................................................................................... Structure....................................................................................................................... 193 5.31.2 Reply Structure Reply Structure.................... ........................................................................................................................ .................................................................................................... 195 5.31.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 200

5.32 Operation: Operation: 02.31 Flight Option Option - DK number (customer identification)..............201 identification)..............201 5.32.1 Quer 5.32.1 Quer y Structure....................................................................................................................... Structure....................................................................................................................... 201 5.32.2 Reply Reply Structure........................................................................................................................ Structure........................................................................................................................ 202 v

Table of Contents

5.32.3 Possible Errors........................................................................................................................ Errors........................................................................................................................ 202

5.33 Operation: 02.32 Flight Option - Progressive legs............................................203 legs............................................203 5.33.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 204 5.33.2 Reply Structure........................................................................................................................ Structure........................................................................................................................ 205 5.33.3 Possible Errors........................................................................................................................ Errors........................................................................................................................ 205

5.34 Operation: 03.1 Time Option - Time of Departure/Arrival................................. Departure/Arrival................................. 206 5.34.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 207 5.34.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 208 5.34.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 208

5.35 Oper ation: ation: 03.2 Time Option - Time Window................... Window................................................... ................................ 209 5.35.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 210 5.35.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 211 5.35.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 212

5.36 Oper ation: ation: 03.3 Time Option - Range Of Dates........................................... Dates............................................... .... 213 5.36.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 214 5.36.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 215 5.36.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 215

5.37 Oper ation: ation: 03.4 Time Option - Time at destination...................... destination...........................................216 .....................216 5.37.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 216 5.37.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 217 5.37.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 217

5.38 Oper ation: ation: 04.01 Fare Option - Currency Conversion............. Conversion...................................... ......................... 218 5.38.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 218 5.38.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 219 5.38.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 219

5.39 Oper ation: ation: 04.02 Fare Option - Selling Ticketing Cities Override Override..................... ..................... 221 5.39.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 221 5.39.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 222 5.39.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 223

5.40 Oper ation: ation: 04.03 Fare Option - Price To Beat................ Beat..................................................224 ..................................224 5.40.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 224 5.40.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 225 vi

Table of Contents


5.41 Operation: 04.04 Fare Option - Split / No Split PNR.........................................227 PNR.........................................227 5.41.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 227 5.41.2 Reply Structure........................................................................................................................ Structure........................................................................................................................ 229 5.41.3 Possible Errors........................................................................................................................ Errors........................................................................................................................ 229

5.42 Operation: 04.05 Fare Option - Type of Ticket (Electronic/Paper Ticket)..........230 Ticket)..........230 5.42.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 230 5.42.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 231 5.42.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 232

5.43 Oper ation: ation: 04.06 Fare Option - Unifare................................. Unifare............................................................ ........................... 233 5.43.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 234 5.43.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 235 5.43.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 235

5.44 Oper ation: ation: 04.07 Fare Option - Expanded Parameter ......................................236 ...................................... 236 5.44.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 236 5.44.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 237 5.44.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 237

5.45 Oper ation: ation: 04.08 Fare Option - My Search - Fare Families..............................2 Families..............................239 39 5.45.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 242 5.45.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 247 5.45.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 247

5.46 Oper ation: ation: 04.09 Fare Option - Multi Office IDs - Default Distribution.. Distribution...............249 .............249 5.46.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 250 5.46.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 251 5.46.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 257

5.47 Oper ation: ation: 04.10 Fare Option - Multi Office IDs - Even Distribution Distribution..................260 ..................260 5.47.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 260 5.47.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 262 5.47.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 262

5.48 Oper ation: ation: 04.11 Fare Option - Multi Office IDs - Weighted Weighted Distribution...........263 Distribution...........263 5.48.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 263 5.48.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 266 vii

Table of Contents


5.49 Operation: 04.12 Fare Option - Identify YQ/YR tax amounts in Output.............267 Output.............267 5.49.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 267 5.49.2 Reply Structure........................................................................................................................ Structure........................................................................................................................ 268 5.49.3 Possible Errors........................................................................................................................ Errors........................................................................................................................ 268

5.50 Operation: 04.13 Fare Option - Price only PTC................................................269 PTC................................................269 5.50.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 269 5.50.2 Reply Structure Reply Structure.................... ........................................................................................................................ .................................................................................................... 270 5.50.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 270

5.51 Operation: Operation: 04.14 Fare Option Option - My Search - Distribution ratio of recommendations per Fare Family Family................................................................................................................ 271 271 5.51.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 271 5.51.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 273 5.51.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 274

5.52 Operation: Operation: 04.15 Fare Option - My Search - Resulting Fare Families at requested at requested segment level. level....................................................................................................................275 5.52.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 275 5.52.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 277 5.52.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 277

5.53 Operation: Operation: 04.16 Fare Option - My Search - Distribution Distribution ratio of recommendations per Fare Family Family at requested segment Level.................................................................. Level.................................................................. 279 5.53.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 279 5.53.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 283 5.53.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 283

5.54 Operation: Operation: 04.17 04.17 Fare Option - My Search - Distribution ratio of recommendations per Fare Family Family at requested segment level (Usage at itinerary level)............................285 level)............................285 5.54.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 285 5.54.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 288 5.54.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 288

5.55 Operation: Operation: 04.18 Fare Option - Currency for Fare Selection option..................289 option..................289 5.55.1 Query Query Structure....................................................................................................................... Structure....................................................................................................................... 289 5.55.2 Reply Structure Reply Structure.................... ........................................................................................................................ .................................................................................................... 290 5.55.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 290 viii

Table of Contents

5.56 Operation: 04.19 Fare Option - Currency for Fare Selection with Currency Conversion option.............................................................................................................291 option.............................................................................................................291 5.56.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 291 5.56.2 Reply Structure........................................................................................................................ Structure........................................................................................................................ 292 5.56.3 Possible Errors........................................................................................................................ Errors........................................................................................................................ 292

5.57 Operation: 04.20 Fare Option - Multi-Ticket......................................................293 Multi-Ticket......................................................293 5.57.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 293 5.57.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 294 5.57.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 315

5.58 Oper ation: ation: 04.22 Fare Option - Ticketing date................... date................................................. .............................. 316 5.58.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 316 5.58.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 317 5.58.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 317

5.59 Oper ation: ation: 04.23 Fare Option - Solution Family................ Family............................................... ............................... 318 5.59.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 318 5.59.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 319 5.59.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 331

5.60 Oper ation: ation: 04.24 Fare Option - Disable Negotiated Space Space...............................332 ...............................332 5.60.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 332 5.60.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 333 5.60.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 333

5.61 Oper ation: ation: 04.25 Fare Option - Open Return...................................... Return.............................................. ............. ..... 334 5.61.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 334 5.61.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 335 5.61.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 353

5.62 Oper ation: ation: 04.26 Fare Option - Alternate Price.................. Price................................................ .............................. 354 5.62.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 355 5.62.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 357 5.62.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 371

5.63 Oper ation: ation: 04.27 Fare Option - Search by FBA............... FBA................................................372 .................................372 5.63.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 372 5.63.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 373 ix

Table of Contents


5.64 Operation: 05.1 Cabin Option - Mandatory Cabin.............................................375 Cabin.............................................375 5.64.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 376 5.64.2 Reply Structure........................................................................................................................ Structure........................................................................................................................ 377 5.64.3 Possible Errors........................................................................................................................ Errors........................................................................................................................ 377

5.65 Operation: 05.2 Cabin Option - Recommended Cabin..................................... Cabin..................................... 378 5.65.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 378 5.65.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 379 5.65.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 379

5.66 Oper ation: ation: 05.3 Cabin Option - Major Cabin.................................................... Cabin.................................................... 380 5.66.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 380 5.66.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 382 5.66.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 382

5.67 Oper ation: ation: 06.1 Fee Option - Pricing Scheme Reference........................ Reference.................................383 .........383 5.67.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 383 5.67.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 385 5.67.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 393

5.68 Oper ation: ation: 06.2 Fee Option - Form of Payment.............................. Payment............................................... ................. 394 5.68.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 394 5.68.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 396 5.68.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 396

5.69 Oper ation: ation: 06.3 Fee Option - Sorting with/without Fees..... Fees............ .............. ............... ............... ......... 397 5.69.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 397 5.69.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 398 5.69.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 398

5.70 Oper ation: ation: 06.4 Fee Option - Exempt all airline ticketing fees........... fees..........................400 ...............400 5.70.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 400 5.70.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 401 5.70.3 Possible Possible Errors...................... Errors........................................................................................................................ .................................................................................................. 401

5.71 Oper ation: ation: 06.5 Fee Option - Add/Exempt airline ticketing ticketing fees by sub-code.. sub-code.... 402 402 5.71.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 402 5.71.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 404 x

Table of Contents


5.72 Operation: 06.6 Fee Option - Estimated FOP fees...........................................405 fees...........................................405 5.72.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 405 5.72.2 Reply Structure........................................................................................................................ Structure........................................................................................................................ 406 5.72.3 Possible Errors........................................................................................................................ Errors........................................................................................................................ 411

5.73 Operation: 07.1 Distribution Option - Airline Distribution: ADI...........................412 ADI...........................412 5.73.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 412 5.73.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 413 5.73.3 Possible Possible Errors........................................................................................................................ Errors........................................................................................................................ 413

5.74 Operation: Operation: 07.2 Distribution Distribution Option - Airline Distribution Container: ADC.........414 ADC.........414 5.74.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 414 5.74.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 415 5.74.3 Possible Possible Errors........................................................................................................................ Errors........................................................................................................................ 415 415

5.75 Operation: Operation: 07.3 Distribution Distribution option - Direct Distribution DDI.............................416 DDI.............................416 5.75.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 416 5.75.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 417 5.75.3 Possible Possible Errors........................................................................................................................ Errors........................................................................................................................ 417 417

5.76 Oper ation: ation: 07.4 Distribution Distribution option - Not DDI: Deactivation of Direct Distribution........ Distribution ....................................... ................................................................................................................ ................................................................................. 418 5.76.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 418 5.76.2 Reply 5.76.2 Reply Structure Structure........................................................................................................................ ........................................................................................................................ 419 5.76.3 Possible Possible Errors........................................................................................................................ Errors........................................................................................................................ 419

5.77 Operation: Operation: 07.5 Distribution Distribution option - Deactivation of ADI distribution................420 distribution................420 5.77.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 420 5.77.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 421 5.77.3 Possible Possible Errors......................................................................................................... Errors........................................................................................................................ ............... 421

5.78 Operation: Operation: 07.6 Distribution Distribution option - Mono-Main Carrier Distribution................422 Distribution................422 5.78.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 422 5.78.2 Reply Structure Reply Structure..................... ........................................................................................................................ ................................................................................................... 423 5.78.3 Possible Possible Errors........................................................................................................................ Errors........................................................................................................................ 423

5.79 Operation: Operation: 07.7 Distribution Distribution Option - Ratios for Weighted Recommendations.. Recommendations.. 424 5.79.1 Quer y Structure.................... Structure....................................................................................................................... ................................................................................................... 424 xi

Table of Contents

5.79.2 Reply Structure........................................................................................................................ Structure........................................................................................................................ 425 5.79.3 Possible Errors........................................................................................................................ Errors........................................................................................................................ 426

5.80 Operation: 07.8 Distribution Option - Non-Stop Preferred................................ Preferred................................ 427 5.80.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 427 5.80.2 Reply Structure........................................................................................................................ Structure........................................................................................................................ 428 5.80.3 Possible Errors........................................................................................................................ Errors........................................................................................................................ 428

5.81 Operation: 08.01 Output Option - Empty Cells Clarification..............................429 Clarification..............................429 5.81.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 429 5.81.2 Reply Reply Structure........................................................................................................................ Structure........................................................................................................................ 430 5.81.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 430

5.82 Operation: Operation: 08.02 Output Option Option - Rank in Journey Server .............. ...................... ............... ......... .. 431 5.82.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 431 5.82.2 Reply Reply Structure...................................................................................................... Structure........................................................................................................................ .................. 432 5.82.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 432

5.83 Operation: Operation: 08.03 Output Option Option - Value Search at itinerary level....... level.............. .............. ....... 433 5.83.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 434 5.83.2 Reply Reply Structure....................................................................................................................... Structure........................................................................................................................436 . 436 5.83.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 450

5.84 Operation: Operation: 08.04 Output Option Option - Value Search at requested segment level... level... 451 5.84.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 451 5.84.2 Reply Reply Structure........................................................................................................................ Structure........................................................................................................................ 453 5.84.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 467

5.85 Operation: Operation: 08.05 Output Option Option - Display Minimum/Maximum Stay.................468 Stay.................468 5.85.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 468 5.85.2 Reply Reply Structure.................................................................................................................. Structure........................................................................................................................469 ...... 469 5.85.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 474

5.86 Operation: Operation: 08.07 Output Option Option - Fare Family information....... information............... ............... .............. ......... .. 475 5.86.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 476 5.86.2 Reply Reply Structure...................................................................................................... Structure........................................................................................................................ .................. 477 5.86.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 485

5.87 Operation: Operation: 08.08 Output Option Option - Return flight duration at segment level.........486 level.........486 5.87.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 486 xii

Table of Contents


5.88 Operation: 08.09 Output Option - Commission returned...................................494 returned...................................494 5.88.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 494 5.88.2 Reply Structure........................................................................................................................ Structure........................................................................................................................ 495 5.88.3 Possible Errors........................................................................................................................ Errors........................................................................................................................ 503

5.89 Operation: 08.10 Output Option - Ticketing Point Mileage................................504 Mileage................................504 5.89.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 504 5.89.2 Reply Reply Structure........................................................................................................................ Structure........................................................................................................................ 505 5.89.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 509

5.90 Operation: Operation: 08.11 Output option option - Return Airline Alliance....... Alliance.............. ............... ............... ............ ..... 510 5.90.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 510 5.90.2 Reply Reply Structure........................................................................................ Structure........................................................................................................................ ................................ 511 5.90.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 515

5.91 Operation: Operation: 08.12 Output Option Option : Homegeneous Upsell...................................516 Upsell...................................516 5.91.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 522 5.91.2 Reply Reply Structure............................................................................................ Structure........................................................................................................................ ............................ 524 5.91.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 524

5.92 Operation: Operation: 08.13 Output Option : Upsell per bound..........................................525 bound..........................................525 5.92.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 531 5.92.2 Reply Reply Structure......................................................................................... Structure........................................................................................................................ ............................... 533 5.92.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 533

5.93 Operation: Operation: 09.01 Output Option Option - Change Of Gauge....................................... Gauge....................................... 534 5.93.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 548 5.93.2 Reply Reply Structure.................................................................................................. Structure........................................................................................................................ ...................... 549 5.93.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 549

5.94 Operation: Operation: 09.02 Output Option - Fare Calculation.......................................... Calculation.......................................... 550 5.94.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 550 5.94.2 Reply Reply Structure.................................................................................................. Structure........................................................................................................................ ...................... 551 5.94.3 Possible Possible Errors..................... Errors........................................................................................................................ ................................................................................................... 567

5.95 Operation: Operation: 09.03 Output Option Option - Negotiated Space Availability Indicator ........568 ........568 5.95.1 Quer y Structure..................... Structure....................................................................................................................... .................................................................................................. 568 xiii

Table of Contents


5.96 Operation: 09.04 Output Option - In-Flight Services.........................................577 Services.........................................577 5.96.1 Query Structure....................................................................................................................... Structure....................................................................................................................... 577 5.96.2 Reply Structure........................................................................................................................ Structure........................................................................................................................ 578 5.96.3 Possible Errors........................................................................................................................ Errors........................................................................................................................ 581

5.97 Operation: 10.01 Ancillary Services option - Request All Fees.........................582 Fees.........................582 5.97.1 Query Structure 5.97.1 Query Structure....................................................................................................................... ....................................................................................................................... 582 5.97.2 Reply Reply Structure........................................................................................................................ Structure........................................................................................................................ 583 5.97.3 Possible Possible Errors....................... Errors........................................................................................................................ ................................................................................................. 583

5.98 Operation: Operation: 10.02 Ancillary Services option - Global pulled mode....... mode.............. .............. ....... 584 5.98.1 Quer y Structure....................... Structure....................................................................................................................... ................................................................................................ 584 5.98.2 Reply Reply Structure........................................................................................................................ Structure........................................................................................................................ 585 5.98.3 Possible Possible Errors....................... Errors........................................................................................................................ ................................................................................................. 585

5.99 Operation: Operation: 10.03 Ancillary Services option - Request a service sub-code........586 sub-code........586 5.99.1 Quer y Structure....................... Structure....................................................................................................................... ................................................................................................ 586 5.99.2 Reply 5.99.2 Reply Structure........................................................................................................................ Structure........................................................................................................................ 587 5.99.3 Possible Possible Errors........................................................................................................................ Errors........................................................................................................................ 587

5.100 Oper ation: ation: 10.04 Ancillary Services Ancillary Services option - Inclusion/Exclusion option....... option......... .. 588 5.100.1 Query Query Structure.................... Structure..................................................................................................................... ................................................................................................. 588 5.100.2 Reply Reply Structure..................... Structure...................................................................................................................... ................................................................................................. 589 5.100.3 Possible Possible Errors...................................................................................................................... Errors...................................................................................................................... 589

5.101 Oper ation: ation: 10.05 Ancillary Ancillary Services option - pulled/pushed mode at sub-code level.................. level ................................................. .............................................................. ............................................................... ................................................... ................... 590 5.101.1 Query Query Structure................... Structure..................................................................................................................... .................................................................................................. 590 5.101.2 Reply Reply Structure...................................................................................................................... Structure...................................................................................................................... 592 5.101.3 Possible Possible Errors................... Errors...................................................................................................................... ................................................................................................... 592

5.102 Oper ation: ation: 10.06 Ancillar y Services option - Service coverage option............593 option............593 5.102.1 Query Query Structure................... Structure..................................................................................................................... .................................................................................................. 593 5.102.2 Reply Reply Structure................................................................................................................ Structure......................................................................................................................595 ...... 595 5.102.3 Possible Possible Errors................... Errors...................................................................................................................... ................................................................................................... 595

5.103 Operation: Operation: 10.07 Ancillary Ancillary Services option - coverage option and pulled mode................. mode ................................................ ................................................................................................................ ................................................................................. 596 xiv

Table of Contents

5.103.1 Query Structure..................................................................................................................... Structure ..................................................................................................................... 596 5.103.2 Reply Structure...................................................................................................................... Structure...................................................................................................................... 597 5.103.3 Possible Errors...................................................................................................................... Errors...................................................................................................................... 597

5.104 Operation: 10.08 Ancillary Services option - Request a service group........... group........... 598 5.104.1 Query Structure..................................................................................................................... Structure ..................................................................................................................... 598 5.104.2 Reply Structure...................................................................................................................... Structure...................................................................................................................... 600 5.104.3 Possible Errors...................................................................................................................... Errors...................................................................................................................... 600

5.105 Oper ation: ation: 10.09 Ancillary services Ancillary services option - Request a service sub-group... sub-group..... 601 601 5.105.1 Query Query Structure..................... Structure..................................................................................................................... ................................................................................................ 601 5.105.2 Reply Reply Structure............................................................................ Structure...................................................................................................................... .......................................... 603 5.105.3 Possible Possible Errors..................... Errors...................................................................................................................... ................................................................................................. 603

5.106 Oper ation: ation: 10.10 Ancillar y services option - Request combining service group, sub-group and sub-code sub-code................... ...................................................................................................604 ................................................................................604 5.106.1 5.106 .1 Query Structure Structure..................................................................................................................... ..................................................................................................................... 604 5.106.2 Reply Reply Structure...................................................................................................................... Structure...................................................................................................................... 606 5.106.3 Possible Possible Errors..................... Errors...................................................................................................................... ................................................................................................. 606

5.107 Oper ation: ation: 10.11 Ancillary Services Ancillary Services option - Seat characteristic request........607 request........607 5.107.1 Query Query Structure..................... Structure..................................................................................................................... ................................................................................................ 607 5.107.2 Reply Reply Structure...................................................................................................................... Structure...................................................................................................................... 609 5.107.3 Possible Possible Errors..................... Errors...................................................................................................................... ................................................................................................. 609

5.108 Oper ation: ation: 10.12 Ancillary Services Ancillary Services option - Multi Passengers request..........610 request..........610 5.108.1 Query Query Structure..................... Structure..................................................................................................................... ................................................................................................ 610 5.108.2 Reply Reply Structure...................................................................................................................... Structure...................................................................................................................... 611 5.108.3 Possible Possible Errors..................... Errors...................................................................................................................... ................................................................................................. 621

5.109 Operation: Operation: 10.13 Ancillary Ancillary Services option - Combination of all possible options.............. options ............................................... .................................................................................................................622 ................................................................................622 5.109.1 5.109 .1 Query Structure.................. Structure..................................................................................................................... ................................................................................................... 622 5.109.2 Reply Reply Structure...................................................................................................................... Structure...................................................................................................................... 625 5.109.3 Possible Possible Errors..................... Errors...................................................................................................................... ................................................................................................. 625

5.110 Oper ation: ation: 11.1 - OB fees with fees with connections........ connections............... .............. ............... ............... .............. .............. ....... 626 5.110.1 Query Query Structure..................... Structure..................................................................................................................... ................................................................................................ 626 5.110.2 Reply Reply Structure...................................................................................................................... Structure...................................................................................................................... 627 xv

Table of Contents

5.110.3 Possible Errors...................................................................................................................... Errors...................................................................................................................... 627

5.111 Operation: 12.0 Rail Option - Prohibit Rail solutions.......................................628 solutions.......................................628 5.111.1 Query Structure..................................................................................................................... Structure ..................................................................................................................... 628 5.111.2 Reply Structure...................................................................................................................... Structure...................................................................................................................... 629 5.111.3 Possible Errors...................................................................................................................... Errors...................................................................................................................... 629

5.112 Operation: 12.1 Passengers Ref - 1 adult with 1 infant........ infant............... .............. ............... ............ .... 630 5.112.1 Query Structure..................................................................................................................... Structure ..................................................................................................................... 630 5.112.2 Reply Reply Structure..................... Structure...................................................................................................................... ................................................................................................. 631 5.112.3 Possible Possible Errors...................................................................................................................... Errors...................................................................................................................... 631

5.113 Oper ation: ation: 12.2 Passengers Passengers Ref - 1 adult with 1 infant and 1 child................ child................ 632 5.113.1 Query Query Structure.................... Structure..................................................................................................................... ................................................................................................. 632 5.113.2 Reply Reply Structure..................... Structure...................................................................................................................... ................................................................................................. 633 5.113.3 Possible Possible Errors......................................................................... Errors...................................................................................................................... ............................................. 633

5.114 Oper ation: ation: 12.3 Passengers Passengers Ref - 1 adult with 1 infant and 1 child, Passenger 3 with no age specified specified........................ ........................................................................................................634 ................................................................................634 5.114.1 Query Query Structure..................... Structure..................................................................................................................... ................................................................................................ 634 5.114.2 Reply Reply Structure....................................................................................................... Structure................................................................................................................... ............... ... 635 5.114.3 Possible Possible Errors..................... Errors...................................................................................................................... ................................................................................................. 635

5.115 Oper ation: ation: 13.1 Airline Fare Fare Family name and description....... description.............. .............. ............... ........636 636 5.115.1 Query Query Structure..................... Structure..................................................................................................................... ................................................................................................ 638 5.115.2 Reply Reply Structure....................................................................................................... Structure................................................................................................................... ............... ... 639 5.115.3 Possible Possible Errors..................... Errors...................................................................................................................... ................................................................................................. 650

5.116 Oper ation: ation: 13.2 Airline Fare Fare Family name and description....... description.............. .............. ............... ........651 651 5.116.1 Query Query Structure..................... Structure..................................................................................................................... ................................................................................................ 651 5.116.2 5.116 .2 Reply Structure............. Structure...................................................................................................................... ......................................................................................................... 652 5.116.3 Possible Possible Errors...................................................................................................................... Errors...................................................................................................................... 671

5.117 Oper ation: ation: 14.0 Free Baggage Baggage Allowance................................ Allowance...................................................... ...................... 672 5.117.1 Query Query Structure.................... Structure..................................................................................................................... ................................................................................................. 673 5.117.2 Reply Reply Structure..................... Structure...................................................................................................................... ................................................................................................. 674 5.117.3 Possible Possible Errors...................................................................................................................... Errors...................................................................................................................... 689 689

5.118 Oper ation: ation: 14.1 Free Baggage Baggage Allowance with multiple passenger types.......690 types.......690 5.118.1 Query Query Structure.................... Structure..................................................................................................................... ................................................................................................. 690 xvi

Table of Contents

5.118.2 Reply Structure...................................................................................................................... Structure...................................................................................................................... 692 5.118.3 Possible Errors...................................................................................................................... Errors...................................................................................................................... 703

5.119 Operation: 14.2 Baggage............................. Baggage.............................................................. ................................................... .................. 704 5.119.1 Query Structure..................................................................................................................... Structure ..................................................................................................................... 709 5.119.2 Reply Structure...................................................................................................................... Structure...................................................................................................................... 710 5.119.3 Possible Errors...................................................................................................................... Errors...................................................................................................................... 711

5.120 Operation: 15.1 Optional Data Profile................................ Profile............................................................. ............................. 712 5.120.1 Query Structure..................................................................................................................... Structure ..................................................................................................................... 712 5.120.2 Reply Structure...................................................................................................................... Structure...................................................................................................................... 713 5.120.3 Possible Errors...................................................................................................................... Errors...................................................................................................................... 713

xvii

Web services User guide for function Fare_MasterPricerTravelBoardSearch Fare_MasterPricerTravelBoardSearch

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: description: overview, supported operations, limitations, limitations, unsupported operations, operations, prerequisites and possibly reference to product specifications • the detailed detailed description description to build the query query and to retrieve data from the reply reply • a set of relevant relevant examples examples

Copyright © 1987-2015 Amadeus IT Group SA. Page 18 of 714


Fare_MasterPricerTravelBoardSearch This function provides the ability to search the Amadeus fare system for lowest fare recommendations with regards to specified trip requirements. requirements. The parameterized fare families option is supported meaning that fare families can be defined at input time. The Slice and Dice process is also supported meaning that Slice and Dice output is returned for the Search function. The Slice and Dice process can be disabled by the No Slice and Dice option. The Multi office id search process is also supported, meaning meaning the user has the ability to specify multiple Office ids in addition to the Originator Office id.



Function: Fare_Maste Fare_MasterPricerTravelBo rPricerTravelBoardSearch. ardSearch. 1 Overview This function is designed to facilitate a wide range of options, ensuring that customers can narrow down or broaden the fare search, in order to precisely match their request. The flexibility of this function provides the potential to receive up to 200 trip recommendations, enabling web-based customers to easily navigate through many choices. A basic low fare search is composed composed of the following following mandatory mandatory elements: elements: • Itinerary Itinerary geograp geographica hicall informati information on (Origins/D (Origins/Destin estinatio ations) ns) • Itin Itiner erar ary y date date info inform rmat atio ion n • Passenger information (Number of passenger passenger seats required and associated passenger passenger type codes for travelling passengers) • Number Number of Recomme Recommenda ndation tions s to be returned returned In providing maximum flexibility to narrow or broaden the lowest fare search recommendations returned, optional elements may be included in a request. Optional Opt ional elements may apply to the flight search sear ch or fare search. The ability to request segments for travel with optional filter parameters is provided and the system will return recommendations of proposed segments making up a journey for the requested segments of an itinerary with applicable price information. Thus, allowing the user to navigate through the list of recommendations to determine the best choice for travel arrangements. The following is a high level overview of this process:





1.1 Supported Operations What is an "Operation"? In this document, an "operation" describes, in general, a possible query scenario. More precisely, this operation corresponds very often to the use of an option. However, in some cases, it describes a scenario that points out to a feature that needs further clarification. Search with Only Mandatory Elements Specifying only the mandatory elements elements allows for the search possibilities of a specified date and city pair. Itinerary Date A date of travel travel must be specified specified for a low fare fare search query. query. Origin / Destination At least one origin origin and one one destination destination must be specified specified for a low low fare search query. query. Passenger Information Number of Passenger Seats The number of seats required for the travelling passengers passenger s must be specified for a low fare search. This number may not always be equal to the total number of passengers travelling. For example, 3 adults and 1 infant, as an infant does not occupy a seat, this request requires only 3 seats for 4 travelling passengers. Associated Passenger Passenger Type Codes for Travelling Travelling Passengers Passengers Each travelling passenger must be associated to a Passenger Type Code (PTC) for a low fare search. Number of Recommendations The user must specify the maximum number of recommendations to be returned. Multi-Office id search process The user can specify up to 19 Office ids in addition to the Originator Office id of the Originator Details segment, within the same country and with the same modifier type. The system will then find the cheapest travel solutions amongst all office ids requested in input (originator office id and additional office ids) without any preference. Flight Convenience The following criteria are applied to measure the convenience of each journey: - The proportion of the Ground Time with regards to the Total Flying Time, - The ratio between the Total Flying Time and the shortest possible flying time, - The Overnight connections proportion regarding the other journeys. If a journey fails against these criteria, it is considered as a Low Convenience Journey. Copyright © 1987-2015 Amadeus IT Group SA. Page 22 of 714


In order to ensure a good overall journey convenience of the response, the Flight Convenience ensures that the total number of returned Low Convenience journeys does not exceed 5% of the requested number of recommendations. Search with Optional Elements Specifying additional optional elements in the search request will narrow the recommendations returned. The more optional elements included in the search request, the more precise the search recommendations will be. Flight Options •

Airli Airline ne (Inc (Inclu lude de/E /Exc xclu lude de))

The user has the ability to include and/or exclude up to 99 Airlines in the Low Fare Search using a 2alphanumeric alphanumeric character airline code. •

Flig light Cate Categ gory

The user has the ability to request Non-Stop, Direct or Connecting flights or a combination of these categories. •

Conn Connec ecti ting ng Poin Pointt

The user has the ability to include and/or exclude up to 2 connecting points for the requested Low Fare Search. The user has also the ability to include up to 2 preferred connecting points. •

Multicity

The user has the ability to specify up to 20 Cities or Airports as Origin and/or Destination of each Requested Segment. •

Orig Origin in/D /Des esti tina nati tion on Area Area

The user has the ability to extend the low fare search up to 300 kilometers surrounding the airport or city specified for an origin or a destination. If an origin or destination area is specified, the low fare search process may consider any city whose flying distance to the specified City or Airport is lower than the specified radius in the query. •

Igno Ignore re Avai Availa labi bili lity ty

The user has the ability to ignore the real availability for flight selection: all returned booking codes are considered as available. •

Disa Disabl ble e bias biased ed refe refere renc nce e

When this option is requested, the flight search request is performed in neutral mode independently of the office settings. •

More overn vernig igh hts

The user has the ability to request more overnight solutions solutions if they are part of the cheapest solutions. •

No Slice lice and Dice Dice

The user has the ability to disable Slice and Dice process with an option in the query. Copyright © 1987-2015 Amadeus IT Group SA. Page 23 of 714


•

Excl Exclud ude e Low Low Cost Cost Carr Carrie iers rs

The user has the possibility via this option to exclude TLA Recommendations. •

Online

This option forces the process to return online travel solutions only, even if cheaper recommendations recommendations mixing carriers exist. •

Inte Interl rlin ine e opti option on

The user has the ability to request only interline solutions, meaning meaning recommendations recommendations built with flights marketed by different carriers. •

Anch Ancho ored red Sea Search rch

The user has the ability to freeze freez e one or more requested segments in input in order to t o get only recommendations including those travel solutions. Full mode or basic mode is triggered by OID setting. •

Poin Pointt of comm commen ence ceme ment nt

The user can specify the real point of commencement when the first requested segment is not the real origin. •

Prog Progre ress ssiv ive e legs legs

Progressive legs enables the user to request a range of number of connections relative to the minimum connections connections that exist on Journey Server. Date/Time Options •

Time Time of Depa Depart rtur ure/ e/Ar Arri riva vall

Per requested segment, the user has the ability to specify one of the following: - A time of departure: the earliest time that a recommended recommended flight may "depart from". - A time of arrival: the latest time that a recommended recommended flight may "arrive by". Both options cannot be used at the same time on the same requested segment. •

Time Window

The user has the ability to specify an applicable time window range, in terms of hours, to a specified time by departure or arrival option. Thus, allowing the low fare search to include any flight recommendations recommendations that arrive or depart within the specified number of hours on either side of the specified time by departure or arrival. •

Time Time at Dest Destin inat atio ion n

The time at destination is the minimum time between the arrival time and departure time of two consecutive proposed segments. This minimum time is specified in input with the following format HHMM. Any value between 0000 and 2359 is accepted. •

Range of Date

The user has the ability to request that the low fare search to include the day before or the day after the date specified for a trip segment. Copyright © 1987-2015 Amadeus IT Group SA. Page 24 of 714


Fare Options •

Curr Curren ency cy Conv Conver ersi sion on

The user has the ability to specify in which currency the fare recommendations must be converted and returned. •

Curr Curren ency cy of Fare Fare Sele Select ctio ion n

The user has the ability to only request recommendations recommendations with fare filed in a specified currency. •

Sellin Selling/T g/Tick icketi eting ng Cities Cities Overr Override ide

The user has the ability to override the Selling and/or Ticketing Cities. •

Price to Beat

The user has the ability to specify a "Price to Beat", a total amount (including taxes) for all passengers which determines the most expensive recommendation that can be returned by the system. •

Spli Splitt / No Spli Splitt PNR PNR

The user is able to request that non-homogeneous recommendations are to be returned or not. Nonhomogeneous recommendations require to book passengers on several PNRs. •

Paper Paper Ticket Ticket / Electr Electron onic ic Ticket Ticket

This option offers to the user the capability to process: Paper Ticket only or Electronic Ticket only. •

Unifares

By default the low fare searches are applicable only to public fares. However, the user can specify whether the low fare search applies on Unifares only, on all Public and Unifare fares or Corporate fares. •

Expa Expand nded ed Para Parame mete ters rs

The user can specify Expanded Parameters that tha t are used to target only some fares (refundable, without with out penalty, and so on). Only valid expanded parameter options applicable: NAP, NPE, NR and RF. •

My Sear Search ch - Fare Fare Fami Famililies es

By default any applicable fare can be returned, using My Search option the user can specify which fares are of interest by using criteria like Fare Basis, Prime booking Code. •

Soluti Solution on Famil Family y Distri Distribu butio tion n

Travel Board solution family distribution is designed to cover the need to show a list of families of recommendations for a specific itinerary on defined dates. A solution family refers to price results matching predefined criteria as "Cheapest Recommendations" Recommendations" or "Non Stop". •

Cab Cabin Optio tions Copyright © 1987-2015 Amadeus IT Group SA. Page 25 of 714


The user has the ability to specify a desired cabin class for the requested itinerary. There is three different flavours of process: Mandatory, Recommended and Major Cabin that are described in the corresponding operations. •

Pric Price e only PTC

The process returns strictly recommendations recommendations with the requested passenger passenger type, no defaulting is done. •

Alte Altern rna ate Pric Price e

This function allows returning for each recommendations belonging to the eligible Fare Family, the cheapest available Alternate recommendation for the exact same journey and cabin. Service Fees Options •

Pric Pricin ing g Sche Scheme me refe refere renc nce e

The user has the ability to specify a Pricing Scheme Reference for the calculation of a service fee by passenger of a recommendation. •

Form orm of Payme aymen nt

A maximum of of 3 forms of payment payment may be specified in the the request. •

Sort Sortin ing g with with/w /wit itho hout ut Fees Fees

This option provides the possibility to sort recommendations in output based on an amount including fees or excluding fees. It is applied for all passengers of the query. •

Exemp Exemptt all airlin airline e ticket ticketing ing fees fees

Airline ticketing fees can can all be exempted exempted with this option. Add/Exempt Add/Exempt airline ticketing fees by by sub-code sub-code Airline Airline ticketing fees (OB fees) sub-codes can be specified in order to add or exempt particular fees. Ancillary services Option Option The user can request ancillary services. In pushed mode, all or preselected subset of applicable ancillary services and associated prices will be returned in each recommendation but not considered in the search of the lowest fares. The pushed mode is set as the default mode. In pulled mode, all or preselected subset of ancillary services and associated prices are returned in each shopping recommendations and considered in the search of the lowest fares. Copyright © 1987-2015 Amadeus IT Group SA. Page 26 of 714


Distribution options

•

Airli Airline ne Dist Distri ribu buti tion on:: ADI ADI

When this option is requested, the total number of Recommendations are distributed over 2 sets as the following: The Airline Diversity Set contains the cheapest recommendation for each online carrier and the cheapest recommendation for each Mono-Main Carrier. The Cheapest Recommendations Set contains the cheapest recommendations matching the query that are not included in the Airline Diversity recommendations recommendations set.

•

Airlin Airline e Distri Distribu butio tion n Contai Containe ner: r: ADC

When this option is requested, the total number of recommendations recommendations are distributed over 2 sets as the following: The Airline Diversity Container: Up to 25% of the Total Number of Recommendation Recommendation is allocated to the airline diversity. The Cheapest Recommendations Set contains the cheapest recommendations matching the query that are not included in the Airline Diversity Container.

•

NonNon-St Stop op Pref Prefer erre red d

When this option is requested, recommendations recommendations with non-stop flights will be favoured. The user has also the possibility to modify the non-stop distribution weight. Output options

•

Empt Empty y Cell Cells s Clar Clarif ific icat atio ion n

When this option is requested, a fictitious recommendation is returned with the corresponding reason for segments and/or dates where no recommendation can be returned.

•

Rank Rank in jour journe ney y Serv Server er



The user has the ability to request the display of the rank of the Flight Solution. •

Mult Multii-Ti Tick cket et opti option on

The Multi-Ticket option allows returning at the same time: - Recommendations that require one single pricing transaction to be booked. - Recommendations that require individual pricing transactions per Proposed Segment to be booked (the search is done on the same office id for the whole itinerary). •

Identify Identify YQ/YR YQ/YR separate separately ly from other other taxes taxes

The purpose of this option is to return separately in the output the total amount of YQ/YR taxes per recommendation and per passenger type. •

Indian Taxes

This option details in the response message Indian tax amounts for each recommendation and for each type of passengers. •

Ticke icketi tin ng date

In order to avoid quoting a fare to a passenger that they are then unable to ticket at a later date, the user has the ability to specify the intended ticketing date in the request. This option ensures that the user will only receive recommendations that, if priced on the same day as the query is received, are valid for ticketing on the future ticketing date specified in the request. •

Fare Fare Calc Calcul ulat atio ion n

Depending of the office ID setting, the user has the ability to request the details of the entire far e calculation line. •

Commission



Depending of the office ID setting, the user has the ability to display the commission in percentage for each fare basis. •

Ticket Ticketing ing Point Point Mileag Mileage e (TPM) (TPM)

Depending Depending of the office profile, the user has the ability to display the TPM at flight level. •

Value Search

Depending Depending of the criteria profile, the user has the ability to quote the more convenient solutions. •

In-F In-Fli ligh ghtt Serv Servic ices es

Depending Depending of input option, the user has the ability to request the display of the in-flight services for each flight.

1.2 Limitations Number of Recommendations The maximum number of recommendations in standard Master Pricer Travelboard is 250. Range of Dates It is currently not possible to request more than 1 day forward and/or 1 day backward for the searchable date range. Requested Segments It is not possible to request more than 6 requested segments. Number of Passengers It is not possible to request more than 9 passengers. My Search - Fare Families It is not possible to request more than 6 fare families. Multiple Office Ids It is not possible to specify more than 19 Office Ids.

1.3 Unsupported Operations Longitude/Latitude The ability to specify a search request with a longitude or latitude is not currently processed. Copyright © 1987-2015 Amadeus IT Group SA. Page 29 of 714


Origin/Destination Origin/Destination - Forced Location The option to force a location to a city from a previously requested segment search result is not currently processed. For example, 2nd requested departure city indicated to match the 1st requested arrival city of a proposed segment. Sequence Number - Overnight Not Allowed It is currently not possible to indicate that flight combinations combinations with over nights are not allowed for the low fare search. Therefore, the code OV is not supported.

1.4 Prerequisites None



2 Building A Query Each query follows a given structure. The queries for the function operations are clearly explained with data element examples in a generic table view. It is important to note that the examples in each chapter are only illustrations and are meant to provide the basis for a better understanding understanding on which fields are mandatory for basic operation utilisation. In some cases it is not a full explanation of every field that can be utilised for the operation, but rather a guideline to its use. Considerations When building a query it is important to understand the following concepts for the low fare search queries: What is a Parameterized Fare Family ? A Parameterized Fare Family is a set of specific parameters directly specified through the request. Up to 6 Parameterized Fare Families can be defined in the Master Pricer query. The parameterized Fare Family can be combined with any other option as long as the request remains functionally coherent. What is a Requested Segment? A 'Requested 'Requested Segment' Segment' is an Origin/Destination/Da Origin/Destination/Date te segment of of the travel requested requested in the query. Examples: • CDG CDG to JFK JFK on 26 June June,, • CDG to JFK on 26 June June or 27 June, June, • LON LON to BKK BKK on 26 June June,, • LON or any any airpor airportt within within 100 km to to BKK BKK on on any any date date betwe between en 26 June June and 27 June, June, • LON to NCE/MRS/M NCE/MRS/MCM CM ("Cote ("Cote d'Azu d'Azur") r") on any date between between 26 June and 27 June. June. What is an Itinerary? An 'Itinerary' is the the combination combination of all the Requested Segments in the order the passenger passenger specified specified them. Optional Parameters The optional parameters may apply at the Requested Segment and/or Itinerary level. Applicable Option Levels Levels The following table gives the rule for each option in terms of applicable levels. Options

Applies to Segment

Applies to Itinerary

Flight Options Number of recommendations

X

Airline

X

X

Cabin

X

X

Time Window

X

Times Departure/Arrival

X

Connecting point

X

Expanded Parameter Flight Category

X X

Selling/Ticketing Cities Radius Radius (Origin/De (Origin/Destina stination tion areas) areas)

X X

X Copyright © 1987-2015 Amadeus IT Group SA. Page 31 of 714


Multi-city

X

No Slice and Dice

X

Disabled Biased Reference

X

More overnights

X

Exclude Low Cost Carriers Ignore Availability

X

Airline Distribution: Distribution: ADI

X

Airline Distribution Distribution Container: Container: ADC

X

Non-Stop Preferred

X

Online

X

X

Anchored Search Search

X

Point of commencement

X

Progressive legs

X

X

Fare Options Passenger Type

X

Price to Beat

X

Unifares

X

Parameterized Fare Families

X

Split/No Split PNR

X

Currency Conversion

X

Paper Ticket/Electronic Ticket

X

Ticketability pre-check

X

Expanded Parameters

X

Withhold All Taxes/Surcharges

X

Service Fees: Pricing Scheme reference

X

Multi-tickets

X

Form of payment

X

Adding/exempting Adding/exempting specific specific airline ticketing fees

X

Exempt all airline ticketing fees

X

Sorting with/without Fees

X

Multi Office IDs

X

Price only PTC

X Copyright © 1987-2015 Amadeus IT Group SA. Page 32 of 714


Alternate Price

X

Date Options Range of Dates

X

Output Options Identify YQ/YR tax amounts

X

Empty Cells Clarification

X

Rank in Journey Server

X

Ancillary service fees fees

X

X

Value Search

X

X

Optional Data Profile

X

In-Flight services X The input validation of each option is described in the corresponding sections. Option requested at both requested segment level and itinerary level If an option applies at both Requested Segment and Itinerary levels and if the request is not rejected, as specified in the description of the corresponding option paragraph, then the option specified at the Requested Segment level takes precedence over the Itinerary option. Examples: Request 1st Requested Segment

Process 2nd Requested Segment

Itinerary

1st Requested Segment

2nd Requested Segment

Include Airlines: AA, CO

Include Airlines: AA, Include Airlines: AA, Include Airlines: AA, DL CO DL

Include Airlines: FL, CO, YY

Exclude Airlines: AA, DL

Include Airlines: FL, CO eventually combined with any airline but AA, DL.

Exclude Airlines: AA, DL

Possible Option Level Errors Option Cannot be Applied at Requested Segment Level. If an option is only valid at the Itinerary level but the user has specified it at the Requested Segment Segment level, the entire entry is rejected with the following message: "OPTION CANNOT BE APPLIED AT REQUESTED SEGMENT LEVEL" Option Cannot be Applied at Itinerary Level If an option is only valid at the Requested Segment level but the user has specified it at the Itinerary level, the entire entry is rejected with the following message: message: "OPTION CANNOT BE APPLIED AT ITINERARY LEVEL" Copyright © 1987-2015 Amadeus IT Group SA. Page 33 of 714


Query Structures The query samples provided in this document are in a table format to easily identify the different levels of applicable information required in the function. The repetitions of nodes in the samples provided are identified with brackets and numbers [n]. Each element of the function is explained with a query sample in the applicable sections of this document. In some cases, the query sample contains only the information applicable to the discussed element. The responsibility lies with the API developer to read the element sections for rules and combinability issues to build the applicable messages desired. As a guideline for the possibility of a more complex message structure, the sample query structure below is given, identifying a low fare search requesting the following information: Item #

Requested Information

0-1

Low Fare Search for 3 passengers

2-3

Requesting a maximum of 200 recommendations returned

4-8

Passenger Types of 2 Adults and 1 Child

9 - 10

DL airlines are to be excluded from any recommendations

11 - 16

1st requested segment: • Depar Departin ting g airpo airport rt in Nice Nice (NCE) (NCE) • Arrivi Arriving ng at any airpo airport rt in the city city of Housto Houston n (HOU) • Time specified specified for arrival arrival by 20 Feb 2004 2004 at 5pm

17 - 22

2nd requested segment: • Depar Departin ting g any any airpo airport rt in city city of Housto Houston n • Arri Arrivi ving ng at Nice Nice airp airpor ortt NCE NCE • Depar Departur ture e Date Date of 28 Feb Feb 2004 2004 • Requesti Requesting ng both Non-Stop Non-Stop and Direct Direct Flights Flights for the recommendations Item #

SearchQuery - Data element

Value

0

/Segment/ 3 unitNumberDetail[1] unitNumberDetail[1] /numberOfUnits /numberOfUnits

1

/Segment/ unitNumberDetail[1] unitNumberDetail[1] /typeOfUnit

2

/Segment/ 200 unitNumberDetail[2] unitNumberDetail[2] /numberOfUnits

3

/Segment/ unitNumberDetail[2] unitNumberDetail[2] /typeOfUnit

RC

4

/paxReference[1]/ ptc

ADT

PX



5

/paxReference[1]/traveller[1] /ref

1

6

/paxReference[1]/traveller[2] /ref

2

7a

/paxReference[2]/ ptc[1]

CH

7b

/paxReference[2]/ ptc[2]

MIL

8

/paxReference[2]/traveller /ref

3

9

/travelFlightInfo/ X companyIdentity[2] companyIdentity[2] /carrierQualifier

10

/travelFlightInfo/ companyIdentity[2] companyIdentity[2] /carrierId

11

/itinerary[3]/ 1 requestedSegmentRef /segmentRef

12

/itinerary[3]/departureLocalization/ departurePoint departurePoint /locationId

NCE

13

/itinerary[3]/arrivalLocalization/ arrivalPointDetails arrivalPointDetails /locationId

HOU

14

/itinerary[3]/timeDetails/ firstDateTimeDetail firstDateTimeDetail /timeQualifier /timeQualifier

TA

15

/itinerary[3]/timeDetails/ firstDateTimeDetail firstDateTimeDetail /date

200204

16

/itinerary[3]/timeDetails/ firstDateTimeDetail firstDateTimeDetail /time

1700

17

/itinerary[4]/ 2 requestedSegmentRef //segmentRef segmentRef

18

/itinerary[4]/departureLocalization/ departurePoint departurePoint /locationId

HOU

19

/itinerary[4]/arrivalLocalization/ arrivalPointDetails arrivalPointDetails /locationId

NCE

20

/itinerary[4]/timeDetails/ firstDateTimeDetail firstDateTimeDetail /date

280204

21

/itinerary[4]/flightInfo/ flightDetail /flightType[1]

N

DL

22

/itinerary[4]/flightInfo/ D flightDetail /flightType[2] Referring to the applicable element sections of this document will provide any specific element information required.



3 Receiving A Reply For each query requested, either an applicable error message or a valid response is returned. Applicable error message information is provided under each element section within this document. In case of a valid response, two cases occur. Either the reply message is truncated if it is too big or not. In case of truncation, a flag is returned with the maximum size of the message (MSG:128k). (MSG:128k). In case ancillary services are requested, and the reply message is too big and truncated, the ancillary service details part appears at the end of the message even if the recommendations don't show any ancillary services. The reply information will vary depending on the query information provided. Considerations When building a query it is important to understand the following concepts for the low fare search queries: What is a Fare Family? A Fare Family is a group of Fares sharing the same characteristics. Fare Family details can be defined as a combination of the following elements, for example: • Publ Publis ishi hing ng carr carrie ier r • Type of fare (For example, example, Publishe Published, d, DDF, Amadeus Amadeus Nego, Nego, ATP ATP Nego) Nego) • Inclus Inclusion ion of one one or severa severall fare fare basis basis • Prim Prime e book bookin ing g code code A combinability combinability tag and a ranking are also also provided. provided. • The combinab combinability ility tag prevents prevents fare families families from being being combined combined.. • The ranking is used to assign a resulting fare family in case where fare families are combined. What is a Recommendation? A "Recommendation" "Recommendation" is the combination combination of a fare and its correspondin corresponding g journeys that are returned as a possible solution. The journeys are divided and categorised under applicable fares making up the number of recommendations requested in the query. What is a Journey? A "Journey" is a combination of Proposed Segments covering covering the requested requested Itinerary. Itinerary. What is a Proposed Segment? A "Proposed Segment" is a combination of flights that matches a Requested Segment. Segment. This may result in 3 connecting flights being considered as a single "Proposed segment". Examples: Request Segment

Proposed Segment

CDG to JFK on 26 June

AF flight 22 on 26 June

LON to BKK on 26 June

LH flight 4629 LHR to FRA 26 June LH flight 744 FRA to BKK 26 June

NCE to SBN on 28 July

AF flight 7701 NCE to CDG 28 July AF flight 050 CDG to ORD 28 July Copyright © 1987-2015 Amadeus IT Group SA. Page 36 of 714


UA flight 5860 ORD to SBN 28 July Electronic Ticketing The Electronic Ticketing indicator field indicates whether whether a flight is eligible for electronic ticketing (value 'Y' for Yes) or not (value 'N' for No). addProductDetail - Data element Value /electronicTicketing

Value Y

/electronicTicketing Y Electronic ticketing (e-ticketing) allows sending ticketing information directly to an airline so that passengers can check in at the airport and board flights without requiring printed tickets. When an electronic ticket (e-ticket) is issued via Amadeus, the system sends the flight coupons as a message to the airline. If the airline accepts the e-ticket request, the information is stored in the airline's own system as an e-ticket record and displayed in the reply. Notes: • The amount of time that electronic ticket record remains stored in the airline's system varies among airlines. • In order for electronic tickets (in other word e-ticketing) to be issued, the office must be authorised to issue e-tickets as defined at the Office Profile level.The flight segments in the itinerary are required to be eligible for 'e-ticketing' and the validating airline must support e-ticketing in Amadeus. • Every airline airline that supports supports electroni electronic c ticketi ticketing ng in Amadeus Amadeus has its own condition conditions. s. Slice & Dice The Slice and Dice process aim is to consider all availabilities that may be used in order to optimise the price of an itinerary, and to apply the same class combination restrictions as the one applied by the carriers. When Slice and Dice process is applied, the availability context is r eturned in the Master Pricer response. This context will have to be used to book the solution returned by the engine. Let us consider an example of a 3-segment eligible connection, between the 4 cities A, B, C and D, where the 3 flights are AB, BC, and CD. Without Slice and Dice process, only O&D availability AD is checked. With the Slice and Dice process, local availabilities AB, BC, CD and Sub O&D availabilities AC and BD (respectively named Sub O&D 1 and Sub O&D 2) will also have to be checked. This means that in case an O&D context (default processing, no extra information about availability context), all flights of the connection have to be sold at the same time. In case of Sub O&D, the two corresponding flights must be sold together and in case of local context, the corresponding flight has to be sold alone. In segmentFlightRef, segmentFlightRef, an additional additional refQualifier with the value "A" (for Recommendation Recommendation Availability context) is added with its refNumber SearchReply - Data element

Example

Description

segmentFlightRef / referencingDetail referencingDetail / refQualifier

S

Reference of Proposed Segment

segmentFlightRef / referencingDetail referencingDetail / refNumber

3

Index to Proposed Segment

segmentFlightRef / referencingDetail referencingDetail / refQualifier

A

Reference to availability



segmentFlightRef / 1 Index to availability context referencingDetail referencingDetail / refNumber The corresponding description for each reference of a recommendation availability context is given in the group specificRecDetails. specificRecDetails. This group contains the following sub-groups: • the specificRe specificRecItem cItem with the referenc referenceTyp eType e "A" and the refNumbe refNumber r • the specificProductDetails specificProductDetails which contains the productReferences productReferences with the paxFareNum • the fareConte fareContextDet xtDetails ails which contains contains the requeste requestedSeg dSegmen mentInfo tInfo with the segRef segRef • the cnxContextDetails cnxContextDetails which contains the fareCnxInfo with the contextDetails contextDetails and and the availabilityCnxType. Note: Possible values for the availabilityCnxType availabilityCnxType are: ◦ LA for Local Local Availability Availability ◦ S1 for for Sub Sub O&D O&D 1 ◦ S2 for for Sub Sub O&D O&D 2 ◦ default is the O&D context context and in this case no availability availability context is returned returned SearchReply - Data element

Example

Description

specificRecDetails specificRecDetails / specificRecItem /referenceTy /r eferenceType pe

A

Availability context context

specificRecDetails/ specificRecItem/refNumber

1

Availability context index

specificProductDetails/ productReferences / paxFareNum

1

Reference to passenger

specificProductDetails/ fareContextDetails/ requestedSegmentInfo/ segRef

1

Index of Proposed Segment

fareContextDetails/ LA cnxContextDetails[1]/ cnxContextDetails[1]/ fareCnxInfo/ contextDetails/ availabilityCnxType availabilityCnxType

availability context "local" for first flight of Proposed Segment

fareContextDetails/ LA cnxContextDetails[2]/ cnxContextDetails[2]/ fareCnxInfo/ contextDetails/ availabilityCnxType availabilityCnxType

Availability context "local" for second flight of Proposed Segment

Reply Structure As it is not possible to cover every reply structure possible, only a sample of a possible reply structure is provided as a guideline of the typical reply message expected. Each reply contains the following: • Fare Families Applicable for the recommendations recommendations (in case parameterized parameterized fare families have been requested in the input) • Proposed Proposed Flight Flight Segments Segments for each requeste requested d segment segment • Journeys consisting of combinations combinations of proposed flight segments to complete the requested trip • Applic Applicabl able e Fares Fares for journe journeys ys • Appl Applic icab able le Fare Fare Deta Detailils s Copyright © 1987-2015 Amadeus IT Group SA. Page 38 of 714


My Search Reply: Parameterize Parameterized d Fare Families This is only applicable for the Search Travel Board function. Only in case the My Search option is used, the following information needs to be returned in the reply: •

Fare Family Family Informat Information: ion: Reference Reference,, name name and ranking ranking of each fare family family

This table presents the XML node familyInformation structure associated to each Fare Family information that is returned in the reply: SearchReply - Data element

example

Description

/ familyInformation /refNumber

1

Reference of the fare family

/ familyInformation / fareFamilyname

FFAMILY1

Name of the fare family

/ familyInformation /hierarchy 100 • Fare Family Family Referenc Reference e of each fare detail: detail: SearchReply - Data element

1

example

Description

/ fareDetails / groupOfFares / F fareFamiliesRef fareFamiliesRef /referencingDetail/ /referencingDetail/ refQualifier

Reference of the fare family

/ fareDetails / groupOfFares / 1 fareFamiliesRef fareFamiliesRef /referencingDetail/ /referencingDetail/ refQualifier/ refNumber • Fare Fare Brea Breakp kpoi oint nt retu return rned ed

Reference to the Fare Family referenced 1 in the family information node.

SearchReply - Data element

example

/recommendation[2] / Y paxFareProduct[4] paxFareProduct[4] /fareDetails[2] / groupOfFares/ productInformation/ breakPoint

Description The fare breakpoint: Y or N

OB fees In the reply, information is also provided about the fact that OB fees exist for the validating carrier and the office (OID), the validating carrier used for pricing and the amount of OB fees. SearchReply - Data element

example

Description

priceTicketing/ priceType[1]/

OBV

Validating carrier accepts OB fees

priceTicketing/ priceType[2]/

OBA

OID accepts OB fees

recPriceInfo/ monetaryDetail/ monetaryDetail/ amountType recPriceInfo/ monetaryDetail/ monetaryDetail/ amount Copyright © 1987-2015 Amadeus IT Group SA. Page 39 of 714


paxFareDetail/ paxFareDetail/ codeShareDetails/ codeShareDetails/ transportStageQualifier

V

Type of carrier: validating carrier used for pricing

paxFareDetail/ paxFareDetail/ codeShareDetails/ codeShareDetails/ AA company

AA is validating validating carrier

paxFareDetail/ paxFareDetail/ monetaryDetails/ monetaryDetails/ amountType

Type of Amount: OB fees

OB

paxFareDetail/ paxFareDetail/ monetaryDetails/ monetaryDetails/ 10 Amount amount It should be noted that the number of recommendations returned are dispersed between applicable fares and will be less than or equal to the number recommendations requested in the query. One applicable Fare may contain more than one journey, resulting in a set of recommendations based on the same Fare. Below is a typical reply structure that can be expected to the query sample provided in the "Building A Query" section of this document. The sample reply structure contains the following information for 5 recommendations to a query containing 2 requested segments (1st - Nice to Houston, 2nd - Houston to Nice): Item # 1

Reply Information Applicable Currency of reply in US Dollars

PROPOSED SEGMENTS APPLICABLE TO 1ST REQUESTED SEGMENT 2

Applicable "Requested" Segment - 1st Requested segment

3

Applicable "Proposed" Segment - 1st Proposed segment

4-5

Total elapsed flying time for proposed segment - 13h50

6-30

Flight Details for 1st proposed segment

6-18

1st flt

Nice to Paris

19-30

2nd flt

Paris to Houston

31

Applicable "Proposed" Segment - 2nd Proposed segment

32-33


34-59

Flight Details for 2nd proposed segment

34-46

1st flt

Nice to Paris

47-59

2nd flt

Paris to Houston

60

Applicable "Proposed" Segment - 3rd Proposed segment

61


62-87

Flight Details for 2nd proposed segment

62-74

1st flt

Marseille to Paris

75-87

2nd flt

Paris to Houston

PROPOSED SEGMENTS APPLICABLE TO 2ND REQUESTED SEGMENT 88

Applicable "Requested" Segment - 2nd Requested segment

89

Applicable "Proposed" Segment - 1st Proposed segment Copyright © 1987-2015 Amadeus IT Group SA. Page 40 of 714


90-92


93-118


93-105

1st flt

Houston to London

106-118

2nd flt

London to Nice

119

Applicable "Proposed" Segment - 2nd Proposed segment

120-121


122-148


122-135

1st flt

Houston to Paris

136-148

2nd flt

Paris to Nice

149

Applicable "Proposed" Segment - 3rd Proposed segment

150-151


152-178


152-165

1st flt

Houston to Paris

166-178

2nd flt

Paris to Nice

179

Applicable "Proposed" Segment - 4th Proposed segment

180-181


182-208


182-195

1st flt

Houston to London

196-208

2nd flt

London to Nice

APPLICABLE RECOMMENDAT RECOMMENDATIONS IONS FOR REQUESTED REQUESTED SEGMENTS SEGMENTS 209-258

1st Set of recommendations for an Applicable fare

210

Total Price for all passengers (including taxes)

211

Total Taxes for all passengers

212-215

Applicable flight combination - completing recommendation #1

216-219

Applicable flight combination - completing recommendation #2

220-258

Applicable Fare Details

220-238

Fare Details for Adult passengers

239-258

Fare Details for Child passenger

259-300

2nd Set of recommendations for an Applicable fare

260


261


262-265

Applicable flight combination of - completing recommendation #3

266-269




270-300

Applicable Fare Details

301-330

3rd Set of recommendations for an Applicable fare

302


303


304-307


308-330 Applicable Fare Details NOTE: The reply structure contains all proposed segments listed first followed by associated fare information for the proposed segments to complete each recommendation. Item 1

SearchReply - Data element /conversionRate/ conversionRateDetail/ conversionRateDetail/ currency

Value USD

PROPOSED SEGMENTS FOR 1st REQUESTED SEGMENT 2

/flightIndex [1] / requestedSegmentRef/ segRef

1

3

/flightIndex [1] /groupOfFlights [1] / 1 propFlightGrDetail/flightProposal [1] / ref

4


5

/flightIndex [1] /groupOfFlights [1] / EFT propFlightGrDetail/flightProposal [2] / unitQualifier unitQualifier

6

/flightIndex [1] /groupOfFlights [1] / AF propFlightGrDetail/flightProposal [3] / ref

7

/flightIndex [1] /groupOfFlights [1] / MCX propFlightGrDetail/flightProposal [3] / unitQualifier unitQualifier

8

/flightIndex [1] /groupOfFlights 200202 [1] /flightDetails [1] / flightInformation/productDa flightInformation/productDateTime/ teTime/ dateOfDeparture

9

/flightIndex [1] /groupOfFlights 0725 [1] /flightDetails [1] / flightInformation/productDa flightInformation/productDateTime/ teTime/ timeOfDeparture

10

/flightIndex [1] /groupOfFlights [1] / 200202 flightDetails [1] /flightInformation/ /flightInformation/ productDateTime/ productDateTime/ dateOfArrival Copyright © 1987-2015 Amadeus IT Group SA. Page 42 of 714


11

/flightIndex [1] /groupOfFlights [1] / 0855 flightDetails [1] /flightInformation/ /flightInformation/ productDateTime/ productDateTime/ timeOfArrival

12

/flightIndex [1] /groupOfFlights [1] / NCE flightDetails [1] /flightInformation/ /flightInformation/ location [1] / locationId

13

/flightIndex [1] /groupOfFlights [1] / CDG flightDetails [1] /flightInformation/ /flightInformation/ location [2] / locationId

14

/flightIndex [1] /groupOfFlights [1] / A flightDetails [1] /flightInformation/ /flightInformation/ location [2] / airportCityQualifier airportCityQualifier

15

/flightIndex [1] /groupOfFlights [1] / AF flightDetails [1] /flightInformation/ /flightInformation/ companyId/ companyId/ marketingCarrier marketingCarrier

16

/flightIndex [1] /groupOfFlights [1] / AF flightDetails [1] /flightInformation/ /flightInformation/ companyId/ operatingCarrier

17

/flightIndex [1] /groupOfFlights [1] / 7673 flightDetails [1] /flightInformation/ /flightInformation/ flightNumber

18

/flightIndex [1] /groupOfFlights [1] / 320 flightDetails [1] /flightInformation/ /flightInformation/ productDetail/ equipmentType

19

/flightIndex [1] /groupOfFlights Y [1] /flightDetails [1] / flightInformation/addProd flightInformation/addProductDetail/ uctDetail/ electronicTicketing

20


21


22

/flightIndex [1] /groupOfFlights [1] / 200202 flightDetails [2] /flightInformation/ /flightInformation/ productDateTime/ productDateTime/ dateOfArrival

23

/flightIndex [1] /groupOfFlights [1] / 1415 flightDetails [2] /flightInformation/ /flightInformation/ productDateTime/ productDateTime/ timeOfArrival Copyright © 1987-2015 Amadeus IT Group SA. Page 43 of 714


24


25

/flightIndex [1] /groupOfFlights [1] / IAH flightDetails [2] /flightInformation/ /flightInformation/ location [2] / locationId

26

/flightIndex [1] /groupOfFlights [1] / CO flightDetails [2] /flightInformation/ /flightInformation/ companyId/ companyId/ marketingCarrier marketingCarrier

27


28


29


30


31


32


33


34


35


36




37


38


39


40


41


42


43


44


45


46


47


48




49


50


51


52


53


54


55


56


57


58


59


60


61




62


63


64


65


66


67

/flightIndex [1] /groupOfFlights [3] / MRS flightDetails [1] /flightInformation/ /flightInformation/ location [1] / locationId

68


69

/flightIndex [1] /groupOfFlights [3] / A flightDetails [1] /flightInformation/ /flightInformation/ location [2] / airportCityQualifier airportCityQualifier

70


71


72


73


74

/flightIndex [1] /groupOfFlights Y [3] /flightDetails [1] / flightInformation/addProd flightInformation/addProductDetail/ uctDetail/ electronicTicketing Copyright © 1987-2015 Amadeus IT Group SA. Page 47 of 714


75


76


77


78


79


80


81


82


83


84


85


PROPOSED SEGMENTS FOR 2nd REQUESTED SEGMENT 86

/flightIndex [2] / requestedSegmentRef/ segRef

2



87


88


89


90

/flightIndex [1] /groupOfFlights [1] / BA propFlightGrDetail/flightProposal [3] / ref

91


92


93


94


95


96

/flightIndex [2] /groupOfFlights [1] / 1 flightDetails [1] /flightInformation/ /flightInformation/ productDateTime/ productDateTime/ dateVariation dateVariation

97


98

/flightIndex [2] /groupOfFlights [1] / LGW flightDetails [1] /flightInformation/ /flightInformation/ location [2] / locationId

99

/flightIndex [2] /groupOfFlights [1] / BA flightDetails [1] /flightInformation/ /flightInformation/ companyId/ companyId/ marketingCarrier marketingCarrier



100

/flightIndex [2] /groupOfFlights [1] / BA flightDetails [1] /flightInformation/ /flightInformation/ companyId/ operatingCarrier

101


102


103

/flightIndex [2] /groupOfFlights N [1] /flightDetails [1] / flightInformation/addProd flightInformation/addProductDetail/ uctDetail/ electronicTicketing

104


105


106


107


108

/flightIndex [2] /groupOfFlights [1] / LGW flightDetails [2] /flightInformation/ /flightInformation/ location [1] / locationId

109


110

/flightIndex [2] /groupOfFlights [1] / BA flightDetails [2] /flightInformation/ /flightInformation/ companyId/ companyId/ marketingCarrier marketingCarrier

111

/flightIndex [2] /groupOfFlights [1] / BA flightDetails [2] /flightInformation/ /flightInformation/ companyId/ operatingCarrier

112

/flightIndex [2] /groupOfFlights [1] / 2362 flightDetails [2] /flightInformation/ /flightInformation/ flightNumber Copyright © 1987-2015 Amadeus IT Group SA. Page 50 of 714


113


114

/flightIndex [2] /groupOfFlights N [1] /flightDetails [2] / flightInformation/addProd flightInformation/addProductDetail/ uctDetail/ electronicTicketing

115


116


117


118

/flightIndex [1] /groupOfFlights [1] / CO propFlightGrDetail/flightProposal [3] / ref

119


120


121


122


123


124

/flightIndex [2] /groupOfFlights [2] / 1 flightDetails [1] /flightInformation/ /flightInformation/ productDateTime/ productDateTime/ dateVariation dateVariation

125

/flightIndex [2] /groupOfFlights [2] / IAH flightDetails [1] /flightInformation/ /flightInformation/ location [1] / locationId Copyright © 1987-2015 Amadeus IT Group SA. Page 51 of 714


126


127


128

/flightIndex [2] /groupOfFlights [2] / CO flightDetails [1] /flightInformation/ /flightInformation/ companyId/ operatingCarrier

129


130


131


132


133


134


135


136


137


138

/flightIndex [2] /groupOfFlights [2] / AF flightDetails [2] /flightInformation/ /flightInformation/ companyId/ companyId/ marketingCarrier marketingCarrier Copyright © 1987-2015 Amadeus IT Group SA. Page 52 of 714

UG WBS Fare MasterPricerTravelBoardSearch 16.1

Recommend Documents