21.3 IATA_SeatAvailability RS

User Guidance - Service Input Parameters

Input Parameters

Type

Optional/Mandatory

Request Object

IATA_SeatAvailabilityRS

M

 

  • <Response>

  • <PayloadAttributes>

 

<PayloadAttributes>

<PayloadAttributes>

XML Example for the following elements

<ns3:PayloadAttributes>
            <ns2:Timestamp>2023-10-10T07:24:01.206Z</ns2:Timestamp>
            <ns2:VersionNumber>21.3</ns2:VersionNumber>
 </ns3:PayloadAttributes>

Elements

Details

Mandatory/Optional

PayloadAttributes

IATA payload standard attributes.

O

VersionNumber

The version of the message 

O

VersionNumber

Indicates the creation date and time of the message in UTC.

O

<Response>

<Response>

Elements

Details

Mandatory/Optional

Response

Seat Availability RS response information.

M

<ALaCarteOffer>

Elements

Details

Mandatory/Optional

XML Example for the following elements

<ns2:ALaCarteOffer>
               <ns2:OfferID>SO-eJwdizsOgDAMxU4ESkg-ZKwQbDSigKDTu-8taLE3S.agQdg7ZZ4ZqV5bSeAWo5CjDt4D0ROey7DeBeti2faKSdDKAwaNhG4eCKf9t8qkfhZl1A-izhnR</ns2:OfferID>
               <ns2:OfferItem>
                  <ns2:Eligibility>
                     <ns2:OfferFlightAssociations>
                        <ns2:PaxSegmentReferences>
                           <ns2:PaxSegmentRefID>V1_SEG.1696932958387</ns2:PaxSegmentRefID>
                        </ns2:PaxSegmentReferences>
                     </ns2:OfferFlightAssociations>
                     <ns2:PaxRefID>V1_PAX.1696315491095</ns2:PaxRefID>
                     <ns2:PaxRefID>V1_PAX.1696315491094</ns2:PaxRefID>
                     <ns2:PaxRefID>V1_PAX.1696315491089</ns2:PaxRefID>
                     <ns2:PaxRefID>V1_PAX.1696315491088</ns2:PaxRefID>
                  </ns2:Eligibility>
                  <ns2:OfferItemID>SO1_OI1-eJwzNLM0MzY0NbE0NLQw1M0rzcmJD-Y3VPb3NIw3BEpZGhtZmloYWxoCAMm8CcQ_</ns2:OfferItemID>
                  <ns2:Service>
                     <ns2:ServiceDefinitionRefID>V1_SEATSSR.1696932958351</ns2:ServiceDefinitionRefID>
                     <ns2:ServiceID>V1_SRVC.1696932958345</ns2:ServiceID>
                  </ns2:Service>
                  <ns2:UnitPrice>
                     <ns2:Fee>
                        <ns2:Amount CurCode="TRY">10.00</ns2:Amount>
                     </ns2:Fee>
                     <ns2:TaxSummary>
                        <ns2:Tax>
                           <ns2:Amount CurCode="TRY">1.80</ns2:Amount>
                           <ns2:Country>
                              <ns2:CountryCode>TR</ns2:CountryCode>
                           </ns2:Country>
                           <ns2:TaxCode>VT</ns2:TaxCode>
                           <ns2:TaxName>TAX</ns2:TaxName>
                        </ns2:Tax>
                     </ns2:TaxSummary>
                     <ns2:TotalAmount CurCode="TRY">11.8</ns2:TotalAmount>
                  </ns2:UnitPrice>
               </ns2:OfferItem>
               <ns2:OfferItem>
                  <ns2:Eligibility>
                     <ns2:OfferFlightAssociations>
                        <ns2:PaxSegmentReferences>
                           <ns2:PaxSegmentRefID>V1_SEG.1696932958387</ns2:PaxSegmentRefID>
                        </ns2:PaxSegmentReferences>
                     </ns2:OfferFlightAssociations>
                     <ns2:PaxRefID>V1_PAX.1696315491095</ns2:PaxRefID>
                     <ns2:PaxRefID>V1_PAX.1696315491094</ns2:PaxRefID>
                     <ns2:PaxRefID>V1_PAX.1696315491089</ns2:PaxRefID>
                     <ns2:PaxRefID>V1_PAX.1696315491088</ns2:PaxRefID>
                  </ns2:Eligibility>
                  <ns2:OfferItemID>SO1_OI2-eJwzNLM0MzY0NbE0NLQw1M0rzcmJD-Y3VPb3NIo3BEpZGhtZmloYWxoCAMnLCcU_</ns2:OfferItemID>
                  <ns2:Service>
                     <ns2:ServiceDefinitionRefID>V1_SEATSSR.1696932958337</ns2:ServiceDefinitionRefID>
                     <ns2:ServiceID>V1_SRVC.1696932958339</ns2:ServiceID>
                  </ns2:Service>
                  <ns2:UnitPrice>
                     <ns2:Fee>
                        <ns2:Amount CurCode="TRY">10.00</ns2:Amount>
                     </ns2:Fee>
                     <ns2:TaxSummary>
                        <ns2:Tax>
                           <ns2:Amount CurCode="TRY">1.80</ns2:Amount>
                           <ns2:Country>
                              <ns2:CountryCode>TR</ns2:CountryCode>
                           </ns2:Country>
                           <ns2:TaxCode>VT</ns2:TaxCode>
                           <ns2:TaxName>TAX</ns2:TaxName>
                        </ns2:Tax>
                     </ns2:TaxSummary>
                     <ns2:TotalAmount CurCode="TRY">11.8</ns2:TotalAmount>
                  </ns2:UnitPrice>
               </ns2:OfferItem>
               <ns2:OwnerCode>Airline Name</ns2:OwnerCode>
            </ns2:ALaCarteOffer>

