AirShopping RQ

Data Model


Schemas

The service adheres to the IATA NDC AirShoppingRQ schema version 17.2, with some modifications (see below)

User Guidance - Service Input Parameters

Input Parameters
Type

Optional/Mandatory

Request ObjectAirShoppingRQM

<AirShoppingRQ>

ElementsDetails

Optional/Mandatory

Version (Attribute)

Specify NDC schema message version. Always pass 17.2

Note: This is a mandatory attribute in NDC schema. The service will not validate what is being passed in this attribute

M
PrimaryLangID (Attribute)

Specifies the agent’s preferred language. Service response will be returned in this language

Note: If the requested language is not supported by BA or if this is not passed in the request then the default language will be used, which is English

Example: EN

O
AltLangID (Attribute)

Specifies the preferred language in which the mail to be sent. eTicket receipt email and any other communication emails from BA will be sent in this language

Note: AltLangID will not be used even if it was passed in the AirShopping request, as there is no email sent at the shopping stage. If the requested language is not supported by BA or if this is not passed in the request then the default language will be used, which is English

O

<Document>

ElementsDetails

Optional/Mandatory

<Document>
NDC Message Document informationM
<Name>
Document name will be always "BA"O

<Party>

ElementsDetailsOptional/Mandatory
<Party>Party & Sender DefinitionM

<CoreQuery>

ElementsDetails

Optional/Mandatory

<CoreQuery>
Start of AirShopping QueryM
<OriginDestinations>
Origin and destination (O&D) detailsM
<OriginDestination>
This must be repeated for each O&D. If the request is for EDI-AMS return then this must be repeated twice one for EDI-AMS and one for AMS-EDIM
OriginDestinationKey (attribute) 
This is the unique key to be used when requesting any preference at Origin-Destination level O
<Departure>
Departure airport/city detailsM
<AirportCode>
Accepts both airport code (LHR) and city code (LON)M
<Date>

Departure date

Example: 2015-08-14
M
<Time>
O
<Arrival>
Arrival airport/city detailsM
<AirportCode>
Accepts both airport code (LHR) and city code (LON)M
<CalendarDates>

Indicates Calendar search date.

Calendar recommendation will only be returned if the client specifies calendar search dates in the request

O
DaysAfter (Attribute)

The number of days after the requested date

Example: 3

Calendar recommendation will be returned for the number of days specified after the requested date

O
DaysBefore (Attribute)

The number of days before the requested date

Example: 3

Calendar recommendation will be returned for the number of days specified before the requested date

O

<Preference>

ElementsDetails

Optional/Mandatory

<Preference>

Fare and cabin preference can be specified here

M
<FarePreferences>

Specify fare preference. BA accepts the below 2 fare preferences in the shopping request

1) Flexible fare
2) Lowest fare

 If no fare preference is specified then by default lowest fare will be returned. Also, leisure fare can be requested under FarePreferences.

O
<Types>
Fare type with a preference levelO
<Type>



PreferencesContext (Attribute)

IATA PADIS Codeset 9910 - Fare qualifier

The Leisure fare should be specified as an attribute for the <Type> element.

The list of Leisure Fares are 

  1. Tour Operator Deferred
  2. Tour Operator Semi-Deferred 
  3. Contract Bulk
  4. Private Fare Adult
  5. Marine
  6. Humanitarian

This is an XML example for the use of this attribute:

M



O

<FlightPreferences>

XML Sample to be added.

O
<Aircraft>

This is required to be passed if the agent wants to shop based on a particular Aircraft type.

O

<Equipment>


O

<AircraftCode>

The IATA Aircraft type 3 character code

Example - 318

M

Refs (attribute)

Reference to OriginDestinationKey for which preference is requested

Example – ‘OD1’

O

<Characteristic>
This is required to be passed if the agent wants to shop based on a Direct flight onlyO
<DirectPreferences>

This will return offers with direct flight only, for all the Origin destinations in the itinerary

(pass this as an empty xml tag in the Request)

O
<TransferPreferences>

This should be passed if customer want to shop based on Transfer Airport preference

O

<Connection>


M

<Codes>


O

<Code>

This should be repeated for each Transfer point per OD

Example - LHR

M

PreferencesLevel

Reference to OriginDestinationKey for which preference is requested

Example – ‘OD1’

O

<CabinPreferences>

The cabin can only be specified for the whole itinerary

Example:

LHR-JFK-LHR journey can be requested in “Economy” cabin for the whole itinerary

O
<CabinType>
This can be specified only onceM
<Code>

IATA PADIS Codeset 9873 - Cabin class of service, coded

BA accepts the following codes from codeset 9873

1, 2, 4  and 5

 Where 1 = First, 2 = Business, 4 = Premium Economy and 5 = Economy

M

<DataLists>

XML

Elements

Details

Optional/Mandatory

<PassengerList>
<PassengerList>

List of all passengers with Passenger type code (PTC)

  • Young adult DOB is required as UK Air Passenger Duty (APD) is not applicable to “young adults” aged 12 to 15 years inclusive for travel after 1 March 2016
O