Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

  • <Document>

  • <Success>

  • <ALaCarteOffer>

  • <SeatMap>

  • <DataLists>

User Guidance

Input Parameters

Type

Mandatory/Optional

Request Object

SeatAvailabilityRS

M

< SeatAvailabilityRS >

XML Example for the following elements

<SeatAvailabilityRS Version="17.2" xmlns="http://www.iata.org/IATA/EDIST">

Elements

Details

Mandatory/Optional

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

<Document>

XML Example for the following elements

<ns2:Document>
           <ns2:Name>NDC</ns2:Name>
           <ns2:ReferenceVersion>17.2</ns2:ReferenceVersion>
</ns2:Document>

Elements

Details

Mandatory/Optional

Document

NDC Message Document information

M

Name

Document name will be always "NDC

o

ReferenceVersion

It 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

<Processing>

Elements

Details

Mandatory/Optional

Processing

Message Processing Results. May include errors, business warnings, alternate offers indicator, supplemental marketing messages and/ or additional information required to complete a transaction.

M

<ALaCarteOffer>

Elements

Details

Mandatory/Optional

ALaCarteOffer

Container for standalone optional OfferItems.

M

<ns2:ALaCarteOffer OfferID = "SO-eJxlzEsKgzAURuEVKfeRm9wMg1go.ECbgo7.-e-C2EEp9AzP4ONIxuosSimgnPWxF3Akl5Aj3eHY2hCU51IxvneMw7qs8wmVZNnxqigwsFiv0vHXYw1oWCM-npvTj6eY-jxVy3J7ExTZ.5hAF7-dKXM_" Owner = "AILRINE CODE">

ALaCarteOfferItem

One Service or Service Bundle which is priced per unit.

M

XML Example for the following elements

 <ns2:ALaCarteOfferItem OfferItemID = "SO1_OI1-eJwVyDsOgCAQBcAr7S4fodwYTCyEiJhI9S5A7Ly-OuWwJ8cmsBiaLLS3pSrYUxAbPf1w7V8IdM0N6axIc8ll6zAyuRhwNCgc7mcM0AsYLhWG">
    <ns2:Eligibility>
        <ns2:PassengerRefs>V1_PAX.1605138125307 V1_PAX.1605138125304 V1_PAX.1605138125305</ns2:PassengerRefs>
        <ns2:SegmentRefs>V1_SEG.1605138123074</ns2:SegmentRefs>
    </ns2:Eligibility>
    <ns2:UnitPriceDetail>
        <ns2:TotalAmount>
            <ns2:DetailCurrencyPrice>
                <ns2:Total Code = "EUR">34.18</ns2:Total>
                <ns2:Details>
                    <ns2:Detail>
                        <ns2:SubTotal Code = "EUR">28.97</ns2:SubTotal>
                    </ns2:Detail>
                </ns2:Details>
            </ns2:DetailCurrencyPrice>
        </ns2:TotalAmount>
        <ns2:Taxes>
            <ns2:Breakdown>
                <ns2:Tax>
                    <ns2:Amount Code = "EUR">5.21</ns2:Amount>
                    <ns2:Nation>TR</ns2:Nation>
                    <ns2:TaxCode>VT</ns2:TaxCode>
                    <ns2:TaxType>TAX</ns2:TaxType>
                </ns2:Tax>
            </ns2:Breakdown>
        </ns2:Taxes>
    </ns2:UnitPriceDetail>
    <ns2:Service ServiceID = "V1_SRVC.1605138125309">
        <ns2:ServiceDefinitionRef>V1_SEATSSR.1605138125311</ns2:ServiceDefinitionRef>
    </ns2:Service>
</ns2:ALaCarteOfferItem>

Eligibility

Refers to the Passengers, Price class or Segments for which this offer item is eligible

M

PassengerRefs

Reference to the passengers who are eligible for this Offer Item

M

SegmentRefs

Segment Reference

UnitPriceDetail

Flat price for an individual unit of the referenced Service

M

TotalAmount

M

DetailCurrencyPrice

M

Total

Total seat price

M

Code (Attribute)

Currency code

O

Service

One or more instances of a 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 (Attribute)

Unique id for a service eg : V1_SRVC.1560995779189

M

ServiceDefinitionRef

Reference to ServiceItems across different OfferItems

M

<SeatMap>

SeatMap

This element shows the seat map of a particular segment. Returns a list of cabins and the seats within it.