Elements

Details

Mandatory/Optional

ALaCarteOffer

A proposal to sell a specific set of products or Services under specific conditions, for a certain price. 

O

OfferID

Carrier assigned ID which uniquely identifies a specific Offer across several messages. 

M

OfferItem

A priced grouping of one or more services within an Offer. The A La Carte Offer Item assigns a total price for all included services for all passengers and all segments referenced.

M

Eligibility

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

M

OfferFlightAssociations

Offer Flight Associations

O

PaxSegmentReferences

Reference to a PaxSegmentID's - 1 or more pax segments references.

M

PaxSegmentRefID

Reference to a PaxSegmentID

M

PaxRefID

Reference to the passengers who are elibigle for this Offer Item

O

OfferItemID

Carrier assigned ID which exists uniquely within an Offer. 

M

Service

he instance of a specific flight or Service Definition as it has been offered (and eventually ordered and consumed) in the context of a specific Offer and/or Order. At the time of shopping, a service can be sold to multiple passengers on a given journey.

M

ServiceDefinitionRefID

Reference to a service definition.

M

ServiceID

Uniquely Identifies a Service within the context of one message.

M

UnitPrice

The amount of money expected, required, or given in payment for something.

M

Fee

Amount added on to a charge for a specific product, purpose, or service.

O

Amount

Fee Amount

M

TaxSummary

Tax summary information.

O

Tax

A compulsory contribution to state revenue, levied by the government on workers' income and business profits.

O

Amount

Tax amount.

M

Country

A nation with its own government, occupying a particular territory.

O

CountryCode

ISO Country Code

O

TaxCode

IATA TTBS Tax Code

O

TaxName

The name given to describe the tax. For example, this name can be taken from the IATA TTBS

O

TotalAmount

Total monetary price amount, including all tax, surcharge, and fee amounts.

O

<DataLists>

Elements

Details

Mandatory/Optional

DataLists

Data List definition for this message.

O

<DatedMarketingSegmentList>

DatedMarketingSegmentList

A list of dated marketing segments used in the contained message.

O

<DatedMarketingSegment>

XML Example for the following elements

