V2
User's Guide

Interface: PoweredAir


Introduction

The PoweredAir interface has been designed and implemented to facilitate the retrieval of seat map information, flight availability, schedule and timetable information, and to manage negotiated space inventories.

The AIR operations have been catagorised into the following functions:

MultiAvailability

Operations that will retrieve flight availability, schedules, and timetable information including dual city pair availability options.

CreateNegoSpace

Operations for allocating negociated space within the Amadeus system.

CreatePassiveNegoSpace

This function provides the capability to create passive negotiated space within the Amadeus system.

ChangeNegoSpace

Operation that will change exisiting negociated space elements.

CancelNegoSpace

Operations that will cancel existing negociated space elements.

DisplayNegoSpace

Operations that will return existing negociated space details.

RetrieveSeatMap

Seat maps may be requested for flights of Amadeus system user airlines and other airlines that hold an interactive seat map agreement with Amadeus.

FlightInfo

The Flight Information function provides Amadeus end-users with up-to-date information related to the operation of a particular flight before, during and after departure.

RebookAirSegment

The RebookAirSegment function enables you to rebook existing segments in a PNR.

Considerations

Negotiated Space

Airlines that participate in negotiated space can provide selected agents with designated inventory. The seats given are blocked within the airline's own inventory and are available for sale in the Amadeus system.

Only specified agents have the ability to create, update, and sell negotiated space. The agents allowed to sell from the negotiated space are referred to as the "owners" of the negotiated space. The owner is either a single Amadeus office identifier or a group of offices.

Once the negotiated space has been agreed upon, the airline creates a reserved block of seats in their host system and a similar reserved block of seats is created in the Amadeus system. After the space is created each system attaches an identification number (ALID - Airline system ID and 1AID - Amadeus system ID) to the allocated space which is obtainable when the negotiated space details are retrieved.

The way in which the two system inventories are synchronized depends upon the type of negotiated space created. Three types of negotiated space can exist;

Active

When a block of negotiated space is "active", all sales are reported to the airline when the reservation is ended.

Interactive

When a block of negotiated space is "interactive", all sales are reported interactively to the airline at the time of sale.

Passive

When a block of negotiated space is "passive", there is no communication at all with the airline and the agent must report the passenger names manually to the airline.


Negotiated space allocations can be created in the following manner for non-stop and direct flights only;


At creation time, the negotiated space can be defined with an expiry date. When this date is reached, the number of unsold seats is automatically set to zero by the system. It can also be defined with a reduction date and amount. When this date is reached, the number of unsold seats is automatically reduced by a specific percentage amount.

**NOT YET IMPLEMENTED**, This feature is not currently available through the API interface.

Negotiated Space User Security

Airline Handling Tables

The different options and default values controlling Negotiated Space allotment creation and synchronization are managed through a hierarchy of Negotiated Space Handling Tables. These tables are controlled by the airline. For each airline participating in Negotiated Space, there is a Default Handling Table. Exception Handling Tables can be established for the carrier for a corporation, a corporation and a city, a corporation and a country, an office ID or an office ID and a specific sign.

The following is a list of the different levels of security;

Level Description Example
5Sign0001AA/SEA6N2105
4OfficeSEA6N2105
3Corporation + City6N2SEA
2Corporation + Country6N2US
1Corporation6N2
0Airline DefaultPU

The airline may have a collection of exception handling tables for specific signs, offices, and corporations. It is possible to select a particular handling table to use when creating negotiated space by specifying the following options in the creation entry;

Sign level
Office level
Corporate code level
Corporate code level and city
Corporate code level and country

If no specifications are made for a specific handling table at the time the negotiated space is created, the Amadeus system will search the airline handling tables and find an applicable handling table for the user. If no specific match is found for the user, the airline default-handling table will be utilized.

The specific airline-handling table associated to negotiated space agents is strictly between the agent and the airline and must be set up directly with the airline.

Inventory

Negotiated space is controlled by a security package, and only the owners of the negotiated space are entitled to view the number of available seats, update it, and sell from it. Other users have no means to know that the negotiated space even exists.

There are two ways in which the negotiated space availability may be returned:


The way in which negotiated space is returned depends on the agreements in place between each airline and the agency. So that an agency can request a negotiated space block posting either from the two ways anounced above or solely from a Negotiated space dedicated availability.

Neutral availability

In a neutral availability response, negotiated space is indicated in the standard Amadeus Availability and Schedule responses. The number of seats returned is the actual number of seats allocated by the airline for the standard response, unless the flight is one of a negotiated space agreement. In which case, the number of seats indicated for that flight would be the number of actual negotiated seats available for sale. If however, the number of negotiated seats has been completely depleted and there still remains seats in the standard availability, the number of seats returned will be the number of remaining seats for sale from the standard availability and zero will not be returned. Note that in any case, the maximum number available that will be shown at any given time will be 9, even if a greater number available exists.

Negotiated space dedicated availability

The negotiated space availability response will include the exact number of negotiated seats available for sale. If all of the negotiated space seats have been sold, the flight will not be returned in the response with zero no the class posting. Since negotiated space may only be allocated for non-stop and direct flights, only these types of flights will be returned.

Flights with multiple classes of negotiated space with the same tour name, tour reference and owner field are merged into a single flight item in the response.

Options that can be use by an agent in a Negotiated Space Availability request:


Limitations

At this time, there are no known limitations for the PoweredAir interface. Any limitations specific to a function are identified within the associated section of this document.

Unsupported Functions

Not applicable.

Prerequisites

There are no prerequisites to using the PoweredAir Interface. Any prerequisites specific to a function is identified within the associated section of this document.





Function: MultiAvailability


Overview

The MultiAvailability function provides operations to request the following flight information for participating airlines within the Amadeus System:


Availability

The Amadeus Global Distribution System stores flight availability for any airline holding a sales agreement with Amadeus. Flight availability details are returned for any flight with at least one seat available for sale or waitlist, based on availability request criteria specified.

Flights up to 361 days in the future and up to 3 days in the past are stored in the system. Flights in the past are returned without availability status codes.

In the framework of Negotiated Space product, the Negotiated space availability permits to display the number of seats available on a Block.

The FUNC field of the Airline Handling Table (or Exception Handling Table) is defined to determine the type of avaibility from which an office entitled to Negotiated space will be able to sell block seats.

When the FUNC indicator is set to "1", the user is able to display blocks from a neutral availability and a Negotiated Space availability both. In that case, the user can perform long sell and short sell entries.

When FUNC indicator is set to "2", the user is able to display block only from a Negotiated Space Availability request. Agents can use only the short sell entry to book seats on Negotiated Space.

In all the cases, when seats are available within the block, the block posting is returned.

Types of Availability:

Four basic types of Availability may be requested

Neutral availability

An unbiased availability for all flights matching the city pair specified.

Availability by departure time

Availability returned for those flights that closely match the departure time specified.

Availability by arrival time

Availability returned for those flights that closely match the flight arrival time specified.

Availability by elapsed travel time

Availability returned for flights that closely match the elapsed travel time specified.

In addition, the basic availability requests may be customized to provide the following:

A seven day search

Availability of flights for 7 days after the date specified.

Dual city pair availability

Availability for two city-pairs at the same time.

Scrolling is allowed on any part of the dual display (first part, second part or both)

A carrier specific availability

Availability biased to a specified carrier only

A direct access carrier availability

Availability obtained through a real-time link between Amadeus and the specific carrier, providing last seat availability from within the specific carrier inventory.

A multi-modal availability

Availability for a city pair that includes air and non-air services connecting between the cities.

Timetables

The Amadeus Global Distribution System stores flight timetable information for any airline who submits the information, participating and non-participating airlines alike. Timetable information specifies the following operation details specific to flight.


Classes of service are not returned in a timetable response and selling from a timetable is not possible.

Types of Timetable:

Four basic types of timetables may be requested;

Neutral Timetable

If you request a neutral timetable, flights are returned based on the departure date and/or time specified and on the elapsed travel time.

Timetable by departure time

If you request a timetable by departure time, flights are returned based on the departure date and/or time specified.

Timetable by arrival time

If you request a timetable by arrival time, flights are returned based on the arrival date and/or the time specified.

Timetable by elapsed travel time

If you request a timetable by elapsed time, flights are returned based on the elapsed travel time.

Elapsed travel time is calculated, as the time from the departure time to the time of arrival, including any layover or connection time required for the trip.

Negotiated Space Availability

Availability returned for the Negotiated Spaces blocks present within all flights matching the city pair specified.

Schedules

The Amadeus Global Distribution System stores flight schedule information for any who submits the information, participating and non-participating airlines alike. You can see up to a maximum of 26 classes of service.

For airlines that have a sales agreement with Amadeus, the response will include all scheduled flights with availability status codes by class of service including classes of service that have no availability. It is possible to sell or waitlist space from the schedule returned. For airlines that do not have a sales agreement with Amadeus, the response will include only non-stop and direct flights scheduled with class codes. There is no indication of class availability and therefore it is not possible to sell or waitlist space form the schedule returned.

A schedule response is very similar to an availability response. However, the following differences should be noted:


Types of Schedule

Four basic types of schedules may be requested;

Neutral schedule

An unbiased schedule is returned for all flights matching the city pair specified.

Schedule by departure time

A schedule is returned for those flights that closely match the departure time specified.

Availability by arrival time

A schedule is returned for those flights that closely match the flight arrival time specified.

Availability by elapsed travel time

A schedule is returned for those flights that closely match the elapsed travel time specified.

In addition, the basic schedule requests may be customized to provide the following;

A seven day search

Schedule of flights for 7 days after the date specified.

Dual city pair schedule

Schedule for two city pairs at the same time.

A carrier specific schedule

Schedule biased to a specified carrier only

A direct access carrier schedule

Schedule obtained through a real-time link between Amadeus and the specific carrier, providing last seat availability from within the specific carrier inventory.

Schedule for specific Flight

Schedule returned for a specific flight number. This option is available only to specific system users with extended security agreements.

A multi-modal schedule

Schedule for a city pair that includes air and non-air services connecting between the cities.

Supported Operations

Availability Display Classification

The following displays are best suited to the Multi-availability function:

Neutral availability allows you to view all the flights in the order required by your market regulations and includes flights departing up to one hour before the departure time you specify. If you do not specify a time, the display includes all flights departing up to one hour before the current time or flights departing from 0000 (midnight) on the day of departure (for a future date).

Note that if you are entitled to sell Negotiated Space in FUNC1 and if you are owner of a block in a returned flight the Negotiated space class posting will be returned in all cases except if there are no available seats on the block.

A display by departure time shows flights in order of departure and starts with flights departing up to one hour before the time you specify. If you do not specify a time, the display starts with flights departing up to one hour before the current time (for the current date) or flights departing from 0000 (midnight) on the day of departure (for a future Date).

A display by arrival time shows flights in order of arrival and starts with flights arriving up to two hours before the time you specify. If you do not specify a time, the display starts with flights arriving up to two hours before the current time (for the current date) or flights arriving from 0000 (midnight) on the day of arrival (for a future date).

A display by Elapsed travel time shows flights in the Order determined by the following calculation: the actual Elapsed flight time (including stopover and connecting time) plus the time between the departure time you specify and the actual departure time of the flight.

You can see up to a maximum of 26 classes of service.

Negotiated space Availability allows an owner of Negotiated blocks to display information on his blocks present on all flights matching with his availability request. The following elements are displayed: Flight information, Block status, Owner, Tour name, Tour reference, Class, and exact posting of the class.

The following options can be used to further customise your queries:

Basic, one-way

To request an availability display, for a one-way routing.

Basic, round trip

To request an availability display for a round trip.

Current date

If a date is not specified when requesting an availability display the system assumes the current date as the default date at the point of departure.

Current date and time

If a date is not specified when requesting an availability display the system assumes the current date as the default date at the point of departure. If you do not specify a time of departure (or arrival, for a display by arrival time), the system assumes the current time at the point of departure (for the current date) or 0000 (for a future date).

Note: Time can be specified as 12-hour clock format and or as 24-hour clock format depending on your agent sign preference for time.

Day of the week

If a date is not specified when requesting an availability display the system assumes the current date as the default date at the point of departure. The date can be specified using a 2-letter code, such as MO, TU, WE, TH, FR, SA and SU. Or with numbers, as follows: - 1, 2, 3, 4, 5, 6 and 7

Departure city from office profile

If you do not specify the city or airport of origin, the system assumes the city associated to your office profile.

Multi-airport city, all airports or a specific airport

If you specify the code for a city that is served by more than one airport, the availability display will show flights for all of those airports. To restrict availability to a single Airport, for a multi-airport city, use the airport code in your request entry rather than the city code.

Direct access availability

Direct access provides you with direct access to the reservation systems of major airlines. Using standard Amadeus entries, you can obtain current information on availability of Seats through a real-time link between Amadeus and the airline. By accessing the airline's reservation system directly, you can see the last seat available on a flight, without the airline rejecting the booking after end transaction. Flights can be sold even if they are on request, or show a waitlist status on other types of Amadeus display. You can see up to a maximum of 26 classes of service in a direct access display.

All Amadeus users can directly access the inventory systems of the airlines that have a direct access agreement with Amadeus.

Seven Day search

The seven-day search option allows you to search for the first flight available for sale within a seven-day period from the date you specify in your entry. It should be noted that the date of the flight might be different from the date you specified if there are no flights available for that date, days within the seven-day period.

Carrier-preferred Display