Multiple SeatMap will come when the SeatAvailability is searched for multiple flights.

M

Cabin

This is a list and will be repeated once for upper deck and once for the main deck when the requested cabin is spread across the upper and main deck.

Also this element is repeated if the Flight have multiple cabin class like ECONOMY, BUSINESS etc

M

UpperDeckInd (Attribute)

“True” means this seat is on the upper deck
“False” means this seat is on the main deck

O

<CabinType>

CabinType

Cabin type. Example : ECONOMY, BUSINESS

M

XML Example for the following elements

<ns2:CabinType>
    <ns2:Name>ECONOMY</ns2:Name>
    <ns2:Code>Y</ns2:Code>
</ns2:CabinType>

Name

ECONOMY

M

Code

Y

M

<CabinLayout>

CabinLayout

Row Details of the Cabin

M

XML Example for the following elements

<ns2:CabinLayout>
    <ns2:Columns>A</ns2:Columns>
    <ns2:Columns>B</ns2:Columns>
    <ns2:Columns>C</ns2:Columns>
    <ns2:Columns>D</ns2:Columns>
    <ns2:Columns>E</ns2:Columns>
    <ns2:Columns>F</ns2:Columns>
    <ns2:Rows>
        <ns2:First>1</ns2:First>
        <ns2:Last>34</ns2:Last>
    </ns2:Rows>
    <ns2:ExitRowPosition>
        <ns2:RowPosition>
            <ns2:First>18</ns2:First>
            <ns2:Last>18</ns2:Last>
        </ns2:RowPosition>
    </ns2:ExitRowPosition>
</ns2:CabinLayout>

Columns

Seat column to identify a particular seat position on an aircraft
Returns the list of columns for the cabin
Example: A,B,C,D,E,F

M

Rows

Contains rows and seat information for seat display purposes
Returns the starting end row position for each column

M

First

First-row number
Row starting row position for columns A,B,C,D,E,F
Example: 4

M

Last

Last row number
Row ending row position for columns A,B,C,D,E,F
Example: 55

M

ExitRowPosition

Return the exit row information, if applicable. This must be returned regardless of whether exit row seats are open or are returned as valid seats

O

RowPosition

EXIT row detail

M

First

Exit seat  starting row position
Example: 4

M

Last

Exit seat  ending row position
Example: 55

M

<Component>

Component

Non-Seat Cabin Component information like Jump Seat, Galley, Lavatory, Door etc..

This is where the non-seat characteristics are returned

O

XML Example for the following elements

<ns2:Component>
    <ns2:Type>D</ns2:Type>
    <ns2:Location>
        <ns2:RowPosition>
            <ns2:Begin>1</ns2:Begin>
            <ns2:End>1</ns2:End>
            <ns2:ColumnPosition>C</ns2:ColumnPosition>
        </ns2:RowPosition>
    </ns2:Location>
</ns2:Component>

Type

Cabin component

M

Location

The physical location of the cabin component

M

RowPosition

A range of rows covered by a non-seat cabin component for seat map information.

M

Begin

Non-seat's row position
First row occupied by this item.

M

End

M

ColumnPosition

Column position of the Non-Seat Component

M

<Row>

Row

Seat row

M

XML Example for the following elements

<ns2:Row>
    <ns2:Number>1</ns2:Number>
    <ns2:Seat>
        <ns2:Column>A</ns2:Column>
        <ns2:SeatStatus>Z</ns2:SeatStatus>
        <ns2:SeatCharacteristics>
            <ns2:Code>W</ns2:Code>
            <ns2:Code>N</ns2:Code>
        </ns2:SeatCharacteristics>
        <ns2:OfferItemRefs>SO1_OI1-eJwVyDsOgCAQBcAr7S4fodwYTCyEiJhI9S5A7Ly-OuWwJ8cmsBiaLLS3pSrYUxAbPf1w7V8IdM0N6axIc8ll6zAyuRhwNCgc7mcM0AsYLhWG</ns2:OfferItemRefs>
    </ns2:Seat>
    <ns2:Seat>
        <ns2:Column>B</ns2:Column>
        <ns2:SeatStatus>Z</ns2:SeatStatus>
        <ns2:SeatCharacteristics>
            <ns2:Code>N</ns2:Code>
        </ns2:SeatCharacteristics>
        <ns2:OfferItemRefs>SO1_OI1-eJwVyDsOgCAQBcAr7S4fodwYTCyEiJhI9S5A7Ly-OuWwJ8cmsBiaLLS3pSrYUxAbPf1w7V8IdM0N6axIc8ll6zAyuRhwNCgc7mcM0AsYLhWG</ns2:OfferItemRefs>
    </ns2:Seat>
    <ns2:Seat>
        <ns2:Column>C</ns2:Column>
        <ns2:SeatStatus>Z</ns2:SeatStatus>
        <ns2:SeatCharacteristics>
            <ns2:Code>A</ns2:Code>
            <ns2:Code>N</ns2:Code>
        </ns2:SeatCharacteristics>
        <ns2:OfferItemRefs>SO1_OI1-eJwVyDsOgCAQBcAr7S4fodwYTCyEiJhI9S5A7Ly-OuWwJ8cmsBiaLLS3pSrYUxAbPf1w7V8IdM0N6axIc8ll6zAyuRhwNCgc7mcM0AsYLhWG</ns2:OfferItemRefs>
    </ns2:Seat>
