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

AirShoppingRQ

User Guidance - Service Input Parameters

Input Parameters

Type

Optional/Mandatory

Request Object

AirShoppingRQ

M

  • <AirShoppingRQ>

  • <Document>

  • <Party>

  • <CoreQuery>

  • <DataLists>

<AirShoppingRQ>

XML Example for the following elements

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

Elements

Details

Optional/Mandatory

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

Optional/Mandatory

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

Location

Point of sale location information.

CountryCode

Country Code

M

CityCode

Airport or City Code

M

RequestTime

Point Of Sale Timestamp value

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

M

Zone

Point of Sale timezone

Example : UTC, CET

M

<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

Optional/Mandatory

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

<CoreQuery>

XML Example for the following elements

  <ns:CoreQuery>
    <ns:OriginDestinations>
        <ns:OriginDestination>
            <ns:Departure>
                <ns:AirportCode>AYT</ns:AirportCode>
                <ns:Date>2019-07-05</ns:Date>
            </ns:Departure>
            <ns:Arrival>
                <ns:AirportCode>FRA</ns:AirportCode>
            </ns:Arrival>
            <ns:CalendarDates DaysBefore="0" DaysAfter="0"/>
        </ns:OriginDestination>
    </ns:OriginDestinations>
</ns:CoreQuery>

Elements

Details

Optional/Mandatory

CoreQuery

Start of AirShopping Query

M

OriginDestinations

Origin and destination (O&D) details

M

OriginDestination

This must be repeated for each O&D. If the request is for EDI-AMS return then this must be repeated twice one for EDI-AMS and one for AMS-EDI

M

OriginDestinationKey (attribute)

This is the unique key to be used when requesting any preference at Origin-Destination level

O

Departure

Departure airport/city details

M

AirportCode

Accepts both airport code (LHR) and city code (LON)

M

Date

Departure date

Example: 2015-08-14

M

Arrival

Arrival airport/city details

M

AirportCode

Accepts both airport code (LHR) and city code (LON)

M

CalendarDates

Indicates Calendar search date.

Calendar recommendation will only be returned if the client specifies calendar search dates in the request

O

DaysAfter (Attribute)

The number of days after the requested date

Example: 3

Calendar recommendation will be returned for the number of days specified after the requested date

O

DaysBefore (Attribute)

The number of days before the requested date

Example: 3

Calendar recommendation will be returned for the number of days specified before the requested date

O

<Preference>

Elements

Details

Optional/Mandatory

Preference

Fare and cabin preference can be specified here

O

FarePreferences

Specify fare preference.

O

XML Example for the following elements

<ns:Preference>
<ns:FarePreferences>
    <ns:Types>
        <ns:Type>SUNECO</ns:Type>
    </ns:Types>
</ns:FarePreferences>
</ns:Preference>

CabinPreferences

Specify Cabin preference code.

O

XML Example for the following elements

<ns:Preference>
<ns:CabinPreferences>
    <ns:CabinType>
        <ns:Code>4</ns:Code>
    </ns:CabinType>
</ns:CabinPreferences>
</ns:Preference>

<DataLists>

XML

Elements

Details

Optional/Mandatory

<PassengerList>

PassengerList

Passenger data list definition/details.

O

XML Example for the following elements

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

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

 

<ns:Passenger PassengerID = "V1_PAX.1">

PassengerID (Attribute)

 

 

Uniquely identifies a Passenger within the context of one message.

Example:

V1_PAX.1, V1_PAX.2 ,V1_PAX.3

M

 

<ns:PTC>INF</ns:PTC>

PTC

Type code applying to the Passenger which typically drives pricing.

Example: ADT, CHD, INF

O

  • No labels