It is possible to request an availability display that is controlled by a target airline. This can be done for any airline that has a carrier preferred display agreement with Amadeus. (By default a City Ticketing Office (CTO) or an Airport Ticketing Office (ATO). Carrier Preferred Availability shows flights that the airline has chosen to display for the route you specify in your entry. This type of availability is useful when the customer wants to travel only on that airline, or on other airlines or flights selected by the target carrier, it is possible to use any of the availability display options when requesting carrier-preferred availability.

A carrier-preferred display includes flights operated by the specified airline only, even if other airlines offer earlier or more direct flights. If the specified airline does not offer flights on the specified route, the display may show flights operated by the specified airline's affiliated airlines. The display can also include routings that, due to long elapse flying times or excessive mileage, and would normally be excluded from a basic Amadeus availability display.

Limitations

There are currently no limitations at this time.

Unsupported Operations

Not applicable.

Prerequisites

For the SevenDay search and ForwardScan option the Extended ownership security (EOS) must exist for the office as this controls the way that agents and offices can retrieve data created by other offices or Corporations.

The Specific Flight option requires an end of extended security agreement for the system user. This option is not supported for all users.

Building A Query

Depending on the flavor of the API that is used, each query will follow a given structure. The queries for the function operations are clearly explained with data element examples in a generic table view that can be adapted to the specific flavor of the API in use.

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 on which fields are mandatory for basic operation utilization. It is not a full explanation of every field that can be utilised for the operation, but rather a guideline to its use.

Receiving A Reply

MultiAvailability specific

ActionCode

This field must contain the type of request using the relevant codeset.

SubActionCode

This field is mostly use in a scrolling entry in a dual context, to specify to which part of the display the scrolling must apply (it can be the first part, the second part or both).

TypeOfRequest

It is possible to determine the type of display for the reply by changing the value specified for the data element typeOfRequest for a MultiAvailability display. In the extract from an Operation example listed below, it has specified the values 'TN' for a neutral display and TT for a Negotiated Space display. However, it can be replaced with one of the other options listed below:

PoweredAir_MultiAvailability - Data element Value
/requestSection/availabilityOptions/productTypeDetails/ typeOfRequestTN

MultiAvailability Display options:

TABy arrival time
TDBy departure time
TEBy elapsed time
TNIn neutral order
TTTT Negotiated Space Availability
SFSpecific Flight ** Restricted to specific users **

It should also be noted that the order in which flights appear on an availability display depends on the type of availability you request and (for all types) the regulations that apply in your own market.

For the Negotiated Space Availability the displays are ordered by departure time in ascending order.

There are four different flight types:

Non-Stop Flight

A flight with 'NO' intermediate stops, and the same flight number and aircraft - EU flights shown by Departure time (earliest to latest).

Direct Flight

A flight with intermediate stop(s) and the same flight number and aircraft - EU flights shown by Elapsed flight time (shortest to longest).

Connecting Flight

a flight with intermediate stop(s) and a change of flight number and aircraft - EU connecting flights are shown by Elapsed flight time and they include flights with an equipment change en route.

Change-Of-Gauge

Connecting flight with intermediate stops and change of aircraft EU display the COG as connection.


European Union regulations apply in most Amadeus markets except the US NMC.

Order of flights on US (DOT set to yes in the office profile) displays. The order of flights described below applies to all types of Availability Display, except that within each category Direct flights or 2-segment Interline connections; for example, flights are sorted according to the display type. Such as, by Departure time, rather than Elapsed flight time, for a display by Departure time. Flight categories are never mixed.

  1. Non-stop flights, by departure time (earliest to latest)
  2. Direct and change-of-gauge flights, by Elapsed flight time (shortest to longest). Change-of-gauge flights shown on one line with EQV as the equipment code.
  3. 2-segment online connections, by Elapsed flight time
  4. 2-segment interline connections, by Elapsed flight time
  5. 3-segment connections, by Elapsed flight time. No sorting between online and interline to default to the DOT display, US NMC users must have the 'dept of transport dsply' indicator set to 'yes' in their office profiles.

Reply Structure

The actionCode 45 indicates that this is a reply to an Availability request.


Double Click To Show XML

1 45 3 LON SYD 4 50 ** AMADEUS AVAILABILITY - AN ** 122 FR 15OCT 800A 4 51 THREE SEGMENT CONNECTIONS MIGHT EXIST PLEASE ENTER -MD- 151004 2215 161004 1535 LHR BKK BA QF 7312 S 701 ET 1 F 9 EQV 0 4 2 1A LSA M 161004 1815 171004 0605 BKK SYD BA 9 E ET F 9 744 0 2250 2 1 1A LSA M 151004 2200 161004 1530 LHR BKK BA 9 S ET 2 F 8 744 0 4 2 1A LSA M 161004 1820 171004 0610 BKK SYD BA QF 7312 E 701 ET F 9 EQV 0 2310 1A LSA M

Error Messages

Unsuccessful Creations - Multi-availability entry

These error messages can be received using the Multi-Availability transaction. They are interactive free text messages that are either Error and or Warning messages. These messages are divided into three differenct categories, such as level 2; these are Errors and or Warnings regarding processing. Level 3 of this category indicates city pair error messages and or Warnings. Level 4 are reserved for flight level warning messages. As the number of text messages are vast as they cover the whole Amadeus system they are not listed. However, below is an example showing the format of one such message indicating the text that an entry added to a query is not authorised.

PoweredAir_MultiAvailabilityReply - Data element Value
/errorOrWarningSection/errorOrWarningInfo/error/ codeBJV
/errorOrWarningSection/errorOrWarningInfo/error/ type001
/errorOrWarningSection/errorOrWarningInfo/error/ listResponsibleAMD
/errorOrWarningSection/textInformation/freeTextQualification/ codedIndicator3
/errorOrWarningSection/textInformation/ freeTextENTRY NOT AUTHORISED



Operation: MultiAvailability Request

Simple availability with connection location, BKK.

Query Structure


Double Click To Show XML

1 44 151004 0800 LON SYD F BKK 5 BA TN

Possible Errors

See "Error Messages" section


Operation: Basic Request With Selected Carrier

Basic Multi-Availability Request with a Selected Carrier, AF and DL.

Query Structure


Double Click To Show XML

44 151004 NCE NYC AF DL TN

Possible Errors

See "Error Messages" section


Operation: Connection & Class of Service

MultiAvailability with connections and class of service selected.

Query Structure


Double Click To Show XML

44 151004 NCE NYC PAR ORY 700 3 2 TN

Possible Errors

See "Error Messages" section


Operation: Class Of Service & Carrier

MultiAvailability with different class of services selected and more than one carrier selected

Query Structure


Double Click To Show XML

44 151004 NCE NYC Y K PAR AF DL TN

Possible Errors

See "Error Messages" section


Operation: Negotiated Space in a Neutral availability Request

MultiAvailability with one class of services selected and one carrier. In the folowing example all optional fields have been completed to illustrate all of them.

Query Structure


Double Click To Show XML

44 201106 FRA BRE Y LH 342 TN

Possible Errors

See "Error Messages" section.


Operation: Negotiated Space dedicated availability Request

MultiAvailability with one class of services selected and one carrier In the folowing example all optionals fields have been completed to illustrate all of them.

Query Structure


Double Click To Show XML

44 301006 ORY MRS Y AF 6002 MONTOURTESTAIRF BDLRYD TT

Possible Errors

See "Error Messages" section.


Operation: Seven Day Search

The 7-Day search request option is available to all users. The 7-Day Search mode is not allowed for TimeTable. The actual search period is up to eight days, input date plus seven days. When no flights have been found during the 7-Day search process warning messages are issued.

This excerpt shows the entry used for a query illustrating the departure Date 051201 The type 'SEV' indicates that this is a seven day search.

Note: the format of the date is six characters - if you enter the date format incorrectly, you will receive erroneous results, such that the first available date is greater than the seven days limited to this option.

PoweredAir_MultiAvailability - Data element Value
/requestSection/availabilityProductInfo/availabilityDetails/ departureDate051201
/requestSection/availabilityOptions/optionInfo/ typeSEV
/requestSection/availabilityOptions/optionInfo/ arguments31

Hence, the first first flight available is the very next day 06dec.

PoweredAir_MultiAvailabilityReply - Data element Value
/singleCityPairInfo/cityPairFreeFlowText[2]/ freeText[1]FIRST FLIGHT AVAILABLE 06DEC

Query Structure


Double Click To Show XML

1 44 051201 LON SLU Y BA TN SEV

Possible Errors

See "Error Messages" section


Operation: Forward Search

ForwardScan uses the same option as the 7-Day search, the difference is that when an argument is added such as to specify the number of days - this automatically converts the query to ForwardScan. Maximum number of days scanned is 31 days. Carrier Preferrred AND Extended Ownership is mandatory to use this function and ForwardScan is restricted to City Ticketing Office (CTO) or an Airport ticketing Office (ATO).

This excerpt shows the entry used for a query illustrating the departure Date 051201 The type 'SEV' indicates that this is a seven day search, however when the argument is added the search expands and subsequently the search turns into a ForwardScan.

Note: the format of the date is six characters - if you enter the date format incorrectly, you will receive erroneous results, such that the first available date is greater than the seven days limited to this option.

PoweredAir_MultiAvailability - Data element Value
/requestSection/availabilityProductInfo/availabilityDetails/ departureDate051201
/requestSection/availabilityOptions/optionInfo/ typeSEV
/requestSection/availabilityOptions/optionInfo/ arguments31

Hence, the first first flight available is the very next day 06dec.

PoweredAir_MultiAvailabilityReply - Data element Value
/singleCityPairInfo/cityPairFreeFlowText[2]/ freeText[1]FIRST FLIGHT AVAILABLE 06DEC

Query Structure


Double Click To Show XML

1 44 051201 NCE NYC Y DL TN SEV 31

Possible Errors

See "Error Messages" section


Operation: Basic Schedule

Basic example using a schedule request.

Query Structure


Double Click To Show XML

1 48 151004 0800 LON SYD F BKK BA TN

Possible Errors

See "Error Messages" section


Operation: Complex Schedule

A complex example using a schedule request.

Query Structure


Double Click To Show XML

1 48 151004 NCE NYC PAR ORY 700 AF 2 TN

Possible Errors

See "Error Messages" section


Operation: More Complex Schedule

More complex example using a schedule request.

Query Structure


Double Click To Show XML

48 151004 NCE NYC Y K PAR AF DL TN

Possible Errors

See "Error Messages" section


Operation: Schedule For A Specific Flight

The following illustrates a schedule request for the specific flight of BA 009 from London to Sydney on 25June2002 departing at 0100;

Note: this option is not supported for all users and is restricted to specific users with extended security agreements only.

Query Structure


Double Click To Show XML

48 250602 0100 LHR SYD BA 009 SF

Possible Errors

See "Error Messages" section


Operation: Simple Timetable

Simple time table request.

Query Structure


Double Click To Show XML

51 030102 LON NYC TN

Possible Errors

See "Error Messages" section


Operation: Timetable With Airline Option

Simple timetable airline option request.

Query Structure


Double Click To Show XML

51 030102 LON NYC BA TN

Possible Errors

See "Error Messages" section


Operation: Request scrolling (MD) on previous entry

Scrolling on previous simple availability display

Query Structure


Double Click To Show XML

55 150106 lon mia tn

Possible Errors

See "Error Messages" section.






Function: CreateNegoSpace


Overview

The ability to create active or interactive negotiated space is dependent upon an extended ownership security (EOS) agreement between the airline and agency. Only specified agents are authorized to create the negotiated space on behalf of the airline.

This function provides the capability to create active or interactive single date negotiated space. Active or interactive Negotiated space may be created in two manners;

Single negotiated space

Single negotiated space is one that is created for a particular flight number, board-off point, and owner for a single date of operation.

Multiple negotiated space **NOT YET IMPLEMENTED**

Multiple negotiated space is create for a particular flight number, board-off point, and owner for an entire period, and if desired for selected days of operation.

Note: each allotment will still be for one single date only; multiple creating simply creates several allotments at one time.

When creating active or interactive negotiated space, the following elements are mandatory;


In addition to the mandatory fields, the following fields are optional;


**NOT YET IMPLEMENTED**, This feature is not currently available through the API interface.

Supported Operations

Currently, negotiated space may be created for a single date only. The following operations are available for creating a single negotiated space;

Simple creation

This operation allows the user to create a single negotiated space within Amadeus specifying only the mandatory data elements; airline, date of service, flight, city pair, class of service, quantity, nego owner details (negotiated space owner associated Handling Table).

With commencement date

A commencement date is used to specify when the sale from the negotiated space may begin.

With expiry date

An expiry date is used to specify when the sale of the negotiated space expires and will no longer be available.

With reduction date and amount

The reduction date and amount are used to specify a date when the unsold negotiated space levels may be reduced or set to zero.

With tour name

A tour name is used as a method for the airline to provide a meaningful name to a negotiated space that could relate to a particular product or range of products offered for sale through the negotiated space owners.

With tour name and tour reference

A tour reference is used in conjunction with the tour name to further detail the association of the negotiated space to a particular product or range of products offered for sale through the negotiated space owners. A tour reference may not exist without the presence of a tour name.

With authorization code

At creation time, an authorization code may be entered to identify the agent responsible for the creation of the negotiated space. This code is not used within Amadeus, but is made available for those agents/airlines who wish to maintain a record of such information.

With office level for handling table

At creation time, it is possible for the agent to specify a specific office level handling table to be utilized for the different options and default values controlling Negotiated Space allotment creation and synchronization.

With office level and sign level for handling table

At creation time, it is possible for the agent to specify a sign level handling table to be utilized for the different options and default values controlling Negotiated Space allotment creation and synchronization. When specifying a sign level table for usage, the agent sign sending the request will be associated as the specific sign level table requested. It is not possible to specify a specific user sign.

With corporate code level for handling table

At creation time, it is possible for the agent to specify a specific corporate level handling table to be utilized for the different options and default values controlling Negotiated Space allotment creation and synchronization.

It is possible to specify the following combinations for the corporate code;

  • Corporate code
  • Corporate code plus country
  • Corporate code plus city

Complex combination of optional elements

It is possible to combine all mandatory elements and multiple optional elements when creating the negotiated space.

Limitations

Not applicable.

Unsupported Operations

The following operations are not currently supported for creating negotiated space via the API;


Prerequisites

An agreement must exist between the airline and the agent for negotiated space. The Negotiated Space customers are advised and driven by the NMC who is in charge of the settings for all Airlines that are Passive Negotiated Space implemented. Therefore the NMC, for each customer, will set the appropriate parameters and the correct security.

Building A Query

Depending on the flavor of the API that is used, each query will follow a given structure. The queries for the function operations are clearly explained with data element examples in a generic table view that can be adapted to the specific flavor of the API in use.

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 on which fields are mandatory for basic operation utilization. It is not a full explanation of every field that can be utilised for the operation, but rather a guideline to its use.

Receiving A Reply

Reply Structure

Successful Creations

When creating negotiated space, the following response will be received in all cases that are successful;

PoweredAir_CreateNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code02562
/statusInformation/errorOrWarningInfo/error/ typeINF
/statusInformation/errorOrWarningInfo/error/ listResponsible1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator3
/statusInformation/textInformation/ freeTextOK - NEW NEGOTIATED SPACE CREATED
/recordLocator/reservation/ controlNumberAmadeus Record Locator of the allotment

Notice that the above response is in fact treated with a specific error code (02562), type (INF), and informational free text, and Amadeus record locator of the allotment.


Double Click To Show XML

Not applicable

Error Messages

Unsuccessful Creations

If the request was not successful, the negotiated space will not be created and an appropriate error message will be returned. The error message returned depends upon the specific situation encountered. The possible errors that are unique to a specific operation are covered in the individual operation scenarios within this document. The following outlines common errors that can be returned in any creation request.

Negotiated Space Entry Restricted

The following error response will be returned in all cases, if the airline has not granted permission to create negotiated space to the user attempting the request;

PoweredAir_CreateNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code 08528
/statusInformation/errorOrWarningInfo/error/ type EC
/statusInformation/errorOrWarningInfo/error/ listResponsible 1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator 3
/statusInformation/textInformation/ freeText NEGOTIATED SPACE ENTRY RESTRICTED

Negotiated Space Locn Handling Table Not Found

The following error response will be returned in all cases, if negotiated space handling table is not found in the Amadeus system;

PoweredAir_CreateNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code08667
/statusInformation/errorOrWarningInfo/error/ typeEC
/statusInformation/errorOrWarningInfo/error/ listResponsible1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator3
/statusInformation/textInformation/ freeTextNEGOTIATED SPACE LOCN HANDLING TABLE NOT FOUND

Invalid Owner ID

The following error response will be returned in all cases, if mandatory element - Owner ID - specified is not identified as a valid ID for creating negotiated space;

PoweredAir_CreateNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code05020
/statusInformation/errorOrWarningInfo/error/ typeEC
/statusInformation/errorOrWarningInfo/error/ listResponsible1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator3
/statusInformation/textInformation/ freeTextINVALID OWNER

Negotiated Space Already Exists

The following error response will be returned in all cases, if negotiated space already exists which exactly matches the criteria specified for creation; If the agent is registered to perform in function 1, he can not create two blocks with the same flight/date/class/owner. If the agent is registered to perform in function 2 he can not create two blocks with the same flight/date/class/owner/tourname/tourreference.

PoweredAir_CreateNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code03335
/statusInformation/errorOrWarningInfo/error/ typeEC
/statusInformation/errorOrWarningInfo/error/ listResponsible1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator3
/statusInformation/textInformation/ freeTextNEGOTIATED SPACE ALREADY EXISTS

Tour Name Required

The following error response will be returned in all cases, if the tour name element has been rendered as a mandatory element by the airline or in the location handling table;

PoweredAir_CreateNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code07854
/statusInformation/errorOrWarningInfo/error/ typeEC
/statusInformation/errorOrWarningInfo/error/ listResponsible1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator3
/statusInformation/textInformation/ freeTextTOUR NAME REQUIRE

Specify a tour name element and retry the request.

Amount of Reduction Required

The following error response will be returned in all cases, if the amount of reduction element has been rendered as a mandatory element by the airline or in the location handling table;

PoweredAir_CreateNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code07825
/statusInformation/errorOrWarningInfo/error/ typeEC
/statusInformation/errorOrWarningInfo/error/ listResponsible1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator3
/statusInformation/textInformation/ freeTextAMOUNT OF REDUCTION REQUIRED

Specify an amount of reduction and retry the request.

Reduction Date Required

The following error response will be returned in all cases, if the reduction date element has been rendered as a mandatory element by the airline or in the location handling table;

PoweredAir_CreateNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code07851
/statusInformation/errorOrWarningInfo/error/ typeEC
/statusInformation/errorOrWarningInfo/error/ listResponsible1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator3
/statusInformation/textInformation/ freeTextREDUCTION DATE REQUIRED



Operation: Simple Single Nego Space

The following structure is an example query to create a single negotiated space with the following mandatory elements;

AirlineLH
Date of service250601
Flight number400
City pairNCE LON
Class of serviceB
Quantity20
Negotiated space ownerMUC1A0701
Handling TableNCE1A0555

Query Structure


Double Click To Show XML

LH 400 B 250601 20 MUC1A0701 NCE1A0555 NCE LON

Possible Errors

See "Error Messages" section


Operation: Single Nego Space With Commencement Date

The following is an example of creating a single negotiated space with the optional field identifying the negotiated space to become effective for sale on 20/05/01.

Query Structure


Double Click To Show XML

LH 400 B 250601 200501 20 MUC1A0701 NCE1A0555 NCE LON

Possible Errors

See "Error Messages" section


Operation: Single Nego Space With Expiry Date

The following is an example of creating a single negotiated space with the optional field identifying when the negotiated space is to become no longer effective for sale on 25/05/01.

Query Structure


Double Click To Show XML

LH 400 B 250601 250501 20 MUC1A0701 NCE1A0555 NCE LON

Possible Errors

See "Error Messages" section


Operation: Single Nego Space With Reduction Date And Amount

The following is an example of creating a single negotiated space with the optional fields identifying the date the negotiated space is to be reduced and the amount to reduce it to;

Query Structure


Double Click To Show XML

LH 400 B 250601 20 MUC1A0701 200501 20 NCE1A0555 NCE LON

Possible Errors

See "Error Messages" section


Operation: Nego Space With Tour Name

The following is an example of creating a single negotiated space with the optional field identifying the tour name, HELLO TOURS, for negotiated space.

Query Structure


Double Click To Show XML

LH 400 B 250601 20 MUC1A0701 HELLO TOURS NCE1A0555 NCE LON

Possible Errors

See "Error Messages" section


Operation: Tour Name With Tour Reference

The following is an example of creating a single negotiated space with the optional field identifying the tour reference, 1298B, for the negotiated space with the tour name HELLO TOURS. Please note, it is not possible to specify a tour reference without a tour name.

Query Structure


Double Click To Show XML

LH 400 B 250601 20 MUC1A0701 HELLO TOURS 1298B NCE1A0555 NCE LON

Possible Errors

See "Error Messages" section


Operation: Single Nego Space With Authorization Code

The following is an example of creating a single negotiated space with the optional field identifying an authorization code, BW, for negotiated space.

Query Structure


Double Click To Show XML

LH 400 B 250601 20 MUC1A0701 BW NCE1A0555 NCE LON

Possible Errors

See "Error Messages" section


Operation: Single Nego Space With Office Id And Sign Level For Handling Table

The following is an example of creating a single negotiated space with the optional field identifying a sign level handling table to be used in the office ID level for the negotiated space.

Note: the sign level for the handling table cannot be specified without specifying an office ID level.

Query Structure


Double Click To Show XML

LH 400 B 250601 20 MUC1A0701 NCE1A0555 S NCE LON

Possible Errors

See "Error Messages" section


Operation: Single Nego Space With Corporate Code Level For Handling Table

The following is an example of creating a single negotiated space with the optional field identifying the corporate code level, 1A0, for the negotiated space instead of an office ID level.

Note: that the corporate code level and the office level share the same field structure element. Therefore, it is not possible to have a corporate code level and an office Id level specified.

Query Structure


Double Click To Show XML

LH 400 B 250601 20 MUC1A0701 1A0 NCE LON

Possible Errors

See "Error Messages" section


Operation: Corporate Code Level With City

The following is an example of creating a single negotiated space with the optional field identifying the corporate code level, 1A0, and a specific city code for the negotiated space.

Note: that the city code and the corporate code share the same field and that it may not be specified without the corporate code level.

Query Structure


Double Click To Show XML

LH 400 B 250601 30 MUC1A0701 HELLO TOURS 1A0PAR NCE LON

Possible Errors

See "Error Messages" section


Operation: Corporate Code Level With Country

The following is an example of creating a single negotiated space with the optional field identifying the corporate code level, 1A0, and a specific country for the negotiated space.

Note: that the country code and the corporate code share the same field and that it may not be specified without the corporate code level.

Query Structure


Double Click To Show XML

LH 400 B 250601 30 MUC1A0701 HELLO TOURS 1A0FR NCE LON

Possible Errors

See "Error Messages" section






Function: CreatePassiveNegoSpace


Overview

The ability to create passive negotiated space is dependent upon an extended ownership security (EOS) agreement between the airline and agency. Only specified agents are authorized to create the passive negotiated space on behalf of the airline.

Creating passive negotiated space is very similar to creating active or interactive negotiated space. When passive negotiated space is created, the inventory is held in the Amadeus system exactly in the same manner that active or interactive negotiated space is held. However, no messages are transmitted to the associated airline at any time regarding the passive negotiate space creation, update, deletion, sells, cancellations. It is the responsibility of the passive negotiated space agent to notify the airline directly of any negotiated space booking details.

This function provides the capability to create ONLY passive negotiated space. Passive Negotiated space may be created in two manners;

Single negotiated space

Single negotiated space is one that is created for a particular flight number, board-off point, and owner for a single date of operation.

Multiple negotiated space **NOT YET IMPLEMENTED**

Multiple negotiated space is created for a particular flight number, board-off point, and owner for an entire period, and if desired for a selected days of operation.

Note: that each allotment will still be for one single date only; multiple creating simply creates several allotments at one time.

When creating passive negotiated space, the following elements are mandatory;


In addition to the mandatory fields, the following fields are optional or mandatory depending on the configuration of the Airline Handling table or of the specific configuration table associated with the agent who performs the request;


**NOT YET IMPLEMENTED**, This feature is not currently available through the API interface.

Supported Operations

Currently, negotiated space may be created for a single date only. The following operations are available for creating a single negotiated space;

Simple creation

This operation allows the user to create a single negotiated space within Amadeus specifying only the mandatory data elements; airline, date of service, flight, city pair, class of service, quantity, and nego owner details (negotiated space owner associated Handling Table).

With commencement date

A commencement date is used to specify when the sale from the negotiated space may begin.

With expiry date

An expiry date is used to specify when the sale of the negotiated space expires and will no longer be available.

With reduction date and amount

The reduction date and amount are used to specify a date when the unsold negotiated space levels may be reduced or set to zero.

With tour name

A tour name is used as a method for the airline to provide a meaningful name to a negotiated space that could relate to a particular product or range of products offered for sale through the negotiated space owners.

With tour name and tour reference

A tour reference is used in conjunction with the tour name to further detail the association of the negotiated space to a particular product or range of products offered for sale through the negotiated space owners. A tour reference may not exist without the presence of a tour name.

With authorization code

At creation time, an authorization code may be entered to identify the agent responsible for the creation of the negotiated space. This code is not used within Amadeus, but is made available for those agents/airlines who wish to maintain a record of such information.

With office level for handling table

At creation time, it is possible for the agent to specify a specific office level handling table to be utilized for the different options and default values controlling Negotiated Space allotment creation and synchronization.

With office level and sign level for handling table

At creation time, it is possible for the agent to specify a sign level handling table to be utilized for the different options and default values controlling Negotiated Space allotment creation and synchronization. When specifying a sign level table for usage, the agent sign sending the request will be associated as the specific sign level table requested. It is not possible to specify a specific user sign.

With corporate code level for handling table

At creation time, it is possible for the agent to specify a specific corporate level handling table to be utilized for the different options and default values controlling Negotiated Space allotment creation and synchronization.

It is possible to specify the following combinations for the corporate code;

  • Corporate code
  • Corporate code plus country
  • Corporate code plus city

Complex combination of optional elements

It is possible to combine all mandatory elements and multiple optional elements when creating the negotiated space.

Limitations

Not applicable.

Unsupported Operations

The following operations are not currently supported for creating negotiated space via the API;


Prerequisites

An agreement must exist between the airline and the agent for negotiated space. The Negotiated Space customers are advised and driven by the NMC who is in charge of the settings for all Airlines that are Passive Negotiated Space implemented. Therefore the NMC, for each customer, will set the appropriate parameters and the correct security.

Building A Query

Depending on the flavor of the API that is used, each query will follow a given structure. The queries for the function operations are clearly explained with data element examples in a generic table view that can be adapted to the specific flavor of the API in use.

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 on which fields are mandatory for basic operation utilization. It is not a full explanation of every field that can be utilised for the operation, but rather a guideline to its use.

Receiving A Reply

Reply Structure

Successful Creations

When creating negotiated space, the following response will be received in all cases that are successful;

PoweredAir_CreatePassiveNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code02562
/statusInformation/errorOrWarningInfo/error/ typeINF
/statusInformation/errorOrWarningInfo/error/ listResponsible1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator3
/statusInformation/textInformation/ freeTextOK - NEW NEGOTIATED SPACE CREATED
/recordLocator/reservation/ controlNumberAmadeus Record Locator of the allotment

Notice that the above response is in fact treated with a specific error code (02562), type (INF), and informational free text, and Amadeus record locator of the allotment.


Double Click To Show XML

Not Applicable

Error Messages

Unsuccessful Creations

If the request was not successful, the negotiated space will not be created and an appropriate error message will be returned. The error message returned depends upon the specific situation encountered. The possible errors that are unique to a specific operation are covered in the individual operation scenarios within this document. The following outlines common errors that can be returned in any creation request.

Negotiated Space Entry Restricted

The following error response will be returned in all cases, if the airline has not granted permission to create negotiated space to the user attempting the request;

PoweredAir_CreatePassiveNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code 08528
/statusInformation/errorOrWarningInfo/error/ type EC
/statusInformation/errorOrWarningInfo/error/ listResponsible 1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator 3
/statusInformation/textInformation/ freeText NEGOTIATED SPACE ENTRY RESTRICTED

Negotiated Space Locn Handling Table Not Found

The following error response will be returned in all cases, if negotiated space handling table is not found in the Amadeus system;

PoweredAir_CreatePassiveNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code08667
/statusInformation/errorOrWarningInfo/error/ typeEC
/statusInformation/errorOrWarningInfo/error/ listResponsible1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator3
/statusInformation/textInformation/ freeTextNEGOTIATED SPACE LOCN HANDLING TABLE NOT FOUND

Invalid Owner ID

The following error response will be returned in all cases, if mandatory element - Owner ID - specified is not identified as a valid ID for creating negotiated space;

PoweredAir_CreatePassiveNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code05020
/statusInformation/errorOrWarningInfo/error/ typeEC
/statusInformation/errorOrWarningInfo/error/ listResponsible1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator3
/statusInformation/textInformation/ freeTextINVALID OWNER

Negotiated Space Already Exists

The following error response will be returned in all cases, if negotiated space already exists which exactly matches the criteria specified for creation.If the agent is registered to perform in function 1, he can not create two blocks with the same flight/date/class/owner. If the agent is registered to perform in function 2 he can not create two blocks with the same flight/date/class/owner/tourname/tourreference

PoweredAir_CreatePassiveNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code03335
/statusInformation/errorOrWarningInfo/error/ typeEC
/statusInformation/errorOrWarningInfo/error/ listResponsible1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator3
/statusInformation/textInformation/ freeTextNEGOTIATED SPACE ALREADY EXISTS

Tour Name Required

The following error response will be returned in all cases, if the tour name element has been rendered as a mandatory element by the airline or in the location handling table;

PoweredAir_CreatePassiveNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code07854
/statusInformation/errorOrWarningInfo/error/ typeEC
/statusInformation/errorOrWarningInfo/error/ listResponsible1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator3
/statusInformation/textInformation/ freeTextTOUR NAME REQUIRE

Specify a tour name element and retry the request.

Amount of Reduction Required

The following error response will be returned in all cases, if the amount of reduction element has been rendered as a mandatory element by the airline or in the location handling table;

PoweredAir_CreatePassiveNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code07825
/statusInformation/errorOrWarningInfo/error/ typeEC
/statusInformation/errorOrWarningInfo/error/ listResponsible1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator3
/statusInformation/textInformation/ freeTextAMOUNT OF REDUCTION REQUIRED

Specify an amount of reduction and retry the request.

Reduction Date Required

The following error response will be returned in all cases, if the reduction date element has been rendered as a mandatory element by the airline or in the location handling table;

PoweredAir_CreatePassiveNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code07851
/statusInformation/errorOrWarningInfo/error/ typeEC
/statusInformation/errorOrWarningInfo/error/ listResponsible1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator3
/statusInformation/textInformation/ freeTextREDUCTION DATE REQUIRED

Specify a reduction date and retry the request.



Operation: Passive Single Nego Space

The following structure is an example query to create a single negotiated space with the following mandatory elements;

AirlineLH
Date of service250601
Flight number400
City pairNCE LON
Class of serviceB
Quantity20
Negotiated space ownerMUC1A0701
Handling TableNCE1A0555

Query Structure


Double Click To Show XML

LH 400 B 250601 20 MUC1A0701 NCE1A0555 NCE LON

Possible Errors

See "Error Messages" section


Operation: Passive Single Nego Space With Commencement Date

The following is an example of creating a single passive negotiated space with the optional field identifying the negotiated space to become effective for sale on 20/05/01.

Query Structure


Double Click To Show XML

LH 400 B 250601 200501 20 MUC1A0701 NCE1A0555 NCE LON

Possible Errors

See "Error Messages" section


Operation: Passive Single Nego Space With Expiry Date

The following is an example of creating a single passive negotiated space with the optional field identifying when the negotiated space is to become no longer effective for sale on 25/05/01.

Query Structure


Double Click To Show XML

LH 400 B 250601 250501 20 MUC1A0701 NCE1A0555 NCE LON

Possible Errors

See "Error Messages" section


Operation: Passive Single Nego Space With Reduction Date & Amount

The following is an example of creating a single negotiated space with the optional fields identifying the date the negotiated space is to be reduced and the amount to reduce it to;

Reduction Date200501
Reduction Amount20

Query Structure


Double Click To Show XML

LH 400 B 250601 20 MUC1A0701 200501 20 NCE1A0555 NCE LON

Possible Errors

See "Error Messages" section


Operation: Passive Single Nego Space With Reduction Date & Amount

The following is an example of creating a single negotiated space with the optional fields identifying the date the negotiated space is to be reduced and the amount to reduce it to;

Reduction Date200501
Reduction Amount20

Query Structure


Double Click To Show XML

LH 400 B 250601 20 MUC1A0701 200501 20 NCE1A0555 NCE LON

Possible Errors

See "Error Messages" section


Operation: Passive Single Nego Space With Tour Name

The following is an example of creating a single passive negotiated space with the optional field identifying the tour name, HELLO TOURS, for negotiated space.

Query Structure


Double Click To Show XML

LH 400 B 250601 20 MUC1A0701 HELLO TOURS NCE1A0555 NCE LON

Possible Errors

See "Error Messages" section


Operation: Passive Single Nego Space With Tour Name & Reference

The following is an example of creating a single passive negotiated space with the optional field identifying the tour reference, 1298B, for the negotiated space with the tour name HELLO TOURS.

Note: it is not possible to specify a tour reference without a tour name.

Query Structure


Double Click To Show XML

LH 400 B 250601 20 MUC1A0701 HELLO TOURS 1298B NCE1A0555 NCE LON

Possible Errors

See "Error Messages" section


Operation: Passive Single Nego Space With Authorization Code

The following is an example of creating a single passive negotiated space with the optional field identifying an authorization code, BW, for negotiated space.

Query Structure


Double Click To Show XML

LH 400 B 250601 20 MUC1A0701 BW NCE1A0555 NCE LON

Possible Errors

See "Error Messages" section


Operation: Passive Single Nego Space With Sign Level

The following is an example of creating a single passive negotiated space with the optional field identifying a sign level handling table to be used in the office ID handling table for the negotiated space.

Note: the sign level for the handling table cannot be specified without specifying an office ID level.

Query Structure


Double Click To Show XML

LH 400 B 250601 20 MUC1A0701 NCE1A0555 S NCE LON

Possible Errors

See "Error Messages" section


Operation: Passive Single Nego Space With Corporate Code

The following is an example of creating a single passive negotiated space with the optional field identifying the corporate code level, 1A0, for the negotiated space instead of an office ID level.

Note: that the corporate code level and the office level share the same field structure element. Therefore, it is not possible to have a corporate code level and an office Id level specified.

Query Structure


Double Click To Show XML

LH 400 B 250601 20 MUC1A0701 1A0 NCE LON

Possible Errors

See "Error Messages" section


Operation: Passive Single Nego Space With Corporate Code Level & City

The following is an example of creating a single passive negotiated space with the optional field identifying the corporate code level, 1A0, and a specific city code, PAR, for the negotiated space.

Note:that the city code and the corporate code share the same field and that it may not be specified without the corporate code level.

Query Structure


Double Click To Show XML

APIxml 30

Possible Errors

See "Error Messages" section






Function: ChangeNegoSpace


Overview

This function allows the agent to change existing negotiated space elements. When changing negotiated space elements, it is necessary to include the following mandatory negotiated space elements, which properly identify the specific negotiated space to modify;


Note: once the negotiated space has been created, an Amadeus system ID (1AID) is assigned to the negotiated space and becomes a mandatory element when requesting a change. If this ID is not known, it may be obtained by retrieving the negotiated space details via the Display Nego Space function.

In addition, if the negotiated space is further detailed with a Tour Name and a tour reference, these items must be included in the change request as well.

Supported Operations

The following operations are supported when changing negotiated space;

Change of allocated seat level

The original number of allocated negotiated seats can be modified to specify a new amount available for sale.

Change of commencement date

A commencement date can be modified to specify a new date for when the sale from the negotiated space may begin.

Change of expiry date

An expiry date can be modified to specify a new date for when the sale of the negotiated space expires and will no longer be available.

Change of reduction date

The reduction date can be modified to specify a new date for when the unsold passive negotiated space levels may be reduced or set to zero.

Change of reduction amount

The reduction amount can be modified to specify a new percentage amount to reduce the unsold negotiated space levels by when the reduction date is reached.

Limitations

At this time, there are no known limitations for the Change Negotiated Space function.

Unsupported Operations

Not applicable.

Prerequisites

A negotiated space must exist on the Amadeus system prior to requesting to change an element. A match on the mandatory elements provided in the change request must be found within the Amadeus system, or an error will be returned.

The User must have the appropriated authorization to update blocks. The User must be owner of the block.

The Amadeus ID for the negotiated space must be specified in the change request. This ID is not known until after the negotiated space is created. This may be retrieved by requesting the negotiated space information via the Display Nego Space function.

Building A Query

Depending on the flavor of the API that is used, each query will follow a given structure. The queries for the function operations are clearly explained with data element examples in a generic table view that can be adapted to the specific flavor of the API in use.

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 on which fields are mandatory for basic operation utilization. It is not a full explanation of every field that can be utilised for the operation, but rather a guideline to its use.

Receiving A Reply

Reply Structure

Successful Change

When changing negotiated space, the following response will be returned in all cases when the change is successful;

PoweredAir_ChangeNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code02563
/statusInformation/errorOrWarningInfo/error/ typeINF
/statusInformation/errorOrWarningInfo/error/ listResponsible1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator3
/statusInformation/textInformation/ freeTextOK - NEGOTIATED SPACE UPDATED

Note: the above response is in fact treated with a specific error code (02563), type (INF), and informational free text.


Double Click To Show XML

Not Applicable

Error Messages

Unsuccessful Change

If the request was not successful, the negotiated space will not be updated and an appropriate error message will be returned. The error message returned depends upon the specific situation encountered. The possible errors that are operational specific are covered in the individual operation scenarios within this document.

Invalid 1AID

When changing negotiated space, the following error will be returned in all cases when the Amadeus system ID for the negotiated space (1A ID) specified is not found;

PoweredAir_ChangeNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code03377
/statusInformation/errorOrWarningInfo/error/ typeEC
/statusInformation/errorOrWarningInfo/error/ listResponsible1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator3
/statusInformation/textInformation/ freeTextINVALID 1AID

Retrieve the negotiated space details and verify the 1AID specified is correct and retry the request.

Simultaneous Update

The change request is aborted and the following error is returned if the negotiated space is being simultaneously updated by more than one user. This includes the scenario of when the negotiated space is pending approval by the airline, whereas in fact the airline has a hold on the space.

PoweredAir_ChangeNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code03336
/statusInformation/errorOrWarningInfo/error/ typeEC
/statusInformation/errorOrWarningInfo/error/ listResponsible1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator3
/statusInformation/textInformation/ freeTextSimultaneous update - operation aborted

Retrieve the negotiated space details and verify that the negotiated space is not pending airline approval and retry the change request.



Operation: Change Of Allocated Seat Level

The following is an example to change the allocated seats to 28 for the following negotiated space;

AirlineLH
Flight number400
Class of serviceB
Date250601
City PairNCE LON
OwnerMUC1A0701
Nego Amadeus system ID0

Query Structure


Double Click To Show XML

28 LH 400 B 250601 MUC1A0701 0 NCE LON

Possible Errors

See "Error Messages" section


Operation: Change Of Commencement Date

The following is an example to change the commencement date to 280501 for the following negotiated space;

AirlineLH
Flight number400
Class of serviceB
Date250601
City PairNCE LON
OwnerMUC1A0701
Nego Amadeus system ID0

Query Structure


Double Click To Show XML

280501 LH 400 B 250601 MUC1A0701 0 NCE LON

Possible Errors

See "Error Messages" section


Operation: Change Of Expiry Date

The following is an example to change the expiry date to 240601 for the following negotiated space;

AirlineLH
Flight number400
Class of serviceB
Date250601
City PairNCE LON
OwnerMUC1A0701
Nego Amadeus system ID0

Query Structure


Double Click To Show XML

240601 LH 400 B 250601 MUC1A0701 0 NCE LON

Possible Errors

Expiry date changes restricted

The ability to change the expiry date may be inhibited in the handling table, in which case this error will be returned. Verify that the handling table is set properly, update the handling table if necessary and retry the request.

See also the "Error Messages" section


Operation: Change Of Reduction Date

The following is an example to change the reduction date to 230601 for the following negotiated space;

AirlineLH
Flight number400
Class of serviceB
Date250601
City PairNCE LON
OwnerMUC1A0701
Nego Amadeus system ID0

Query Structure


Double Click To Show XML

230601 LH 400 B 250601 MUC1A0701 0 NCE LON

Possible Errors

See "Error Messages" section


Operation: Change Of Reduction Amount

The following is an example to change the percentage for the reduction amount to 23 for the following negotiated space;

AirlineLH
Flight number400
Class of serviceB
Date250601
City PairNCE LON
OwnerMUC1A0701
Nego Amadeus system ID0

Query Structure


Double Click To Show XML

23 LH 400 B 250601 MUC1A0701 0 NCE LON

Possible Errors

See "Error Messages" section


Operation: Change Mulitple Elements

It is possible to combine multiple change elements, as the example below illustrates the ability to change the following elements simultaineously;

Commencement Date280301
Expiry Date250601
Number of allocated seats32
Reduction Date280501
Reduction Amount23

The elements above are requested to be changed for the following negotiated space;

AirlineLH
Flight number400
Class of serviceB
Date250601
City PairNCE LON
OwnerMUC1A0701
Nego Amadeus system ID0

Query Structure


Double Click To Show XML

280301 250601 32 280501 23 LH 400 B 250601 MUC1A0701 0 NCE LON

Possible Errors

See "Error Messages" section






Function: CancelNegoSpace


Overview

This function allows the agent to cancel existing negotiated space items. When canceling negotiated space items, it is necessary to include the following mandatory negotiated space elements, which properly identify the specific negotiated space to modify;


Note: that once the negotiated space has been created, an Amadeus system ID (1AID) is assigned to the negotiated space and becomes a mandatory element when requesting a change. If this ID is not known, it may be obtained by retrieving the negotiated space details via the Display Nego Space function.

In addition, if the negotiated space is further detailed with a Tour Name and a tour reference, these items must be included in the cancel request as well.

Once the cancel request has been processed, the negotiated space item will no longer be accessible and the Amadeus system will notify the appropriate airline so that any unsold seats remaining on the negotiated space may be returned to the normal airline inventory.

Note that only unsold blocks can be deleted.

Supported Operations

The following operations are supported when changing negotiated space;

Cancel Negotiated Space with only mandatory elements

It is possible to cancel a simple negotiated space that is identified with only mandatory elements.

Cancel Negotiated Space with Tour Name

It is possible to cancel a negotiated space that is identified with a tour name.

Cancel Negotiated Space with Tour Name and Tour Reference

It is possible to cancel a negotiated space that identified with a tour name and a tour reference.

Limitations

The following operations are not currently supported for creating negotiated space via the API;


Unsupported Operations

Not applicable.

Prerequisites

A negotiated space must exist on the Amadeus system prior to requesting to cancel it. A match on the mandatory elements provided in the cancel request must be found within the Amadeus system, or an error will be returned.

The User is authorized to delete a block.
The User, when different from an airline agent, is owner of the block.

The Amadeus ID for the negotiated space must be specified in the cancel request. This ID is not known until after the negotiated space is created. This may be retrieved, by requesting the negotiated space information via the Display Nego Space function.

Only unsold blocks can be deleted.

Building A Query

Depending on the flavor of the API that is used, each query will follow a given structure. The queries for the function operations are clearly explained with data element examples in a generic table view that can be adapted to the specific flavor of the API in use.

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 on which fields are mandatory for basic operation utilization. It is not a full explanation of every field that can be utilised for the operation, but rather a guideline to its use.

Receiving A Reply

Reply Structure

Successful Cancel

Negotiated space deleted

The following response is returned in all cases when the negotiated space was successfully canceled;

PoweredAir_CancelNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code 03360
/statusInformation/errorOrWarningInfo/error/ typeINF
/statusInformation/errorOrWarningInfo/error/ listResponsible1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator3
/statusInformation/textInformation/ freeText OK - NEGOTIATED SPACE DELETED

Note: the above response is in fact treated with a specific error code (03360), type (INF), and informational free text.


Double Click To Show XML

Not Applicable

Error Messages

Unsuccessful Cancel

No Negotiated Space found

The following response is returned in all cases when a match is not found for the negotiated space requested for cancel;

PoweredAir_CancelNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code 03342
/statusInformation/errorOrWarningInfo/error/ type EC
/statusInformation/errorOrWarningInfo/error/ listResponsible1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator3
/statusInformation/textInformation/ freeText NO CREATE / CHANGE ITEM PENDING



Operation: Cancel Negotiated Space With Only Mandatory Elements

The following example is a request to cancel the following negotiated space item;

AirlineLH
Flight number400
Class of serviceB
Date250601
City PairNCE LON
OwnerMUC1A0701
Nego Amadeus system ID0

Query Structure


Double Click To Show XML

lh 400 B 250601 MUC1A0701 0 NCE LON

Possible Errors

See "Error Messages" section


Operation: Cancel Negotiated Space With Tour Name

The following example is a request to cancel the associated negotiated space item specifying the tour name of HELLO TOURS;

AirlineLH
Flight number400
Class of serviceB
Date250601
City PairNCE LON
OwnerMUC1A0701
Nego Amadeus system ID0

Query Structure


Double Click To Show XML

lh 400 B 250601 MUC1A0701 HELLO TOURS 0 NCE LON

Possible Errors

See "Error Messages" section


Operation: Cancel Negotiated Space With Tour Name And Tour Reference

The following example is a request to cancel the associated negotiated space item specifying the tour name of HELLO TOURS with a tour reference 129B;

AirlineLH
Flight number400
Class of serviceB
Date250601
City PairNCE LON
OwnerMUC1A0701
Nego Amadeus system ID0

Note: a tour name is mandatory for this cancel request, as the tour reference may not be specified without the tour name.

Query Structure


Double Click To Show XML

lh 400 B 250601 MUC1A0701 HELLO TOURS 129B 0 NCE LON

Possible Errors

See "Error Messages" section






Function: DisplayNegoSpace


Overview

This function allows the agent to retrieve the details of existing negotiated space. Once the negotiated space has been created, it is possible to search and retrieve the following detailed information regarding the space;


In addition to the fields returned above, the retrieved information will also indicate the following;


General Rules

An agreement must exist between the airline and the negotiated space owner that allows the negotiated space details to be retrieved.

If an agreement exists, the owner of the negotiated space may retrieve only the negotiated space belonging to that office ID or group of office Ids identified as the owner.

Mandatory Search fields

When retrieving the negotiated space information, the following fields are mandatory;

  • Airline Code
  • Date of departure or flight number

By specifying only the airline code and departure date (or flight number), all negotiated space allotted for that airline on that date (or for the particular flight for all dates) will be returned to the owner.

Standard Search Options

To further limit the negotiated space search results, the following fields are optional when retrieving the negotiated space;

  • Flight number suffix
  • Commencement Date
  • City pair
  • Class
  • Reduction date
  • Reduction amount
  • Tour Name
  • Tour Reference
  • Expiry date
  • Allocated seat number
  • Owner
  • Authorization code
  • Days of operation

Type of negotiated space options

There is an indicator that may be set to retrieve only Inactive negotiated space, or only the negotiated space associated to the owner requesting the retrieval information (OWN).

Extended search option

To widen the search for the negotiated space it is possible to specify a date range, via the effective date and discontinue date parameters, for the criteria specified. For example, this feature makes it possible to search for all the negotiated space allotments for a particular flight and class between Date A and Date B.

Supported Operations

Retrieve By Mandatory Elements Only

The minimum requirements for negotiated space retrieval are the airline code and at least one of the following;


Search by airline and flight departure date

Specifying the airline code and the flight departure date will result in a list of all the negotiated space for that airline with flight departure dates matching the one specified in the request.

Search by airline and flight number

Specifying the airline code and the flight number will result in a list of all the negotiated space for that airline with the flight number matching the one specified in the request.


Retrieve By Mandatory And Optional Elements

In addition to the mandatory elements required, optional elements may be specified to further restrict the number of matching negotiated space allotments returned. These options may be entered individually or collectively with the mandatory elements.

Search with flight number suffix

Some airlines assign a suffix to a flight number. Specifying the suffix will result in a list of all the negotiated space for that airline with the specific flight number and assigned suffix specified.

Note: that the flight number becomes a mandatory element in the search request if using the flight suffix option.

Search with class of service

Specifying the class of service will result in a list of all the negotiated space for that airline, flight or date, and specific class of service in the request.

Search with city pair

Specifying the city pair will result in a list of all the negotiated space for that airline, flight or date, and city pair in the request.

Search with commencement date

Specifying the commencement date will result in a list of all the negotiated space for that airline, flight or date, and specific commencement date in the request.

Search with expiry date

Specifying an expiry date will result in a list of all the negotiated space for that airline, flight or date, and specific expiry date in the request.

Search with allocated seat number

Specifying the allocated seat number will result in a list of all the negotiated space for that airline, flight or date, with the number of allocated seats specified in the request.

Search with reduction date

Specifying the reduction date will result in a list of all the negotiated space for that airline, flight or date, and specific reduction date in the request.

Search with reduction amount

Specifying a reduction amount will result in a list of all the negotiated space for that airline, flight or date, and specific reduction amount in the request.

Search with tour name

Specifying a tour name will result in a list of all the negotiated space for that airline, flight or date, and specific tour name in the request.

Search with tour reference

Specifying a tour reference date will result in a list of all the negotiated space for that airline, flight or date, and specific tour reference in the request.

Search with authorization code

Specifying an authorization code will result in a list of all the negotiated space for that airline, flight or date, and specific authorization code in the request.

Search with airline negotiated space ID

Specifying an airline negotiated space ID will result in a list of all the negotiated space for that airline, flight or date, and specific ID in the request.

Search with Amadeus negotiated space ID

Specifying an Amadeus negotiated space ID will result in a list of all the negotiated space for that airline, flight or date, and specific ID in the request.

Search with days of operation

Specifying the days of operation will result in a list of all negotiated space matching the mandatory and optional search criteria specified and specific days of operation.

Days of operation correspond to the associated day number for the actual day of the week;

Day of Operation Day of The week
1Monday
2Tuesday
3Wednesday
4Thursday
5Friday
6Saturday
7Sunday

Type of Negotiated Space Options

Search for Inactive negotiated space only

Specifying to search for inactive negotiated space only will result in a list of only the inactive negotiated space matching the mandatory and optional search criteria specified.

Inactive negotiated space is referring to an allotment that has received a schedule change sent by the particular airline.

Search for Owner negotiated space only

Specifying to search for owner negotiated space only will result in a list of negotiated space matching the mandatory and optional search criteria specified for the requesting owner only.

Note: this option is mainly used in the case of an airline configuration or where there are a group of officeIDs associated as the owner of the negotiated space and the particular owner requesting the retrieval information does not want to view anything that belongs to another owner.


Extended search options

Search by effective date

Specifying an effective date will result in a list of all negotiated space matching the mandatory and optional search criteria specified starting from a particular date. This date is the starting date for the search process.

Search by ending date

Specifying an ending date will result in a list of all negotiated space matching the mandatory and optional search criteria specified up to a particular date. This date is the cut off date for the search process.


Limitations

At this time, there are no known limitations when using the Display Nego Space function.

Unsupported Operations

Not applicable.

Prerequisites

An agreement must exist between the airline and the negotiated space owner/agent for data retrieval. Negotiated space matching the search criteria must exist or an error will be returned.

Building A Query

Depending on the flavor of the API that is used, each query will follow a given structure. The queries for the function operations are clearly explained with data element examples in a generic table view that can be adapted to the specific flavor of the API in use.

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 on which fields are mandatory for basic operation utilization. It is not a full explanation of every field that can be utilised for the operation, but rather a guideline to its use.

Receiving A Reply

Successful Retrieve

The reply structure will contain all negotiated space allotments for the particular flight number with the suffix specified. i.e., a list of dated flight allotments will be returned.

In the case where the suffix is specified in conjunction with the mandatory flight date element instead of a flight number the reply will contain all flight numbers departing on a specific date with the particular suffix specified in the retrieve request.

Reply Structure

All negotiated space items found matching the criteria to the retrieval request will be returned.

The following is an example of a successful retrieval request containing 2 matching negotiated space elements to the request.

Matching element number one is
(/negotiatedSpaceInfo[1]/negotiatedSpaceDetails/...)
which is identified by [1] on the display given below, followed by matching element number two which is
(/negotiatedSpaceInfo[2]/negotiatedSpaceDetails/...)
identified by [2]. All subsequent matching items will be indexed ([x]) in a similar manner:
(/negotiatedSpaceInfo[x]/negotiatedSpaceDetails/...).

PoweredAir_DisplayNegoSpaceReply - Data element Value
/negotiatedSpaceInfo[1]/negotiatedSpaceDetails/flightDetails/ airlineCodeLH
/negotiatedSpaceInfo[1]/negotiatedSpaceDetails/flightDetails/ flightNumber0400
/negotiatedSpaceInfo[1]/negotiatedSpaceDetails/flightDetails/ identifierOfClassB
/negotiatedSpaceInfo[1]/negotiatedSpaceDetails/productInfo[1]/ flightDepartureDate250601
/negotiatedSpaceInfo[1]/negotiatedSpaceDetails/productInfo[2]/ commencementDateForSale290101
/negotiatedSpaceInfo[1]/negotiatedSpaceDetails/productInfo[2]/ expiryNegoDate250601
/negotiatedSpaceInfo[1]/negotiatedSpaceDetails/seatQuantity/ numberOfAllocatedSeat0
/negotiatedSpaceInfo[1]/negotiatedSpaceDetails/seatQuantity/ numberOfSoldSeat0
/negotiatedSpaceInfo[1]/negotiatedSpaceDetails/ ownerIdMUC1A0701
/negotiatedSpaceInfo[1]/negotiatedSpaceDetails/additionalInfo/ negoReductionDate200501
/negotiatedSpaceInfo[1]/negotiatedSpaceDetails/additionalInfo/ percentageOfReduction20
/negotiatedSpaceInfo[1]/negotiatedSpaceDetails/ nego1Aid0
/negotiatedSpaceInfo[1]/negotiatedSpaceDetails/ allotmentStatusC
/negotiatedSpaceInfo[1]/locationDetails/ originNCE
/negotiatedSpaceInfo[1]/locationDetails/ destinationLON
/negotiatedSpaceInfo[2]/negotiatedSpaceDetails/flightDetails/ airlineCodeLH
/negotiatedSpaceInfo[2]/negotiatedSpaceDetails/flightDetails/ flightNumber0400
/negotiatedSpaceInfo[2]/negotiatedSpaceDetails/flightDetails/ identifierOfClassB
/negotiatedSpaceInfo[2]/negotiatedSpaceDetails/productInfo[1]/ flightDepartureDate250601
/negotiatedSpaceInfo[2]/negotiatedSpaceDetails/productInfo[2]/ commencementDateForSale290101
/negotiatedSpaceInfo[2]/negotiatedSpaceDetails/productInfo[2]/ expiryNegoDate250601
/negotiatedSpaceInfo[2]/negotiatedSpaceDetails/seatQuantity/ numberOfAllocatedSeat0
/negotiatedSpaceInfo[2]/negotiatedSpaceDetails/seatQuantity/ numberOfSoldSeat0
/negotiatedSpaceInfo[2]/negotiatedSpaceDetails/ ownerIdMUC1A0701
/negotiatedSpaceInfo[2]/negotiatedSpaceDetails/additionalInfo/ tourNameHELLO TOURS
/negotiatedSpaceInfo[2]/negotiatedSpaceDetails/ nego1Aid1
/negotiatedSpaceInfo[2]/negotiatedSpaceDetails/ allotmentStatusC
/negotiatedSpaceInfo[2]/locationDetails/ originNCE
/negotiatedSpaceInfo[2]/locationDetails/ destinationLON


Double Click To Show XML

Not Applicable

Error Messages

Unsuccessful Retrieve

No Items Found

If no matching elements were found for the search criteria specified, the following error message will be returned in all cases;

PoweredAir_DisplayNegoSpaceReply - Data element Value
/statusInformation/errorOrWarningInfo/error/ code 00511
/statusInformation/errorOrWarningInfo/error/ type EC
/statusInformation/errorOrWarningInfo/error/ listResponsible1A
/statusInformation/textInformation/freeTextQualification/ codedIndicator3
/statusInformation/textInformation/ freeText NO ITEM FOUND



Operation: Retrieve By Airline & Flight Departure Date

The following example is a request to retrieve all negotiated space allotments matching the minimum criteria below;

Query Structure


Double Click To Show XML

LH 250101

Possible Errors

See "Error Messages" section


Operation: Retrieve By Airline & Flight Number

The following example is a request to retrieve all negotiated space allotments matching the minimum criteria below;

Query Structure


Double Click To Show XML

LH 738

Possible Errors

See "Error Messages" section


Operation: Retrieve By Airline & Number Suffix

The following example is a request to retrieve all negotiated space allotments containing the mandatory criteria and optional flight number suffix below.

In the case where the suffix is specified in conjunction with the mandatory flight date element instead of a flight number the reply will contain all flight numbers departing on a specific date with the particular suffix specified in the retrieve request.

Note: the flight number suffix may be specified with the mandatory flight departure date element as well.

Query Structure


Double Click To Show XML

LH 738 A

Possible Errors

See "Error Messages" section


Operation: Retrieve By Airline & Class Of Service

The following example is a request to retrieve all negotiated space allotments containing the mandatory criteria and optional flight number suffix below.

In the case where the class of service is specified in conjunction with the mandatory flight date element instead of a flight number the reply will contain all flight numbers departing on a specific date with the class of service specified in the retrieve request.

Query Structure


Double Click To Show XML

LH 738 B

Possible Errors

See "Error Messages" section


Operation: Retrieve By Airline & City Pair

The following example is a request to retrieve all negotiated space allotments containing the mandatory criteria and optional flight number suffix below.

In the case where the city pair is specified in conjunction with the mandatory flight number element instead of a flight departure date the reply will contain all flight departures for the specified flight number matching the city pair specified.

Query Structure


Double Click To Show XML

LH 230601 NCE LON

Possible Errors

See "Error Messages" section


Operation: Retrieve By Airline & Commencement Date

The following example is a request to retrieve all negotiated space allotments containing the mandatory criteria and optional flight number suffix below, Note that the commencement date may be specified with the mandatory flight departure element as well.

In the case where the commencement date is specified in conjunction with the mandatory flight date element instead of a flight number, the reply will contain all flight numbers for the date specified with a matching commencement date to the one specified in the retrieve request.

Query Structure


Double Click To Show XML

LH 400 250501

Possible Errors

See "Error Messages" section


Operation: Retrieve By Airline & Expiry Date

The following example is a request to retrieve all negotiated space allotments containing the mandatory criteria and optional flight number suffix below.

Note: that the expiry date may be specified with the mandatory flight number element as well.

In the case where the expiry date is specified in conjunction with the mandatory flight number element instead of a flight departure date, the reply will contain all flight departures for the specified flight number containing the expiry date specified.

Query Structure


Double Click To Show XML

LH 400 250601 230501

Possible Errors

See "Error Messages" section


Operation: Retrieve By Airline & Allocated Seat Number

The following example is a request to retrieve all negotiated space allotments containing the mandatory criteria and optional flight number suffix below;

Note: the number of allocated seats may be specified with the mandatory flight departure element as well.

**Be aware that this is corresponding to the number of allocated seats and is not associated to the number of remaining seats to be sold.**

In the case where the number of allocated seats is specified in conjunction with the mandatory flight date element instead of a flight number, the reply will contain all flight numbers for the date specified with the number of allocated seats specified in the retrieve request.

Query Structure


Double Click To Show XML

LH 244 30

Possible Errors

See "Error Messages" section


Operation: Retrieve By Airline & Reduction Date

The following example is a request to retrieve all negotiated space allotments containing the mandatory criteria and optional reduction date below.

Note: that the reduction date may be specified with the mandatory flight number element as well.

In the case where the reduction date is specified in conjunction with the mandatory flight number element instead of a flight departure date, the reply will contain all flight departures for the specified flight number containing the reduction date specified.

Query Structure


Double Click To Show XML

LH 250601 230501

Possible Errors

See "Error Messages" section


Operation: Retrieve By Airline & Reduction Amount

The following example is a request to retrieve all negotiated space allotments containing the mandatory criteria and optional reduction amount below;

**Be aware that the reduction amount is associated to a percentage amount**

Note: the reduction amount may be specified with the mandatory flight number element as well.

In the case where the reduction amount is specified in conjunction with the mandatory flight number element instead of a flight departure date, the reply will contain all flight departures for the specified flight number containing the reduction amount specified.

Query Structure


Double Click To Show XML

LH 250601 50

Possible Errors

See "Error Messages" section


Operation: Retrieve By Airline & Tour Name

The following example is a request to retrieve all negotiated space allotments containing the mandatory criteria and optional tour name below;

Note: the tour name may be specified with the mandatory flight departure element as well.

In the case where the tour name is specified in conjunction with the mandatory flight date element instead of a flight number, the reply will contain all flight numbers for the date specified with a matching tour name to the one specified in the retrieve request.

Query Structure


Double Click To Show XML

LH 111 Cruise Adventure

Possible Errors

See "Error Messages" section


Operation: Retrieve By Airline & Tour Reference

The following example is a request to retrieve all negotiated space allotments containing the mandatory criteria and optional tour reference below.

In the case where the tour reference is specified in conjunction with the mandatory flight date element instead of a flight number, the reply will contain all flight numbers for the date specified with a matching tour reference to the one specified in the retrieve request.

Query Structure


Double Click To Show XML

LH 111 1298C

Possible Errors

See "Error Messages" section


Operation: Retrieve By Airline & Authorization Code

The following example is a request to retrieve all negotiated space allotments containing the mandatory criteria and optional authorization code below.

Note: that the authorization code may be specified with the mandatory flight departure element as well.

In the case where the authorization code is specified in conjunction with the mandatory flight date element instead of a flight number, the reply will contain all flight numbers for the date specified with a matching authorization code to the one specified in the retrieve request.

Query Structure


Double Click To Show XML

LH 111 BW

Possible Errors

See "Error Messages" section


Operation: Retrieve By Airline & Airline Negotiated Space ID

The following example is a request to retrieve all negotiated space allotments containing the mandatory criteria and optional airline nego space ID below.

Note: the airline negotiated space ID may be specified with the mandatory flight departure element as well.

As the airline negotiated space ID, in most cases, is unique system identifier in the particular airline system for a particular negotiated space allotment, only one negotiated space allotment might be returned. If the airline has a group of allotments associated to one ID, then the group will be returned.

Query Structure


Double Click To Show XML

LH 111 A12345

Possible Errors

See "Error Messages" section


Operation: Retrieve By Airline & Amadeus Negotiated Space ID

The following example is a request to retrieve all negotiated space allotments containing the mandatory criteria and optional Amadeus nego space ID below.

Note: the Amadeus negotiated space ID may be specified with the mandatory flight departure element as well.

As the amadeus negotiated space ID is not necessarily a unique system identifier for a particular negotiated space allotment, one or multiple allotments containing the space ID may be returned.

Query Structure


Double Click To Show XML

LH 111 YXJ4

Possible Errors

See "Error Messages" section


Operation: Retrieve By Airline & Days Of Operation

The following example is a request to retrieve all negotiated space allotments containing the mandatory criteria and optional days of operation below. Notice that the days of operation are concatenated in the entry field.

Note: that although the days of operation may be specified with the mandatory flight departure element, it really serves no purpose to do such a combination as the days of operation are validated against the flight departure date. Therefore, if the days of operation do not match the day of departure specified the search will result in an error.

However, the days of operation can be particularly useful when used in combination with the effective and discontinue date elements.

Query Structure


Double Click To Show XML

LH 111 13

Possible Errors

See "Error Messages" section


Operation: Retrieve By Airline & Multiple Options

There are no restrictions on the combination of any optional elements. Therefore all optional elements may be combined in one entry to apply the maximum restriction for the reply.

The following example is a request to retrieve all negotiated space allotments containing the mandatory criteria and optional elements below

Query Structure


Double Click To Show XML

LH 400 080601 080801 30 010801 30 Hello Tours 1234C BW YZ123 127 IRELAND NCE DUB 080601 080801 134

Possible Errors

See "Error Messages" section


Operation: Retrieve By Inactive Negotiated Space Only

The following example is a request to retrieve all negotiated space allotments rendered inactive by a schedule change for LH flight 111

Note: that the inactive indicator may be specified with the mandatory flight departure element as well.

Query Structure


Double Click To Show XML

LH 111 I

Possible Errors

See "Error Messages" section


Operation: Retrieve By Owner Negotiated Space Only

The following example is a request to retrieve all negotiated space allotments with a specific flight departure date that are associated to the requestor

Note: this option is really only applicable to requesting airline offices and not agencies. As security measures automatically restrict an agency to viewing only the negotiated space allotments associated to the requesting agency office id, it is not necessary to specify the owner indicator. Airline offices, on the other hand, will view all negotiated space allotments for the particular airline unless they specify the owner indicator to narrow the reply to only those associated to the requesting airline office ID.

There are no restrictions for an agency specifying this optional element. Therefore, no error messages are returned in such a case but no additional editing is performed either.

Query Structure


Double Click To Show XML

LH 230601 O

Possible Errors

See "Error Messages" section


Operation: Retrieve By Effective Date

The following example is a request to retrieve all negotiated space allotments containing the mandatory criteria with a specific effective date

Note: that the effective date may be specified with the mandatory flight departure element as well.

In the case where the effective date is specified in conjunction with the mandatory flight date element instead of a flight number, the reply will contain all flight numbers for the date specified with a matching effective date to the one specified in the retrieve request. i.e., a list of all flight numbers for all departure dates that contain the effective date.

Query Structure


Double Click To Show XML

LH 400 O 230501

Possible Errors

See "Error Messages" section


Operation: Retrieve By Ending Date

The following example is a request to retrieve all negotiated space allotments containing the mandatory criteria with a specific ending date.

Note: that the ending date may be specified with the mandatory flight departure element as well.

In the case where the ending date is specified in conjunction with the mandatory flight date element instead of a flight number, the reply will contain all flight numbers for the date specified with a matching ending date to the one specified in the retrieve request. i.e., a list of all flight numbers for all departure dates that contain the ending date.

Query Structure


Double Click To Show XML

LH 400 O 230601

Possible Errors

See "Error Messages" section






Function: RetrieveSeatMap


Overview

Seat maps may be requested for flights of Amadeus system user airlines and other airlines that hold an interactive seat map agreement with Amadeus. An interactive seat map agreement must exist for the requested airline code or an error will result.

At the time of the seat map request, the Amadeus system will verify the operation of the flight on the specified date of departure for the selected city pair. If the flight does not operate on the given date for the given city pair, an error will be returned.

It is not mandatory for an airline to file a seat map for all flights. Thus, the process may pass the flight operational check but will still return an error indicating that a seat map does not exist for the specified flight request.

Note: By default, all seats on a flight are occupied or free. The default is specified in the cabin description : SeatOccupationDefault. In the reply, in the row details, if several seat references are omitted for seats, the default should be applied.

Seat Maps

A Seat Map contains valuable information pertaining to the cabin configuration and seat status of a specific airline flight. This information, in most cases, is utlized to provide an end-user with a key to the seats of a specific flight for advanced seating purposes.

Airline carriers who have interactive seat map agreements with Amadeus, have agreed to use common symbols that can be decoded with a common legend to denote specific features of an aircraft. If an interactive seat map agreement exits for a carrier, the seat maps may be returned to the amadeus API application.

The following is a possible GUI end-user response within an Amadeus API client application for a seat map key created with the Seat Map Reply information;


Note: the example above is only to illustrate the potential utilization of the information returned for a RequestSeatMap query.

Supported Operations

Request Seat Map With Mandatory Elements Only

When a seat map is requested with only the mandatory elements the following processing should be noted:

  1. The Amadeus system verifies that the airline holds an interactive seat map agreement.
  2. The request is processed for the seat map. Errors may result if the flight specified is not operational or if a seat map has not been filed by the carrier for the flight.

Request Seat Map With Mandatory & Optional Elements

Specific Class of Service

This option allows the use to narrow down the seat map information to a particular cabin area within the aircraft. i.e., only returning First class cabin information.

Frequent Flyer Card and Passenger Name

This option allows a frequent flyer card and passenger name to be sent to the specified airline at the time of the seat request.

Record Locator

This option allows a record locator to be sent to the specified airline at the time of the seat request.

Limitations

Not applicable.

Unsupported Operations

The following operations are not supported via the Request Seat Map API function at this time;


The following characteristic identification codes are not processed at this time (only a 1 character class of service identifier type is expected and processed at this time):

Code Description
1Request all non-displayable Reservation Booking Designators (RBDs or Classes of service)
2Request all RBD's including non-displayable RBD. Selection
3Request all frequent flyer award classes of service
4Total number of seats in allotment
5Number of seats sold in allotment
6Number of seats unsold in the allotment

Prerequisites

An interactive seat map agreement must exist between the specific airline and Amadeus.

Note: this support is provided for airlines having an interactive seat map interface with Amadeus.

Building A Query

Depending on the flavor of the API that is used, each query will follow a given structure. The queries for the function operations are clearly explained with data element examples in a generic table view that can be adapted to the specific flavor of the API in use.

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 on which fields are mandatory for basic operation utilization. It is not a full explanation of every field that can be utilised for the operation, but rather a guideline to its use.

Mandatory Elements

The following elements are mandatory when requesting a seat map:

  • Airline Code
  • Flight Number
  • Date of Departure
  • Departure City
  • Arrival City

Optional Elements

In addition to the mandatory elements, the following are optional elements that may be included in the request:

  • Class of Service
  • Frequent Flyer Card and Passenger Name
  • Record Locator

Receiving A Reply

The seat map information for each carrier holding an interactive seat map agreement will be returned in a common form.

Standard Elements

The following standard elements are commonly returned for every seat map request:

  • Cabin Details
  • Equipment Code
  • Individual Seat Information:
    Seat Row Number
    Column Description
    Seat Availability
    Seat Characterisitics
Common Seat Map Codes

Each seat map is returned with common symbols representing the specific details of the aircraft. The following is the common legend used in the Request SeatMap Replies:

Code Description
.Seat available
?Seat occupied
/Seat restricted
()Smoking Seat
<>Seat in the wing area
-Passengers last off in the seating area
BBulkhead seating
DDeportee seating
FGeneral Facilities area
HHandicap seating
VPreferrential seating for frequent flyer members
UPUpper deck area
KGalley
QQuiet area
XSeat Blocked
ZNo film available in the seat
EExit row area
GGroup seating
LToilets
IInfant seating
CCot available for seat
PPet area available for seat
UUnaccompanied minor seating
RRear seating area

Reply Structure

The following illustrates a successful RequestSeatMapReply structure in the API.

Note: the sample below is a partial sample with a repition of only 3 segment row information elements. In a normal full reply, this information would be repeated to cover the total number of existing rows of the aircraft.


Double Click To Show XML

1 62 250804 MIA DFW AA 1830 Y 166 757 Y 009 036 M F 015 023 A W B C A D A E F W 009 E A 8 B O C O D O E E O E F 8 010 E A O B O E C O D O E O E F O E 011 A O B O C O D O E O F O 012 A O B O C O D O F O

Error Messages

The following common errors may be returned at any time to the user when processing a query;

Invalid City/Airport Code

This error is returned if an invalid city or airport code is requested.

Seat Map Not Available For This Carrier

This error is returned if a seat map agreement does not exist for the carrier specified in the request.

Check Class of Service

This error is returned if the class of service specified is not valid.

Check Flight Number

This error is returned if the flight number entered in the request exceeds the five characters or an alpha other than A-B-C-D is entered as a fifth flight character.

Seat Map Not Available For This Carrier

This error is returned when an interactive seat map agreement does not exist between the requested carrier and Amadeus or if a seat map has not been created for the flight carrier.




Operation: Seat Map With Mandatory Elements

The example below illustrates a Request Seat Map Query with mandatory elements:

Query Structure


Double Click To Show XML

250804 MIA DFW AA 1830

Possible Errors

See "Error Messages" section


Operation: Seat Map For Specific Class of Service

The example below illustrates a Request Seat Map Query with mandatory element information with an optional class of service specified;

Query Structure


Double Click To Show XML

250804 MIA DFW AA 1830 Y

Possible Errors

See "Error Messages" section


Operation: Seat Map For Specific Frequent Flyer

The example below illustrates a Request Seat Map Query with just specifying the Frequent Flyer Card number.

The membershipLevel value is a precalculated denomination associated to the Frequent Flyer card number/holder that originates from the Profiles database or an associated carrier database. It should be noted that the 'membershiplevel' is different for all carriers.

For example, the value 1 indicates means the 'membership level' as known by the carrier that holds the frequent flyer card. And the value 2 indicates the 'membership level' as defined by the Airlines Alliance the carrier belongs to (if any).

It is possible to know the membershipLevel value in advance by creating a PNR, as the PoweredPNR reply, will return the values in the PrioryCode/Priority details.

Note: It is important to enter the carried code (e.g. LH) ahead of the cardholder number in the frequentTravelerIdentCode field.

Query Structure


Double Click To Show XML

260403 FRA BCN LH 4284 C LH 4099913025539611 1

Possible Errors

See "Error Messages" section






Function: FlightInfo


Overview

The Flight Information function provides Amadeus end-users with up-to-date information related to the operation of a particular flight before, during and after departure. Similarly, it provides irregularity and supplementary codes, which may be found in Availability, or Schedule displays to show a change in the flight operation.

Flight Information data (FLIFO) are stored in the Amadeus Central System as a result of:


The Display (DO) entry is used to display the latest known Flight Operational Information related to one flight/date.

Supported Operations

The Flight Information function allows for the following operations, this depend on options used in the input query:

Limitations

The following Time Mode options T12 and T24 that are used for requesting a flight operational information display are not currently supported in the API.

Unsupported Operations

History entry is not supported (DH).

Prerequisites

Security

  1. AAU*s FLIFO: can be displayed by any users.
  2. FLIFO for OAs with Agreement with Amadeus: can be displayed by any users.
  3. FLIFO for OAs without any Agreement with Amadeus: cannot be displayed from Travel Agents' terminals. It is only displayable from System Users' terminals.

In case of code-share, one will access the operating FLIFO by targeting one of the markets if:


Building A Query

Depending on the flavor of the API that is used, each query will follow a given structure. The queries for the function operations are clearly explained with data element examples in a generic table view that can be adapted to the specific flavor of the API in use.

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 on which fields are mandatory for basic operation utilization. It is not a full explanation of every field that can be utilised for the operation, but rather a guideline to its use.

Receiving A Reply

Reply Structure

The following example illustrates a successful request for flight information:


Double Click To Show XML

1 82 3 250804 LHR JFK AI 111 0 3 0725 SIM FROMLHR-DEPARTSTERMINAL3 SIM TOJFK-ARRIVESTERMINAL4 SIM LHRJFK-9/NON-SMOKING 250804 1315 LHR 744 0725 F LS A LS J LS C LS D LS W LS Y LS V LS B LS H LS K LS L LS M LS G LS 250804 1540 JFK

Error Messages

The errors listed here can be encountered while using the PoweredAir interface and the Flight Information function.

ERROR MESSAGE ERROR CODE
Check Flight Number7
Invalid Airline Code817
Flight Not Operational1645
Check City Pair3568

Please note that 'Check City Pair' is returned when:



Operation: Airline Code And Flight Number

Basic flight information request based on airline code and flight number.

Query Structure


Double Click To Show XML

LH 418

Possible Errors

See "Error Messages" section


Operation: Date Specified

Flight information request with date specified.

Query Structure


Double Click To Show XML

100903 LA 960

Possible Errors

See "Error Messages" section


Operation: Full Request Per Itinerary

Flight information request for itinarary.

Query Structure


Double Click To Show XML

100903 SCL LPB LA 960

Possible Errors

See "Error Messages" section


Operation: Full Request Per Leg

Flight information request per leg.

Query Structure


Double Click To Show XML

100903 IQQ ARI LA 960

Possible Errors

See "Error Messages" section


Operation: Request Per Boardpoint

Flight information request per board point.

Query Structure


Double Click To Show XML

100903 IQQ LA 960

Possible Errors

See "Error Messages" section


Operation: Full Request Per Segment

Flight information request per segment.

Query Structure


Double Click To Show XML

100903 IQQ LPB LA 960

Possible Errors

See "Error Messages" section


Operation: Change Of Gauge Flight Information In Reply

This example illustrates a request for flight Information for flight UA 121, in this specific case the Reply includes the ChangeOfGauge information.

The legDetails/complexingFlightIndicator set to 2 is the indicator in the reply that denote a Change Of Gauge flight, see Reply below:

PoweredAir_FlightInfoReply - Data element Value
/messageActionDetails/messageFunctionDetails/ businessFunction 1
/messageActionDetails/messageFunctionDetails/ messageFunction 82
/messageActionDetails/messageFunctionDetails/ responsibleAgency 3
/flightScheduleDetails/generalFlightInfo/flightDate/ departureDate 121005
/flightScheduleDetails/generalFlightInfo/boardPointDetails/ trueLocationId BDL
/flightScheduleDetails/generalFlightInfo/offPointDetails/ trueLocationId LAX
/flightScheduleDetails/generalFlightInfo/companyDetails/ marketingCompany UA
/flightScheduleDetails/generalFlightInfo/productIdDetails/ flightNumber 121
/flightScheduleDetails/additionalProductDetails/legDetails/ numberOfStops 1
/flightScheduleDetails/additionalProductDetails/legDetails/ daysOfOperation 3
/flightScheduleDetails/additionalProductDetails/legDetails/ complexingFlightIndicator 2
/flightScheduleDetails/additionalProductDetails/facilitiesInformation/ description 0855
/flightScheduleDetails/interactiveFreeText [1] /freeTextQualification/ textSubjectQualifier SIM
/flightScheduleDetails/interactiveFreeText [1] / freeText BDL ORD - MEMBER OF STAR ALLIANCE
/flightScheduleDetails/interactiveFreeText [2] /freeTextQualification/ textSubjectQualifier SIM
/flightScheduleDetails/interactiveFreeText [2] / freeText BDL LAX - MEMBER OF STAR ALLIANCE
/flightScheduleDetails/interactiveFreeText [3] /freeTextQualification/ textSubjectQualifier SIM
/flightScheduleDetails/interactiveFreeText [3] / freeText ORD LAX - MEMBER OF STAR ALLIANCE
/flightScheduleDetails/interactiveFreeText [4] /freeTextQualification/ textSubjectQualifier SIM
/flightScheduleDetails/interactiveFreeText [4] / freeText FROM ORD - DEPARTS TERMINAL 1
/flightScheduleDetails/interactiveFreeText [5] /freeTextQualification/ textSubjectQualifier SIM
/flightScheduleDetails/interactiveFreeText [5] / freeText TO ORD - ARRIVES TERMINAL 1
/flightScheduleDetails/interactiveFreeText [6] /freeTextQualification/ textSubjectQualifier SIM
/flightScheduleDetails/interactiveFreeText [6] / freeText TO LAX - ARRIVES TERMINAL 7
/flightScheduleDetails/interactiveFreeText [7] /freeTextQualification/ textSubjectQualifier SIM
/flightScheduleDetails/interactiveFreeText [7] / freeText BDL ORD - 9/ NON-SMOKING
/flightScheduleDetails/interactiveFreeText [8] /freeTextQualification/ textSubjectQualifier SIM
/flightScheduleDetails/interactiveFreeText [8] / freeText BDL ORD - 10/ SHORT FEATURE VIDEO
/flightScheduleDetails/interactiveFreeText [9] /freeTextQualification/ textSubjectQualifier SIM
/flightScheduleDetails/interactiveFreeText [9] / freeText ORD LAX - 1/ MOVIE
/flightScheduleDetails/interactiveFreeText [10] /freeTextQualification/ textSubjectQualifier SIM
/flightScheduleDetails/interactiveFreeText [10] / freeText ORD LAX - 9/ NON-SMOKING
/flightScheduleDetails/interactiveFreeText [11] /freeTextQualification/ textSubjectQualifier SIM
/flightScheduleDetails/interactiveFreeText [11] / freeText BDL ORD - ET/ ELECTRONIC TKT CANDIDATE
/flightScheduleDetails/interactiveFreeText [12] /freeTextQualification/ textSubjectQualifier SIM
/flightScheduleDetails/interactiveFreeText [12] / freeText ORD LAX - ET/ ELECTRONIC TKT CANDIDATE
/flightScheduleDetails/boardPointAndOffPointDetails [13] /generalFlightInfo/flightDate/ departureDate 121005
/flightScheduleDetails/boardPointAndOffPointDetails [13] /generalFlightInfo/flightDate/ departureTime 1136
/flightScheduleDetails/boardPointAndOffPointDetails [13] /generalFlightInfo/boardPointDetails/ trueLocationId BDL
/flightScheduleDetails/boardPointAndOffPointDetails [13] /additionalProductDetails/legDetails/ equipment 320
/flightScheduleDetails/boardPointAndOffPointDetails [13] /additionalProductDetails/legDetails/ duration 0239
/flightScheduleDetails/boardPointAndOffPointDetails [13] /productInfo/bookingClassDetails [1] / designator F
/flightScheduleDetails/boardPointAndOffPointDetails [13] /productInfo/bookingClassDetails [1] / specialService L
/flightScheduleDetails/boardPointAndOffPointDetails [13] /productInfo/bookingClassDetails [2] / designator Y
/flightScheduleDetails/boardPointAndOffPointDetails [13] /productInfo/bookingClassDetails [3] / designator B
/flightScheduleDetails/boardPointAndOffPointDetails [13] /productInfo/bookingClassDetails [4] / designator E
/flightScheduleDetails/boardPointAndOffPointDetails [13] /productInfo/bookingClassDetails [5] / designator M
/flightScheduleDetails/boardPointAndOffPointDetails [13] /productInfo/bookingClassDetails [6] / designator U
/flightScheduleDetails/boardPointAndOffPointDetails [13] /productInfo/bookingClassDetails [7] / designator H
/flightScheduleDetails/boardPointAndOffPointDetails [13] /productInfo/bookingClassDetails [8] / designator Q
/flightScheduleDetails/boardPointAndOffPointDetails [13] /productInfo/bookingClassDetails [9] / designator V
/flightScheduleDetails/boardPointAndOffPointDetails [13] /productInfo/bookingClassDetails [10] / designator W
/flightScheduleDetails/boardPointAndOffPointDetails [13] /productInfo/bookingClassDetails [11] / designator A
/flightScheduleDetails/boardPointAndOffPointDetails [13] /productInfo/bookingClassDetails [11] / specialService L
/flightScheduleDetails/boardPointAndOffPointDetails [13] /productInfo/bookingClassDetails [12] / designator S
/flightScheduleDetails/boardPointAndOffPointDetails [13] /productInfo/bookingClassDetails [13] / designator T
/flightScheduleDetails/boardPointAndOffPointDetails [13] /productInfo/bookingClassDetails [14] / designator K
/flightScheduleDetails/boardPointAndOffPointDetails [13] /productInfo/bookingClassDetails [15] / designator L
/flightScheduleDetails/boardPointAndOffPointDetails [13] /productInfo/bookingClassDetails [16] / designator G
/flightScheduleDetails/boardPointAndOffPointDetails [14] /generalFlightInfo/flightDate/ departureDate 121005
/flightScheduleDetails/boardPointAndOffPointDetails [14] /generalFlightInfo/flightDate/ departureTime 1500
/flightScheduleDetails/boardPointAndOffPointDetails [14] /generalFlightInfo/flightDate/ arrivalDate 121005
/flightScheduleDetails/boardPointAndOffPointDetails [14] /generalFlightInfo/flightDate/ arrivalTime 1315
/flightScheduleDetails/boardPointAndOffPointDetails [14] /generalFlightInfo/boardPointDetails/ trueLocationId ORD
/flightScheduleDetails/boardPointAndOffPointDetails [14] /generalFlightInfo/offPointDetails/ trueLocationId ORD
/flightScheduleDetails/boardPointAndOffPointDetails [14] /additionalProductDetails/legDetails/ equipment 752
/flightScheduleDetails/boardPointAndOffPointDetails [14] /additionalProductDetails/legDetails/ duration 0431
/flightScheduleDetails/boardPointAndOffPointDetails [14] /additionalProductDetails/legDetails/ complexingFlightIndicator 2
/flightScheduleDetails/boardPointAndOffPointDetails [14] /additionalProductDetails/facilitiesInformation/ description 0145
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [1] / designator F
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [1] / specialService L
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [2] / designator Y
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [2] / specialService G
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [3] / designator B
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [3] / specialService G
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [4] / designator E
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [4] / specialService G
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [5] / designator M
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [5] / specialService G
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [6] / designator U
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [6] / specialService G
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [7] / designator H
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [7] / specialService G
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [8] / designator Q
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [8] / specialService G
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [9] / designator V
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [9] / specialService G
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [10] / designator W
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [10] / specialService G
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [11] / designator A
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [11] / specialService L
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [12] / designator S
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [12] / specialService G
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [13] / designator T
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [13] / specialService G
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [14] / designator K
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [14] / specialService G
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [15] / designator L
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [15] / specialService G
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [16] / designator G
/flightScheduleDetails/boardPointAndOffPointDetails [14] /productInfo/bookingClassDetails [16] / specialService G
/flightScheduleDetails/boardPointAndOffPointDetails [15] /generalFlightInfo/flightDate/ arrivalDate 121005
/flightScheduleDetails/boardPointAndOffPointDetails [15] /generalFlightInfo/flightDate/ arrivalTime 1731
/flightScheduleDetails/boardPointAndOffPointDetails [15] /generalFlightInfo/offPointDetails/ trueLocationId LAX

Query Structure


Double Click To Show XML

121005 BDL LAX UA 121

Possible Errors

See "Error Messages" section.






Function: RebookAirSegment


Overview

The RebookAirSegment function enables you to rebook existing segments in a PNR. It is possible to make changes to both new and retrieved PNRs but not to group PNRs with more than 9 seats. Also, you cannot rebook open segments, information segments, non-participating carrier segments, or passive segments.

Rebook Types

Full Marriage Rebook

Full marriage rebook is a rebook of the entire marriage to a new class or a new date. The correspondent cryptic entry would be:
SBY : if you want to rebook to class Y
SB12MAR: if you want to rebook to the March, 12th In this case, the cancelled segment is ALWAYS followed by the segment you want to sell.

Multiple Rebook

Multiple rebook is when you rebook 1 or several segments to 1 or several OTHER flights. In this case, all the cancelled segments must be sent together followed by the segments that are to be sold.

Targeting Specific Segment Rebook

Sometimes, there is an ambiguity in specifying a segment in the PNR. This can arise when there are two identical segments. If you want to perform a rebook in this case the first occurance of the segment will be the one automatically selected. If a specific segment needs to be selected the tattoo number of the segment to be targeted must be given.

Classes Rebook following a PoweredFare PricePNRWithLowerFares

To have the best chances that a rebook following a PricePNRWithLowerFares verb be successful, users are asked to enter an additional input with the standard rebook parameters: the reference number of the recommendation selected. This number corresponds to the field "uniqueReference" in the pricingInformation part of the recommendation he/she has chosen for the rebook. This parameter must not be used outside of this scenario.

Supported Operations

The RebookAirSegment function can be used to change:


Limitations

If segments that are to be rebooked are married, the airline will need to have a SBF indicator set in the APT so the rebook of a married segment can be accepted, Otherwise the one of the following responses will be given:


Unsupported Operations

Not applicable.

Prerequisites

The segments to be rebooked and the PNR must exist.

Building A Query

TBD

Receiving A Reply

Reply Structure

The following RebookAirSegmentReply response shows the reply when segment two's class have been changed from F to C.


Double Click To Show XML

FRA BKK 080304 2200 1410 1 FRA BKK LH 744 F 1 HX 080304 2200 1410 1 FRA BKK LH 744 C 1 HK

Error Messages

TBD



Operation: Class Rebook

This example is for the rebook of the second segment from F Class to C Class.
PNR:

RP/MUC1A0701/MUC1A0701 BM/PR 5JAN04/1329Z YPPUGA
  1. API/TEST
  2. LH 744 F 08MAR 1 FRABKK HL1 2130 1 2200 1410+1 *1A/E*
  3. LX 182 J 09MAR 2 BKKSIN HK1 2 1530 1845 *1A/E*
  4. AP MUC - AMADEUS DEFAULT OFFICE - A
  5. TK OK05JAN/MUC1A0701

Query Structure


Double Click To Show XML

FRA BKK 080304 2200 090304 1410 1 FRA BKK LH 744 F 01 OX 080304 2200 1410 FRA BKK LH 744 C 01 NN

Possible Errors

See "Error Messages" section.


Operation: Class Rebook after PricePNRWithLowerFare

This example is the same as the previous one, but in the case where rebook is performed following a PricePNRWithLowerFare request, and the reference of the recommendation selected by the user (number 2) is transmitted in the rebook:
PNR:

RP/MUC1A0701/MUC1A0701 BM/PR 5JAN04/1329Z YPPUGA
  1. API/TEST
  2. LH 744 F 08MAR 1 FRABKK HL1 2130 1 2200 1410+1 *1A/E*
  3. LX 182 J 09MAR 2 BKKSIN HK1 2 1530 1845 *1A/E*
  4. AP MUC - AMADEUS DEFAULT OFFICE - A
  5. TK OK05JAN/MUC1A0701

Query Structure


Double Click To Show XML

2 FRA BKK 080304 2200 090304 1410 1 FRA BKK LH 744 F 01 OX 080304 2200 1410 FRA BKK LH 744 C 01 NN

Possible Errors

See "Error Messages" section.


Operation: Rebook Two Segment Classes

This example shows the rebook of:


PNR:

RP/MUC1A0701/MUC1A0701 BM/PR 5JAN04/1331Z YPPUGE
  1. API/TEST
  2. LH 744 F 08MAR 1 FRABKK HL1 2130 1 2200 1410+1 *1A/E*
  3. LX 182 J 09MAR 2 BKKSIN HK1 2 1530 1845 *1A/E*
  4. AP MUC - AMADEUS DEFAULT OFFICE - A
  5. TK OK05JAN/MUC1A0701

Query Structure


Double Click To Show XML

FRA BKK 080304 2200 090304 1410 1 FRA BKK LH 744 F 01 OX 080304 2200 090304 1410 1 FRA BKK LH 744 C 01 NN BKK SIN 090304 1530 090304 1845 0 BKK SIN LX 182 J 01 OX 090304 1530 090304 1845 0 BKK SIN LX 182 C 01 NN

Possible Errors

See "Error Messages" section.


Operation: Rebook Flight Number

Rebook flight LH 744 to flight LH 9762.
PNR:

RP/MUC1A0701/MUC1A0701 BM/PR 5JAN04/1336Z YPPUGN
  1. API/TEST
  2. LH 778 F 08MAR 1 FRASIN HK1 2140 1 2210 1650+1 *1A/E*
  3. AP MUC - AMADEUS DEFAULT OFFICE - A
  4. TK OK05JAN/MUC1A0701

Query Structure


Double Click To Show XML

FRA SIN 080304 2210 090304 1650 FRA SIN LH 778 F 01 OX 080304 1200 090304 0655 FRA SIN LH 9762 F 01 NN

Possible Errors

See "Error Messages" section.


Operation: Rebook Segment Date

Rebook the second segment from 8/03 to 9/03.
PNR:

RP/MUC1A0701/MUC1A0701 BM/PR 5JAN04/1336Z YPPUGN
  1. API/TEST
  2. LH 778 F 08MAR 1 FRASIN HK1 2140 1 2210 1650+1 *1A/E*
  3. AP MUC - AMADEUS DEFAULT OFFICE - A
  4. TK OK05JAN/MUC1A0701

Query Structure


Double Click To Show XML

FRA SIN 080304 2210 090304 1650 FRA SIN LH 778 F 01 OX 090304 2210 100304 1650 FRA SIN LH 778 F 01 NN

Possible Errors

See "Error Messages" section.