User Guidance

Input Parameters

Type

Mandatory/Optional

Request Object

ServiceListRS

M

< ServiceListRS>

Elements

Details

Mandatory/Optional

Specify NDC schema message version. Always pass 17.2

M

<Document>

XML Example for the following elements

Elements

Details

Mandatory/Optional

Document

NDC Message Document information

M

Name

Document name will be always NDC

O

ReferenceVersion

Will be NDC version

O

<Success/>

Elements

Details

Mandatory/Optional

Success

 The presence of the empty Success element explicitly indicates that the message succeeded.

M

<ALaCarteOffer>

ALaCarteOffer

Container for standalone optional OfferItems.

M

OfferID (Attribute)

Airline-assigned unique Offer identifier.

M

Owner (Attribute)

Airline designator of the owner/ assigner of the Offer ID.

Example : BA, XQ, EK

M

XML Example for the following elements

ALaCarteOffer

Offer details

O

ALaCarteOfferItem

Container for standalone optional OfferItems.

M

OfferItemID

Unique id

Example : OO158-eJwli0EKgCAUBU9U.DX1-6VIgQu1zCBX7-63SGgWsxgYssKeWbS2nnDmFJFEsNDfWdh4QRj9aAHklLLOTE-wXqDNIaTSsT8Ne6yl5gGj-Zxxd8wDlmhlDfUBbQMbBg__

M

Eligibility

Contains pax and segment reference for eligible offer

M

PassengerRefs

Passenger reference

M

SegmentRefs

Segment reference

M

UnitPriceDetail

Flat price for an individual unit of the referenced Service

M

TotalAmount

Total price amount. Notes: 1. This is typically the lowest price for this alternate lead shopping date. 2. If expressed in currency, this price should include base price, taxes and fees/ surcharges. (en, description) 

M

DetailCurrencyPrice

Total Price of the offer item

M

Total

Total amount of item

M

Details

Details all price break-down item subtotals, which exclude taxes, fees and charges. (en, description)

O

Detail

 Price details. Note: This price does not include taxes and fee/ surcharges. (en, description)

M

SubTotal

 Price breakdown sub-total. Note: This is the total of all price breakdown items, excluding tax and/ or surcharge. (en, description)

O

Application

Price application. Example: Base Fare

O

Taxes

Ticket Tax/fee/charge details to indicate taxes that apply to country of commencement of travel and routing.

O

Total

Sub-total of all applicable taxes. Monetary value and currency code

O

Breakdown

A collection of detailed taxes

O

Tax

Tax breakdown detail.

M

Amount

Amount

M

Nation

Tax Nation or Designator.

O

TaxCode

Tax Code. Example: AY, GB

O

TaxType

Tax type. Used to specify where the tax was applied. May be nice to have for auditing purposes. Example: 001, 002

O

Description

Tax short description. Example: $4 per flight segment, per passenger (U.S. domestic segment tax)

O

Service

Instance of service definition (as found in DataLists) as it has been offered, and eventually ordered and consumed by a specific Passenger in the context of an Offer.

M

ServiceID

Unique id for service instance

M

ServiceDefinitionRef

Reference to ServiceItems

M

<Metadata>

XML Example for the following elements

Metadata

Already detailed in other services

O

OtherMetadata

Other Metadata Lists(s).

M

CurrencyMetadatas

Pre-defined and Augmented CURRENCY Metadata.

M

CurrencyMetadata

CURRENCY Metadata

M

Decimals

Number of decimal places. Example: 2. Note this is the number of decimal places normally used when displaying amounts in this currency

O

PriceMetadatas

Pre-defined and Augmented PRICE Metadata.

M

PriceMetadata

PRICE Metadata

M

AugmentationPoint

Augmentation Point

M

AugPoint

Augmentation Point Definition

M

TaxDetailAugPoint

Tax Details

O

DisplayTaxCode

Tax Code

O

<DataLists>

<PassengerList>

XML Example for the following elements

PassengerList

Passenger data list definition.

M

PassengerID (Attribute)

Uniquely identifies a Passenger within the context of one message.

M

Passenger

Any person except members of the crew carried or to be carried with the consent of the carrier, on board of any transport vehicle such as aircraft, train, bus, ship.

M

PTC

Type code applying to the Passenger which typically drives pricing

Example: ADT, CHD, etc.

M

<FlightSegmentList>

XML Example for the following elements

