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 8 Current »

User Guidance - Service Input Parameters

Input Parameters

Type

Optional/Mandatory

Request Object

SeatAvailabilityRQ

M

  • <SeatAvailabilityRQ>

  • <Document>

  • <Party>

  • <Query>

  • <DataLists>

<SeatAvailabilityRQ>

XML Example for the following elements

<SeatAvailabilityRQ 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

<Document>
        <Name>NDC</Name>
        <ReferenceVersion>17.2</ReferenceVersion>
</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

<PointOfSale>

XML Example for the following elements

<ns:PointOfSale>
    <ns:Location>
        <ns:CountryCode>IT</ns:CountryCode>
        <ns:CityCode>ROM</ns:CityCode>
    </ns:Location>
    <ns:RequestTime Zone = "CET">2019-01-28T07:01:00</ns:RequestTime>
</ns:PointOfSale>

Elements

Details

Mandatory/Optional

PointOfSale

Point of Sale information.

M

Location

Point of sale location information.

O

CountryCode

Country Code

M

CityCode

Airport or City Code

M

RequestTime

Point Of Sale Timestamp value

 Example: 2017-01-13T13:59:38Z

O

Zone (Attribute)

Point of Sale timezone

 Example : UTC, CET

O

<Party>

XML Example for the following elements

Normal bookings/B2C bookings

<ns:Party>
    <ns:Sender>
        <ns:AgentUserSender>
            <ns:Name>CHANNEL NAME</ns:Name>
            <ns:AgentUserID>CHANNEL CODE</ns:AgentUserID>
        </ns:AgentUserSender>
    </ns:Sender>
    <ns:Recipient>
        <ns:ORA_Recipient>
            <ns:AirlineID>AIRLINE CODE</ns:AirlineID>
            <ns:Name>AIRLINE NAME</ns:Name>
        </ns:ORA_Recipient>
    </ns:Recipient>
</ns:Party>

B2B login/travel agent login

<edis:Party>
    <edis:Sender>
        <edis:AgentUserSender>
            <edis:OtherIDs>
                <edis:OtherID Description = "Booking Channel ID">CHANNEL CODE given by IBS</edis:OtherID>
            </edis:OtherIDs>
            <edis:AgentUserID Owner = "Agency code">Agent id</edis:AgentUserID>
        </edis:AgentUserSender>
    </edis:Sender>
    <edis:Recipient>
        <edis:ORA_Recipient>
            <edis:AirlineID>AIRLINE CODE</edis:AirlineID>
            <edis:Name>AIRLINE NAME</edis:Name>
        </edis:ORA_Recipient>
    </edis:Recipient>
</edis:Party>

Elements

Details

Mandatory/Optional

Party

Party & Sender Definition

M

Sender

Message Sender information.

M

AgentUserSender

Agent User Sender Details

M

Name

Agency Seller Name

M

AgentUserID

User ID of the Agent

AgentUserID

In case of B2C bookings, AgentUserID holds the channel code.

Example:

<ns:AgentUserID>CHANNELXXX</ns:AgentUserID>

M

Owner (Attribute)

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

Owner (Attribute)

In case of a Travel Agent booking, Owner value will be the Agency Code.

Example:

<edis:AgentUserID Owner = "TravelDestiny">TravelAgent1</edis:AgentUserID>

O

OtherIDs

Additional Agency (Seller) identification

O

OtherID

Other Identifier

M

Description (Attribute)

Other identification description.

Description (Attribute)

In case of a Travel Agent Booking, Description value will be “Booking Channel ID”

M

Recipient

Named Message Recipient.

M

ORA_Recipient

SUPPLIER: ORA (Offer Originating Airline)

Recipient.

M

AirlineID

Airline ID

M

Name

Airline Name

M

Owner (Attribute)

Agency Code in Case of B2B

M

<Query>

XML Example for Query Object

SeatAvailability request for selected flights in the Selected Offer

<ns:Query>
      <ns:Offer OfferID="OF1-eJx9zkEKwjAUBNATWfKn-cnPMtYWXNhijWBWc-9bmCBSdeEsB.Yx4kUQJQ7inTCVPG.JojGYKVwLH1di8EznJXO6b5zGdVkvhT2CRuMtsy4YtOtxkA8uslrpdGycBYXtnAAs4yy-niE0rxDsTTv35RkrVh..PKvNfs-5f17CG6R7AvtjPfI_" Owner="AIRLINE CODE" ResponseID="tx-08-201-f7e19798-c640-48e4">
       	  <ns:SegmentID>V1_SEG.1</ns:SegmentID>
          <ns:SegmentID>V1_SEG.2</ns:SegmentID>
      </ns:Offer>
</ns:Query>

SeatAvailability request for all flights in the Selected Offer

<ns:Query>
      <ns:Offer OfferID="OF1-eJx9zkEKwjAUBNATWfKn-cnPMtYWXNhijWBWc-9bmCBSdeEsB.Yx4kUQJQ7inTCVPG.JojGYKVwLH1di8EznJXO6b5zGdVkvhT2CRuMtsy4YtOtxkA8uslrpdGycBYXtnAAs4yy-niE0rxDsTTv35RkrVh..PKvNfs-5f17CG6R7AvtjPfI_" Owner="AIRLINE CODE" ResponseID="tx-08-201-f7e19798-c640-48e4">
      </ns:Offer>
</ns:Query>

Elements

Details

Mandatory/Optional

Query

Core Query for SeatAvailabilty

M

Offer

To get a Seat Info using shortsell, the client should use this tag to provide details.

M

OfferID (Attribute)

This is the OfferID returned in AirShoppingRS for the Selected offer the customer wishes to book the flight

M

ResponseID (Attribute)

ResponseID value

This response ID will be available in AirShoppingRS in future release.

Now dummy response value can be set in this attribute field.

Example: "tx-08-201-f7e19798-c640-48e4"

M

Owner (Attribute)

Should be always set to Airline Code

M

SegmentID

Reference to the segment for which seat maps are required.
The SegmentID can be obtained from the previous service.
The absence of this element is equivalent to an all-segments request.

SegmentID can be obtained from the AirShoppingRS in case of OrderCreation.

Requested flight segment needs to be part of the OfferId.

O

<DataLists>

Elements

Details

Mandatory/Optional

PassengerList

Passenger data list definition/details.

M

<ns:DataLists>
    <ns:PassengerList>
        <ns:Passenger PassengerID = "V1_PAX.1">
            <ns:PTC>ADT</ns:PTC>
        </ns:Passenger>
        <ns:Passenger PassengerID = "V1_PAX.2">
            <ns:PTC>CHD</ns:PTC>
        </ns:Passenger>
    </ns:PassengerList>
</ns:DataLists>

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

PassengerID (Attribute)

Uniquely identifies a Passenger within the context of one message.

Example: V1_PAX.1, V1_PAX.2 ,V1_PAX.3

M

PTC

Type code applying to the Passenger which typically drives pricing.

Example: ADT, CHD, INF

M

  • No labels