</ns2:Row>

Number

Seat Row Number

M

Seat

SEAT Info. This consist of a information of list of Seat which comes in a same row.

M

Column

Column number of the Seat

M

SeatStatus

Seat status

M

SeatCharacteristics

Seat information

Code

Refers to aircraft seat characteristics; seat option codes

M

OfferItemRefs

Reference to the AlaCataOfferItem applicable to this individual seat. Multiple seats can reference the same AlaCataOfferItem.

This will be available only if the the Seat have any fee assocated to it.

O

<DataLists>

<PassengerList>

PassengerList

Passenger data list definition/details.

O

XML Example for the following elements

<ns2:PassengerList>
    <ns2:Passenger PassengerID = "V1_PAX.1605138125307">
        <ns2:PTC>INF</ns2:PTC>
    </ns2:Passenger>
    <ns2:Passenger PassengerID = "V1_PAX.1605138125304">
        <ns2:PTC>CHD</ns2:PTC>
    </ns2:Passenger>
    <ns2:Passenger PassengerID = "V1_PAX.1605138125305">
        <ns2:PTC>ADT</ns2:PTC>
    </ns2:Passenger>
</ns2:PassengerList>

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 (e.g. ADT, CHD, etc).

O

<ServiceDefinitionList>

ServiceDefinitionList

Service definition list which has been offered.

O

XML Example for the following elements

<ns2:ServiceDefinitionList>
    <ns2:ServiceDefinition ServiceDefinitionID = "V1_SEATSSR.1605138125311">
        <ns2:Name>Extra Legroom</ns2:Name>
        <ns2:Encoding>
            <ns2:RFIC>I</ns2:RFIC>
            <ns2:Code>XLEG</ns2:Code>
            <ns2:SubCode>I99</ns2:SubCode>
        </ns2:Encoding>
        <ns2:FeeMethod>OC</ns2:FeeMethod>
        <ns2:Descriptions>
            <ns2:Description>
                <ns2:Text>Extra Legroom</ns2:Text>
                <ns2:Application>DESCRIPTION</ns2:Application>
            </ns2:Description>
        </ns2:Descriptions>
        <ns2:Settlement>
            <ns2:Method>AD</ns2:Method>
        </ns2:Settlement>
    </ns2:ServiceDefinition>
    <ns2:ServiceDefinition ServiceDefinitionID = "V1_SEATSSR.1605138125258">
        <ns2:Name>standard seat</ns2:Name>
        <ns2:Encoding>
            <ns2:RFIC>I</ns2:RFIC>
            <ns2:Code>STRA</ns2:Code>
            <ns2:SubCode>I99</ns2:SubCode>
        </ns2:Encoding>
        <ns2:FeeMethod>OC</ns2:FeeMethod>
        <ns2:Descriptions>
            <ns2:Description>
                <ns2:Text>Standard Seat Zone A</ns2:Text>
                <ns2:Application>DESCRIPTION</ns2:Application>
            </ns2:Description>
        </ns2:Descriptions>
        <ns2:Settlement>
            <ns2:Method>AD</ns2:Method>
        </ns2:Settlement>
    </ns2:ServiceDefinition>
    <ns2:ServiceDefinition ServiceDefinitionID = "V1_SEATSSR.1605138126530">
        <ns2:Name>SEAT-FREE</ns2:Name>
        <ns2:Descriptions>
            <ns2:Description>
                <ns2:Text>SEAT-FREE</ns2:Text>
            </ns2:Description>
        </ns2:Descriptions>
    </ns2:ServiceDefinition>
