Ancillary Servicing - Meals - RQ
OrderChange - Ancillary Servicing - Disability Assistance - RQ
Data Model |
---|
Data model to follow |
Data Model - OrderItems |
---|
Data models to follow |
Schemas |
---|
The service adheres to the IATA NDC OrderChange schema version 17.2, with some modifications |
User Guidance - Request Definitions - Service Input Parameters | ||
Input Parameters | Type | Mandatory/ |
---|---|---|
Request object | OrderChangeRQ | M |
<OrderChangeRQ> | ||
Elements | Details | Mandatory/ |
---|---|---|
Version (Attribute) | Specify NDC schema message version. Always pass 17.2 | M |
PrimaryLangID (Attribute) | Specifies the agent’s preferred language. Service response will be returned in this language | 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 | O |
<Document> | ||
Elements | Details | Mandatory/ |
---|---|---|
<Document> | NDC Message Document information | M |
<Name> | Document name will be always "BA" | O |
<Party> | ||
Elements | Details | Mandatory/ |
---|---|---|
<Party> | »Party & Sender Definition | M |
<Query> | ||||||||
Elements | Details | Mandatory/ | ||||||
---|---|---|---|---|---|---|---|---|
<Query> | Core Service Price query parameters. | M | ||||||
<OrderID> | Booking reference or PNR reference Example: YOMH3W | M | ||||||
Owner (Attribute) | Specifies the owner of the booking Example: BA | M | ||||||
<OrderServicing> | Function to Add the Meal service. | M | ||||||
<AcceptOffer> | Function to accept a new OfferItem and adding it to the existing Order Note: If meals do not exist then service attempt to add the meals in the booking. It is allowed to change free meals to another free meal/another paid meal per passenger per flight segment both on a ticketed booking and an un-ticketed booking. Change option for paid meal request is not allowed i.e. once the paid meal is purchased, it has to be cancelled first before booking another meal for the same passenger on the same flight segment | M | ||||||
<Offer> | Meal Offer selected by the Passenger for requesting an Order to be created. | M | ||||||
OfferID (attribute) | Reference to the OfferID of the selected Offer (either a standard Offer or an a-la-carte Offer) returned in a previous ServiceList response. | M | ||||||
Owner | Designator of Airline that owns/ assigned these IDs. Examples: BA | M | ||||||
ResponseID | Reference to unique ServiceList session response ID, as provided in the previous ServiceList response. | M | ||||||
<OfferItem> | Meal OfferItem selected by the Passenger for inclusion in the requested Order. | M | ||||||
OfferItemID | Reference to the OfferItemID of the selected meal OfferItem (contained in either a standard Offer or an a-la-carte Offer) returned in a previous ServiceList response | M | ||||||
<PassengerRefs> | Reference to the passenger(s) for which this OfferItem and selected Services (in case of Service Bundles) applies. | M | ||||||
<Payments> | Specify payment information Note: Though this is optional element in NDC schema, it must be passed in the request to confirm the paid meal addition and payment. In the case of free meals addition, this section is not required. | O | ||||||
<Payment> | BA accepts one card form of payment per booking | M | ||||||
<Type> | The form of payment type. Examples: Credit Card, Cash. IATA definition from codeset 9888 The code can be one of the following from the table depends on the form of payment is used
| M | ||||||
<CardNumber> | Example: 41111111111111111 Note: Though this is optional in NDC schema, it must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | O | ||||||
<SeriesCode> | This is the verification digits printed on the card following the embossed number. This may also accommodate the customer identification/batch number (CID), card verification value (CVV2), card validation code number (CVC2) on credit card. Example: 123 Note: Though this is optional in NDC schema, it must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | O | ||||||
<CardHolderName> | The Card holder's name Example: Mr Test Smith Note: Though this is optional in NDC schema, it must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | O | ||||||
<CardHolderBillingAddress> | Specifies the payment card address or Billing address Note: Though this is optional in NDC schema, it must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | O | ||||||
<Street> | This is a list and can be repeated twice to specify 2 Streets Example: < Street1>1234 Main Street</Address> <Street2>Pontes Avenue</Address> Note: Specify only Street 1 if Street 1 was mandatory and specify both Street 1 and 2 if both Street 1 and Street 2 were returned as mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | O | ||||||
<CityName> | 3 letter City Code Example: NYC or LON Note: Though this is optional in NDC schema, it must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | O | ||||||
<StateProv> | State or province code Examples: NY Note: Though this is optional in NDC schema, it must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | O | ||||||
<PostalCode> | Postal Code Example: SW3 1XH Note: Though this is optional in NDC schema, it must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | O | ||||||
<CountryCode> | Billing country code (2 letter code) Example: GB Note: Though this is optional in NDC schema, it must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | O | ||||||
<Surcharge> | Surcharge fee applicable for the payment card. Note: Though this is optional in NDC schema, it must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | O | ||||||
<Amount> | Provide a total surcharge amount for all passengers that were returned in the SeatAvailability response. Example: 5 | M | ||||||
Code (Attribute) | Currency code Example: GBP This should be the same as what was returned in the OrderViewRS Note: This is an optional attribute in NDC schema but for calling BA services this must be passed | O | ||||||
<EffectiveExpireDate> | Payment Card Effective and/ or Expiration date(s). | O | ||||||
<Effective> | Specifies payment card start date Example: 0812 Where 08 = Month 12 = Year Note: Though this is optional in NDC schema, it must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | O | ||||||
<Expiration> | Specifies payment card expiry date Example: 0815 Where 08 = Month 15 = Year Note: Though this is optional in NDC schema, it must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | O | ||||||
<Amount> | Total amount payable by Card. This should include a card surcharge as well for card payment Example: 500.55 Note: This is an optional attribute in NDC schema but for calling BA services this must be passed | O | ||||||
code (Attribute) | Currency code Example: GBP Note: This is an optional attribute in NDC schema but for calling BA services this must be passed | O | ||||||
If cash is used for paid meals purchase. | ||||||||
<Payment> | BA accepts one card form of payment per booking | M | ||||||
<Type> | The form of payment type. Examples: Credit Card, Cash. IATA definition from codeset 9888 The code can be one of the following from the table depends on the form of payment being used
| M | ||||||
<Method> | M | |||||||
CashInd (Attribute) | This should always be “True” for cash payment. | M | ||||||
<Amount> | Total amount payable by Cash. Example: 500.55 Note: This is an optional attribute in NDC schema but for calling BA services this must be passed | M | ||||||
Code (Attribute) | Currency code Example: GBP Note: This is an optional attribute in NDC schema but for calling BA services this must be passed | M |
Elements | Details | Mandatory/ |
---|---|---|
<Query> | Core Service Price query parameters. | M |
<OrderID> | Booking reference or PNR reference Example: YOMH3W | M |
Owner (Attribute) | Specifies the owner of the booking Example: BA | M |
<OrderServicing> | Function to Change the additional Meal quantity. | M |
<AcceptOffer> | Function to accept a new OfferItem and adding it to the existing Order Note: It is allowed to change free meals to another free meal/another paid meal per passenger per flight segment both on a ticketed booking and an un-ticketed booking. Change option for paid meal request is not allowed i.e. once the paid meal is purchased, it has to be cancelled first before booking another meal for the same passenger on the same flight segment | M |
<Offer> | Meal Offer selected by the Passenger for requesting an Order to be created. | M |
OfferID (attribute) | Reference to the OfferID of the selected Offer (either a standard Offer or an a-la-carte Offer) returned in a previous ServiceList response. | M |
Owner | Designator of Airline that owns/ assigned these IDs. Examples: BA | M |
ResponseID | Reference to unique ServiceList session response ID, as provided in the previous ServiceList response. | M |
<OfferItem> | Meal OfferItem selected by the Passenger for inclusion in the requested Order. | M |
OfferItemID | Reference to the OfferItemID of the selected meal OfferItem (contained in either a standard Offer or an a-la-carte Offer) returned in a previous ServiceList response | M |
<PassengerRefs> | Reference to the passenger(s) for which this OfferItem and selected Services (in case of Service Bundles) applies. | M |
Elements | Details | Mandatory/ Optional |
<Query> | Core Service Price query parameters. | M |
<OrderID> | Booking reference or PNR reference Example: YOMH3W | M |
Owner (Attribute) | Specifies the owner of the booking Example: BA | M |
<OrderServicing> | Function to Delete the Meal Ancillary Details. | M |
<Delete> | Function to accept the deletion of meal OrderItem from the existing Order. | M |
<OrderItemID> | Meal Order Items (paid and free) which need deletion. | M |
<DataLists> | ||
Elements | Details | Mandatory/ |
---|---|---|
<PassengerList> | Passenger data list definition. Note:
| O |
<ContactList> | List of contacts for passengers & payers. Note:
| O |