<ns2:DatedMarketingSegment>
                     <ns2:Arrival>
                        <ns2:AircraftScheduledDateTime>2023-10-08T12:00:00Z</ns2:AircraftScheduledDateTime>
                        <ns2:IATA_LocationCode>FRA</ns2:IATA_LocationCode>
                     </ns2:Arrival>
                     <ns2:CarrierDesigCode>Airline Name</ns2:CarrierDesigCode>
                     <ns2:DatedMarketingSegmentId>V1_DATEDMARKETINGSEG.1696932958349</ns2:DatedMarketingSegmentId>
                     <ns2:DatedOperatingSegmentRefId>V1_DATEDOPERATINGSEG.1696932958386</ns2:DatedOperatingSegmentRefId>
                     <ns2:Dep>
                        <ns2:AircraftScheduledDateTime>2023-10-08T02:00:00Z</ns2:AircraftScheduledDateTime>
                        <ns2:IATA_LocationCode>AYT</ns2:IATA_LocationCode>
                     </ns2:Dep>
                     <ns2:MarketingCarrierFlightNumberText>750</ns2:MarketingCarrierFlightNumberText>
</ns2:DatedMarketingSegment>

Elements

Details

Mandatory/Optional

DatedMarketingSegment

The commercial designation under which a Dated Operating Segment can be booked, either under the operating carrier's designator or that of another carrier.

M

Arrival

This is a transport point location.

M

AircraftScheduledDateTime

The Scheduled Date and Time of Arrival of the aircraft at an airport.

O

IATA_LocationCode

IATA 3-letter code defining the city or airport code.

M

CarrierDesigCode

Airline code assigned to a carrier.

M

DatedMarketingSegmentId

Unique identifier of a dated marketing segment used in a message.

M

DatedOperatingSegmentRefId

Reference to a unique identifier of a dated operating segment used in a message.

M

Dep

Departure transport point location

M

MarketingCarrierFlightNumberText

The numerical designation of a flight as it is marketed by a carrier.

M

 

 

 

<DatedOperatingLegList>

Elements

Details

Mandatory/Optional

DatedOperatingLegList

A list of dated operating legs 

O

<DatedOperatingLeg>

XML Example for the following elements

  <ns2:DatedOperatingLeg>
                     <ns2:Arrival>
                        <ns2:AircraftScheduledDateTime>2023-10-08T12:00:00Z</ns2:AircraftScheduledDateTime>
                        <ns2:IATA_LocationCode>FRA</ns2:IATA_LocationCode>
                     </ns2:Arrival>
                     <ns2:CarrierAircraftType>
                        <ns2:CarrierAircraftTypeCode>800</ns2:CarrierAircraftTypeCode>
                        <ns2:CarrierAircraftTypeName>737</ns2:CarrierAircraftTypeName>
                     </ns2:CarrierAircraftType>
                     <ns2:DatedOperatingLegID>V1_EQPT.1696932958384</ns2:DatedOperatingLegID>
                     <ns2:Dep>
                        <ns2:AircraftScheduledDateTime>2023-10-08T02:00:00Z</ns2:AircraftScheduledDateTime>
                        <ns2:IATA_LocationCode>AYT</ns2:IATA_LocationCode>
                     </ns2:Dep>

  </ns2:DatedOperatingLeg>

Elements

Details

Mandatory/Optional

DatedOperatingLeg

The nonstop operation of a transport vehicle between the departure station and the arrival station

M

Arrival

Arrival transport point location

M

AircraftScheduledDateTime

The Scheduled Date and Time of Arrival of the aircraft at the terminal or departure gate at an airport.

O

IATA_LocationCode

IATA 3-letter code defining the city or airport code.

M

CarrierAircraftType

Carrier defined internal grouping of aircrafts with the same form, function and specification.

O

CarrierAircraftTypeCode

Internal code used by an carrier to identify the type of aircraft.

O

CarrierAircraftTypeName

Internal name given by the carrier to this aircraft type.

O

DatedOperatingLegID

Uniquely identifies a leg

M

Dep

Departure transport point location

M

<DatedOperatingSegmentList>

Elements

Details

Mandatory/Optional

DatedOperatingSegmentList

A list of dated operating segments

O

<DatedOperatingSegment>