</ns2:ServiceDefinitionList>

ServiceDefinition

Service Definition Detail

O

ServiceDefinitionID (Attribute)

Unique ID

Example : V1_SEATSSR_1549440901033

O

Name

Example : SEAT SELECTION

O

Encoding

Service Codes and Reason for Issuance.

O

RFIC

Reason For Issuance Code
Example : C – Baggage , A – Air Transportation

O

Code

Service code.
Examples : XLEG - Extra Leg Room Seat,
XBAG - Extra Bag

O

SubCode

Associated Reason For Issuance Sub Code
Examples : 0CC - First Checked Bag,
0B1 - In-flight Entertainment

O

FeeMethod

Two character generic code to identify ticket
level charges, fees and taxes

O

Descriptions

SERVICE Description.

O

Description

Service Description detail.

O

Text

Description value.
IBS Description : Description for the SSR.
Max Length: 150

O

Application

Description Application

O

Settlement

Interline Settlement information between airlines, including method of settlement,interline settlement value and currency.

O

Method

Service settlement method.
Examples: AD - Internal Airline Document
DS – Direct Settlement
EA - EMD Associated or Internal Airline Document
ES - EMD Standalone

O

<FlightSegmentList>

FlightSegmentList

Flight segment details for the requested itinerary

O

<ns2:FlightSegmentList>
    <ns2:FlightSegment SegmentKey = "V1_SEG.1605138123074">
        <ns2:Departure>
            <ns2:AirportCode>AYT</ns2:AirportCode>
            <ns2:Date>2020-12-18Z</ns2:Date>
            <ns2:Time>00:00</ns2:Time>
        </ns2:Departure>
        <ns2:Arrival>
            <ns2:AirportCode>FRA</ns2:AirportCode>
            <ns2:Date>2020-12-18Z</ns2:Date>
            <ns2:Time>00:00</ns2:Time>
            <ns2:ChangeOfDay>0</ns2:ChangeOfDay>
        </ns2:Arrival>
        <ns2:MarketingCarrier>
            <ns2:AirlineID>AIRLINE CODE</ns2:AirlineID>
            <ns2:FlightNumber>162</ns2:FlightNumber>
        </ns2:MarketingCarrier>
        <ns2:Equipment>
            <ns2:AircraftCode>737</ns2:AircraftCode>
            <ns2:AirlineEquipCode>800</ns2:AirlineEquipCode>
        </ns2:Equipment>
        <ns2:FlightDetail>
            <ns2:FlightDuration>
                <ns2:Value>P0Y0M0DT2H0M0.000S</ns2:Value>
            </ns2:FlightDuration>
        </ns2:FlightDetail>
    </ns2:FlightSegment>
</ns2:FlightSegmentList>

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

Arrival

Arrival (destination) Airport, Date and Time information.

M

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.

O

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

O

Code

Class of Service Code

O

FareBasisCode

Fare basis code. Example: Y26CH

O

FlightDetail

Flight Details.

O

FlightDuration

Flight Duration with application.

O

Stops

Flight Stop Quantity and Location(s).

O

StopQuantity

Stop Quantity. Example: 1

O

<FlightList>

FlightList

FlightList details for the requested itinerary

O

<ns2:FlightList>
    <ns2:Flight FlightKey = "V1_FL.1605138125285">
        <ns2:Journey>
            <ns2:Time>P0Y0M0DT2H0M0.000S</ns2:Time>
        </ns2:Journey>
        <ns2:SegmentReferences>V1_SEG.1605138123074</ns2:SegmentReferences>
    </ns2:Flight>
</ns2:FlightList>

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

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>

OriginDestinationList

OriginDestinationList details for the requested itinerary

O

<ns2:OriginDestinationList>
    <ns2:OriginDestination OriginDestinationKey = "V1_OD.1605138125306">
        <ns2:DepartureCode>AYT</ns2:DepartureCode>
        <ns2:ArrivalCode>FRA</ns2:ArrivalCode>
        <ns2:FlightReferences>V1_FL.1605138125285</ns2:FlightReferences>
    </ns2:OriginDestination>
</ns2:OriginDestinationList>

OriginDestination

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

M

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: flight1 flight2 Note: Flight Slice On and Off Board Points may also be specified.

O

  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.