16.1 AirShopping RQ
Data Model |
---|
To be added |
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/ |
---|---|---|
Request Object | AirShoppingRQ | M |
Service Input Parameters | ||||
---|---|---|---|---|
Input Parameters | Type | Schema Definition (http://www.ba.com/schema/) | Optional/Mandatory | Comments |
Request object | AirShoppingRQ | AirShoppingRQ.xsd | M | |
AirShoppingRQ Data Fields | ||||
Field Type | Data Type | Schema Definition (http://www.ba.com/schema/) | Optional/Mandatory | Comments |
Agency and Service Provider data See section 2.1 |
|
|
|
|
Version (Attribute) |
| AirShoppingRQ/Version (Attribute) | M | Specify NDC schema message version. Always pass 16.1 Note: This is a mandatory attribute in NDC schema. The service will not validate what is being passed in this attribute |
PrimaryLangID (Attribute) |
| AirShoppingRQ/PrimaryLangID (Attribute) | O | 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 |
AltLangID (Attribute) |
| AirShoppingRQ/AltLangID (Attribute) | O | 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 |
Document |
|
| M |
|
Name |
| AirShoppingRQ/Document/Name | O | Always pass “BA” |
Travelers |
|
| M | BA accepts only an anonymous traveller in the shopping request |
Traveler |
|
| M | This must be repeated for each passenger. If the client wants to shop for 2 ADT, 2 CHD and 2 INF then Traveler should be repeated 6 times for each passenger |
AnonymousTraveler |
|
| O | Note: This is an optional element in NDC schema but for calling BA service this must be passed |
PTC |
| AirShoppingRQ/Travelers/Traveler/AnonymousTraveler/PTC | O | Passenger Type Code BA accepts the following passenger type codes ADT CHD INF If any other passenger type code is passed then ADT price will be returned Note: This is an optional element in NDC schema but for calling BA service this must be passed |
Age |
| O | Though this is an optional element, it is recommended to provide passenger’s age, as it will be used to identify if the passenger is a young adult. Note: UK Air Passenger Duty (APD) is not applicable to “young adults” aged 12 to 15 years inclusive for travel after 1 March 2016 | |
Value |
| AirShoppingRQ/Travelers/Traveler/AnonymousTraveler/Age/Value | M [Choice] | Example: 15 |
BirthDate |
| AirShoppingRQ/Travelers/Traveler/AnonymousTraveler/Age/BirthDate | M [Choice] | Date of birth in “YYYY-MM-DD” format Example: 2002-01-01 |
CoreQuery |
|
| ||
OriginDestinations |
|
| M | Origin and destination (O&D) details |
OriginDestination |
|
| M | 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-EDI |
Departure |
| M | Departure airport/city details | |
AirportCode |
| AirShoppingRQ/CoreQuery/OriginDestinations/OriginDestination/Departure/AirportCode | M | Accepts both airport code (LHR) and city code (LON) |
Date |
| AirShoppingRQ/CoreQuery/OriginDestinations/OriginDestination/Departure/Date | M | Departure date Example: 2015-08-14 |
Time |
| AirShoppingRQ/CoreQuery/OriginDestinations/OriginDestination/Departure/Time | O | Departure time |
Arrival |
|
| M | Arrival airport/city details |
AirportCode |
| AirShoppingRQ/CoreQuery/OriginDestinations/OriginDestination/Arrival/AirportCode | M | Accepts both airport code (LHR) and city code (LON) |
Date |
| AirShoppingRQ/CoreQuery/OriginDestinations/OriginDestination/Arrival/Date | O | Departure date Example: 2015-08-21 |
Time |
| AirShoppingRQ/CoreQuery/OriginDestinations/OriginDestination/Arrival/Time | O | Arrival time |
CalendarDates |
| O | Indicates Calendar search date. Calendar recommendation will only be returned if the client specifies calendar search dates in the request | |
DaysBefore (Attribute) |
| AirShoppingRQ/CoreQuery/OriginDestinations/OriginDestination/DaysBefore (Attribute) | O | 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 |
DaysAfter (Attribute) |
| AirShoppingRQ/CoreQuery/OriginDestinations/OriginDestination/DaysAfter (Attribute) | O | 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 |
Preference |
|
| O | Fare and cabin preference can be specified here Note: This is an optional element in NDC schema but for calling BA service this must be passed to specify at least cabin preference |
FarePreferences |
|
| O | 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. BA supports the following Leisure fare types 1) Inclusive Tour 2) Contract Bulk 3) Private Fare Adult 4) Marine 5) Humanitarian |
Types |
|
| O | |
Type |
|
| M | Fare preference can be specified only at the itinerary level. Also, leisure fare can be requested only at the itinerary level. If the client wants to request Leisure fare with Lowest fare type then Type tag should be repeated twice |
Code |
| AirShoppingRQ/Preference/FarePreferences/Types/Type/Code | M | IATA PADIS Codeset 9910 - Fare qualifier BA accepts the following codes from codeset 9910 754 759 758 Where 754 means Flexible fare 759 means Lowest fare 758 means Leisure fare |
Definition |
| Leisure fare should be specified here Possible Leisure Fare types are
AirShoppingRQ/Preference/FarePreferences/Types/Type/ Definition | O | |
CabinPreferences |
|
| O | 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 Requesting a different cabin per O&D is not supported |
CabinType |
|
| M | This can be specified only once |
Code |
| AirShoppingRQ//Preference/CabinPreferences/CabinType/Code | M | IATA PADIS Codeset 9873 - Cabin class of service, coded BA accepts the following codes from codeset 9873 1 2 4 5 Where 1 = First 2 = Business 4 = Premium Economy 5 = Economy |