XML Example for the following elements

<ns2:DatedOperatingSegment>
                     <ns2:CarrierDesigCode>Airline Name</ns2:CarrierDesigCode>
                     <ns2:DatedOperatingLegRefID>V1_EQPT.1696932958384</ns2:DatedOperatingLegRefID>
                     <ns2:DatedOperatingSegmentId>V1_DATEDOPERATINGSEG.1696932958386</ns2:DatedOperatingSegmentId>
                     <ns2:Duration>P0Y0M0DT11H0M0.000S</ns2:Duration>
                     <ns2:OperatingCarrierFlightNumberText>750</ns2:OperatingCarrierFlightNumberText>
  </ns2:DatedOperatingSegment>

Elements

Details

Mandatory/Optional

DatedOperatingSegment

An operation between board point and any subsequent off point within the same flight designator. Could be one or more legs

M

CarrierDesigCode

Airline code assigned to a carrier. 

M

DatedOperatingLegRefID

Uniquely identifies a leg.

O

DatedOperatingSegmentId

Unique identifier of a dated operating segment

M

Duration

Total segment time including the combined air time and connection times of any legs

O

OperatingCarrierFlightNumberText

The numerical designation of a flight as it is operated by a carrier.

O

<OriginDestList>

Elements

Details

Mandatory/Optional

OriginDestList

Origin Destination data list definition.

O

<OriginDest>

XML Example for the following elements

<ns2:OriginDest>
                     <ns2:DestCode>FRA</ns2:DestCode>
                     <ns2:OriginCode>AYT</ns2:OriginCode>
                     <ns2:OriginDestID>V1_OD.1656447765617</ns2:OriginDestID>
                     <ns2:PaxJourneyRefID>V1_FL.1656447765630</ns2:PaxJourneyRefID>     
</ns2:OriginDest>

Elements

Details

Mandatory/Optional

OriginDest

The Origin and Destination airport/city pair which confines a passenger journey or an aircraft flight.

M

DestCode

IATA defined code identifying Destination city or station.

M

OriginCode

IATA defined code identifying Origin city or station.

M

OriginDestID

Uniquely identifies an Origin Destination

M

PaxJourneyRefID

Uniquely identifies a Passenger Journey

O

<PaxJourneyList>

Elements

Details

Mandatory/Optional

PaxJourneyList

Journey data list definition.

O

<PaxJourney>

XML Example for the following elements

 

             <ns2:PaxJourney>
                     <ns2:Duration>P0Y0M0DT11H0M0.000S</ns2:Duration>
                     <ns2:PaxJourneyID>V1_FL.1696932958390</ns2:PaxJourneyID>
                     <ns2:PaxSegmentRefID>V1_SEG.1696932958387</ns2:PaxSegmentRefID>
              </ns2:PaxJourney>
 

PaxJourney

A collection of segments which satisfies transportation of a passenger for a given origin and destination. 

M

Duration

Total journey time including the combined air time and connection times.

O

PaxJourneyID

Uniquely identifies a Passenger Journey.

M

PaxSegmentRefID

Reference to a Passenger Segment ID

M

<PaxList>

Elements

Details

Mandatory/Optional

PaxList

Passenger data list definition.

O

<Pax>

XML Example for the following elements

<ns2:Pax>
                     <ns2:PaxID>V1_PAX.1656447765616</ns2:PaxID>
                     <ns2:PTC>ADT</ns2:PTC>
</ns2:Pax>

Elements

Details

Mandatory/Optional

Pax

Any person except members of the crew carried or to be carried with the consent of the carrie

M

PaxID

Uniquely identifies a Passenger 

M

PTC

Type code applying to the Passenger

O

<PaxSegmentList>

Elements

Details

Mandatory/Optional

PaxSegmentList

Segment data list definition.

O

<PaxSegment>

XML Example for the following elements