FlightSegment

Flight Segment

M

SegmentKey (Attribute)

A globally unique identifier for this Flight Segment instance.

M

ElectronicTicketInd (Attribute)

When true, an electronic ticket may be issued.

O

Departure

Departure (origin) Airport, Date and Time information. (en, description)

M

AirportCode

Airport or a city code. Use a three letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory . Example: TPA

M

Date

Departure date. Example: 2017-01-13 Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)

M

Time

Departure time. Example: 09:15 Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)

O

Terminal Information

Terminal information will be present under the Departure and Arrival tags only if the terminal information is available in the flight

O

Arrival

Arrival (destination) Airport, Date and Time information.

M

AirportCode

Airport or a city code. Use a three letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory . Example: TPA

M

Date

Arrival date. Example: 2017-01-13 Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)

O

Time

Arrival time. Example: 09:15 Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)

O

MarketingCarrier

Marketing Carrier information

M

AirlineID

A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory .

M

FlightNumber

Flight Number. Example: 1234, or OPEN, or ARNK

M

Equipment

Aircraft Equipment.

M

AircraftCode

The IATA aircraft type 3 character code; use SSIM Appendix A. Example:318.

M

AirlineEquipCode

Airline-specific aircraft equipment code. Example: 737-800

O

ClassOfService

Class of Service. Example: T

M

Code

Class of Service Code

M

FareBasisCode

Fare basis code. Example: Y26CH

O

FlightDetail

Flight Details.

O

FlightDuration

Flight Duration with application.

M

Stops

Flight Stop Quantity and Location(s).

O

StopQuantity

Stop Quantity. Example: 1

O

<FlightList>

XML Example for the following elements

FlightList

List of Flight elements

M

Flight

Journey information describing the travel between an airport/city where travel commences and an airport/city where travel ultimately terminates. A journey may be comprised of one or more segments. Note: This node will be renamed to journey in future releases.

M

FlightKey (Attribute)

A globally unique identifier for this Flight instance.

O

Journey

Flight journey information.

O

Time

Total Journey Time. Example: PT7H45M (7 hours and 45 minutes) Note: Total journey time includes the combined air time, connection time and/ or stop information for all specified flight segments

O

SegmentReferences

Association to multiple Flight Segment instance(s). Example: segment1 segment2 Note: Flight Slice On and Off Board Points may also be specified.

M

<OriginDestinationList>

XML Example for the following elements

OriginDestination

Origin/ Destination information. Contains a list of all Flight element that are part of that OD.

M

OriginDestinationKey

A globally unique identifier for this OriginDestination instance.

O

DepartureCode

Departure (origin) Airport Code.

M

ArrivalCode

Airport or a city code. Use a three letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory .

Example: TPA

M

FlightReferences

Association to multiple Flight instance(s).

Example: V1_FL.1605138125285

M

OnPoint (Attribute)

Flight slice on point.

O

OffPoint (Attribute)

Flight slice off point.

O

<ServiceDefinitionList>

XML Example for the following elements

ServiceDefinition

Service Definition

M

ServiceDefinitionID

A unique Service ID that has been returned in the Shopping results, and identifies an airline service item (ie a product or a service) that can be separately delivered and uniquely described by an airline.

M

Owner

Airline designator or CRS code of the owner/ assigner of the Offer ID, typically used for offer ordering purposes.

O

Name

Service name.

Example: Lounge Pass

M

Encoding

Service Codes and Reason for Issuance.

O

RFIC

Reason For Issuance Code

Example: A (Air Transportation) C (Baggage) E (Airport Services) F (Merchandise) G (In-flight Services) Refer to PADIS Codeset for data element 4183

M

Code

Service code.

Example: XLEG (Extra Leg Room Seat, implementer encoding) XBAG (Extra Bag, implementer encoding). Used in conjunction with SubCode (Associated Reason For Issuance SubCode)

O

SubCode

Associated Reason For Issuance Sub Code. Examples: 0CC (First Checked Bag) 0B1 (In-flight Entertainment) 0BX (Lounge) 0B3 (Meal/ Beverage) 0B5 (Pre-reserved Seat Assignment) 0G6 (Priority Boarding)

O

Descriptions

SERVICE Description. Note: Supports plain text, multimedia and code and link references

M

Description

Service Description detail.

M

Text

Description value

O

Application

Description Application.

Example: SEAT 3B, Discount 15P

O