<ns2:PaxSegment>
                     <ns2:DatedMarketingSegmentRefId>V1_DATEDMARKETINGSEG.1696932958349</ns2:DatedMarketingSegmentRefId>
                     <ns2:MarketingCarrierRBD_Code>W</ns2:MarketingCarrierRBD_Code>
                     <ns2:PaxSegmentID>V1_SEG.1696932958387</ns2:PaxSegmentID>
 </ns2:PaxSegment>

Elements

Details

Mandatory/Optional

PaxSegment

Transportation of a passenger on a Dated Operating Segment. - [Dated Marketing Segment] (All identifying fields) - [Order] Order ID - [Individual]

M

DatedMarketingSegmentRefId

A reference to a unique identifier of a dated marketing segment used in a message.

M

MarketingCarrierRBD_Code

Code used to identify a particular RBD 

O

PaxSegmentID

Uniquely identifies a Passenger Segment

M

<SeatProfileList>

Elements

Details

Mandatory/Optional

SeatProfileList

Seat Profile data list definition.

O

<SeatProfile>

XML Example for the following elements

<ns2:SeatProfile>
                     <ns2:SeatKeywords>
                        <ns2:KeyText>SEAT-CONFIGURATION</ns2:KeyText>
                        <ns2:ValueText>3-0-0</ns2:ValueText>
                     </ns2:SeatKeywords>
                     <ns2:SeatProfileID>V1_SEATDEF.1696932958344</ns2:SeatProfileID>
 </ns2:SeatProfile>

Elements

Details

Mandatory/Optional

SeatProfile

Airline defined group of seats sharing common characteristics.

M

SeatKeywords

Contextual information to further describe something using a key-value pair.

O

KeyText

Name or ID of the Keyword.

M

ValueText

Value corresponding to the associated Keyword.

M

SeatProfileID

Unique identifier associated to this Seat Profile.

M

<ServiceDefinitionList>

Elements

Details

Mandatory/Optional

ServiceDefinitionList

Segment data list definition.

O

<ServiceDefinition>

XML Example for the following elements

<ns2:ServiceDefinition>
                     <ns2:Desc>
                        <ns2:DescText>Extra Legroom</ns2:DescText>
                     </ns2:Desc>
                     <ns2:Name>Extra Legroom</ns2:Name>
                     <ns2:OwnerCode>Airline Name</ns2:OwnerCode>
                     <ns2:RFIC>I</ns2:RFIC>
                     <ns2:RFISC>I99</ns2:RFISC>
                     <ns2:ServiceCode>XLEG</ns2:ServiceCode>
                     <ns2:ServiceDefinitionID>V1_SEATSSR.1696932958351</ns2:ServiceDefinitionID>
 </ns2:ServiceDefinition>

Elements

Details

Mandatory/Optional

ServiceDefinition

Description and characteristics of a non-flight product or service that can be separately sold and delivered

M

Desc

An account or representation of the certain or major aspects, characteristics, or features of a person, object, or event.

O

DescText

Description text value.

O

Name

Service name. Example: Lounge Pass.

M

OwnerCode

Airline code assigned to a carrier.

M

RFIC

Reason For Issuance Code 

O

RFISC

Reason For Issuance Sub Code. 

O

ServiceCode

Airline specific service code which can be associated with the Reason for Issuance Sub Code.

O

ServiceDefinitionID

Uniquely Identifies a Service Definition.

M

 

<SeatMap>

<ns2:SeatMap>
    <ns2:CabinCompartment>
        <ns2:CabinCompartmentID>V1_COMPRTMNT.1696932958348</ns2:CabinCompartmentID>

        <ns2:CabinComponent>
            <ns2:CabinComponentTypeCode>D</ns2:CabinComponentTypeCode>
            <ns2:ColumnID>A</ns2:ColumnID>
            <ns2:FirstRowNumber>1</ns2:FirstRowNumber>
            <ns2:LastRowNumber>1</ns2:LastRowNumber>

              <!--Optional-->

            <ns2:OrientationCode>R</ns2:OrientationCode>
        </ns2:CabinComponent>

        <ns2:CabinType>
            <ns2:CabinTypeCode>Y</ns2:CabinTypeCode>
            <ns2:CabinTypeName>ECONOMY</ns2:CabinTypeName>
        </ns2:CabinType>
        <ns2:DeckCode>Lower</ns2:DeckCode>
        <ns2:FirstRowNumber>1</ns2:FirstRowNumber>
        <ns2:LastRowNumber>33</ns2:LastRowNumber>
        <ns2:SeatColumn>
            <ns2:ColumnID>A</ns2:ColumnID>
        </ns2:SeatColumn>

        <ns2:SeatRow>
            <ns2:RowNumber>1</ns2:RowNumber>
            <ns2:Seat>
                <ns2:ColumnID>A</ns2:ColumnID>
                <ns2:OccupationStatusCode>F</ns2:OccupationStatusCode>
                <ns2:OfferItemRefID>SO1_OI1-eJwzNLM0MzY0NbE0NLQw1M0rzcmJD-Y3VPb3NIw3BEpZGhtZmloYWxoCAMm8CcQ_</ns2:OfferItemRefID>
                <ns2:RowNumber>1</ns2:RowNumber>
                <ns2:SeatCharacteristicCode>W</ns2:SeatCharacteristicCode>
                <ns2:SeatCharacteristicCode>N</ns2:SeatCharacteristicCode>
                <ns2:SeatCharacteristicCode>L</ns2:SeatCharacteristicCode>
                <ns2:SeatProfileRefID>V1_SEATDEF.1696932958344</ns2:SeatProfileRefID>
            </ns2:Seat>
        </ns2:SeatRow>
    </ns2:CabinCompartment>
    <ns2:PaxSegmentRefID>V1_SEG.1696932958387</ns2:PaxSegmentRefID>
</ns2:SeatMap>

Elements

Details

Mandatory/Optional

SeatMap

The list of cabins and the seats within in. 

M

CabinCompartment

A physical aircraft compartment where passenger seats are installed, classified by a given Cabin Type. 

M

CabinCompartmentID

Identifier assigned by a Carrier which uniquely identifies a Cabin Compartment.

O

CabinComponent

Non-seat related cabin feature or facility (e.g. lavatory, galley, closet, stowage, etc.) Business Identifier Fields

O

CabinComponentTypeCode

Code of the cabin component Type

M

ColumnID

Identifier of the column.

O

FirstRowNumber

First row number of the Cabin Component.

O

LastRowNumber

Last row number of the Cabin Component.

O

OrientationCode

Indicates the orientation, or direction of the component.

O

CabinType

Type of compartment of an aircraft, 

O

CabinTypeCode

Cabin Type Code as defined by ATSB codeset 9873.

O

CabinTypeName

Name given to a cabin compartment

O

DeckCode

Aircraft deck code

O

FirstRowNumber

First row number of the Cabin Compartment.

O

LastRowNumber

Last row number of the Cabin Compartment.

O

SeatColumn

A sitting place column for a passenger or crew in a cabin compartment on a transport vehicle.

O

ColumnID

Alphabetic character identifying a seat within a row.

M

SeatRow

Row of passenger seats located in the cabin.

O

RowNumber

Ordinal number identifying a seat row in an aircraft.

M

Seat

A sitting place for a passenger or crew in a cabin compartment on a transport vehicle.

M

OccupationStatusCode

Information related to the availability of a particular Seat on Leg.

O

OfferItemRefID

Reference to the price point applicable to this individual seat. Multiple seats can reference the same OfferItem.

O

SeatCharacteristicCode

Characteristic of an aircraft seat.

O

SeatProfileRefID

Reference to a Seat Profile ID .

O

PaxSegmentRefID

References a Passenger Segment 

M

<PayloadAttributes>

XML Example for the following elements

<ns3:PayloadAttributes>
            <ns2:Timestamp>2023-10-10T07:24:01.206Z</ns2:Timestamp>
            <ns2:VersionNumber>21.3</ns2:VersionNumber>

 </ns3:PayloadAttributes>

Elements

Details

Mandatory/Optional

PayloadAttributes

IATA payload standard attributes.

O

Timestamp

Indicates the creation date and time of the message in UTC.

O

VersionNumber

The version of the message 

O