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

User Guidance - Service Input Parameters

Input Parameters

Type

Optional/Mandatory

Request Object

ServiceListRQ

M

  • <ServiceListRQ>

  • <Document>

  • <Party>

  • <Query>

  • <DataLists>

  • <MetaData>

<ServiceListRQ >

XML Example for the following elements

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

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

O

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

In case of Agency Bookings, OtherIDs will be mandatory to specify the Channel Code.

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

O

<Query>

XML Example for Query Object

ServiceList request for selected flights in the Selected Offer

In order to retrieve ancillaries in a particular segment/s it need to mention required segment.
Set OfferItemID refs attribute, which referring to an Augmentation key.
<ns:Query>
 <ns:Offers>
    <ns:Offer>
       <ns:OfferID Owner="V1" ResponseID="tx-08-201-f7e19798-c640-48e4">OF1-eJx9zkEKwjAUBNATWfKn-cnPMtYWXNhijWBWc-9bmCBSdeEsB.Yx4kUQJQ7inTCVPG.JojGYKVwLH1di8EznJXO6b5zGdVkvhT2CRuMtsy4YtOtxkA8uslrpdGycBYXtnAAs4yy-niE0rxDsTTv35RkrVh..PKvNfs-5f17CG6R7AvtjPfI_</ns:OfferID>
            <ns:OfferItemIDs>
                 <ns:OfferItemID Owner="V1" refs="V1_SEGREFS_1512868178668">OF1_OI1-eJx9zkEKwjAUBNATWfKn-cnPMtYWXNhijWBWc-9bmCBSdeEsB.Yx4kUQJQ7inTCVPG.JojGYKVwLH1di8EznJXO6b5zGdVkvhT2CRuMtsy4YtOtxkA8uslrpdGycBYXtnAAs4yy-niE0rxDsTTv35RkrVh..PKvNfs-5f17CG6R7AvtjPfI_</ns:OfferItemID>                     
             </ns:OfferItemIDs>
         </ns:Offer>
  </ns:Offers>
</ns:Query>

Augmentation point SegmentIDReferences hold the segment keys.
(Under MetaData/shoppping/ShopMetadataGroup/Flight/FlightMetadatas/FlightMetadata/AugmentationPoint/AugPoint).
 <ns:FlightMetadata MetadataKey="V1_MDK.11">
    <ns:AugmentationPoint>
        <ns:AugPoint Key="V1_SEGREFS_1512868178668">
            <ibs:SegmentIDReferences>V1_SEG.1512868178664</ibs:SegmentIDReferences>
        </ns:AugPoint>
    </ns:AugmentationPoint>
</ns:FlightMetadata>

ServiceList request for all flights in the Selected Offer

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

Service List request for all flights in the selected Offer with Notifiable true

In order to retrieve ancillaries in notification mode.
Set OfferItemID refs attribute, which referring to an Augmentation key with notifyable value.
<ns:Query>
 <ns:Offers>
    <ns:Offer>
       <ns:OfferID Owner="V1" ResponseID="tx-08-201-f7e19798-c640-48e4">OF1-eJx9zkEKwjAUBNATWfKn-cnPMtYWXNhijWBWc-9bmCBSdeEsB.Yx4kUQJQ7inTCVPG.JojGYKVwLH1di8EznJXO6b5zGdVkvhT2CRuMtsy4YtOtxkA8uslrpdGycBYXtnAAs4yy-niE0rxDsTTv35RkrVh..PKvNfs-5f17CG6R7AvtjPfI_</ns:OfferID>
            <ns:OfferItemIDs>
                 <ns:OfferItemID Owner="V1" refs="V1_AUG.3">OF1_OI1-eJx9zkEKwjAUBNATWfKn-cnPMtYWXNhijWBWc-9bmCBSdeEsB.Yx4kUQJQ7inTCVPG.JojGYKVwLH1di8EznJXO6b5zGdVkvhT2CRuMtsy4YtOtxkA8uslrpdGycBYXtnAAs4yy-niE0rxDsTTv35RkrVh..PKvNfs-5f17CG6R7AvtjPfI_</ns:OfferItemID>                     
             </ns:OfferItemIDs>
         </ns:Offer>
  </ns:Offers>
</ns:Query>

Augmentation key NotifiableServiceAugPoint hold the true or false values.(Default will be false)
(Under MetaData/shoppping/ShopMetadataGroup/Offer/OfferMetadatas/OfferMetadata/AugmentationPoint/AugPoint).
 <ns:OfferMetadatas>
   <ns:OfferMetadata MetadataKey="V1_MDK.11">
          <ns:AugmentationPoint>
                <ns:AugPoint Key="V1_AUG.3">
                      <ibs:NotifiableServiceAugPoint>
                      <isNotifiableService>true</isNotifiableService>
                      </ibs:NotifiableServiceAugPoint>
                </ns:AugPoint>
           </ns:AugmentationPoint>
        </ns:OfferMetadata>
 </ns:OfferMetadatas>

Service List request for selected flight in the selected Offer with Notifiable true

In order to retrieve ancillaries in a particular segment/s and retrieve ancillaries in notification mode.
Set OfferItemID refs attribute, which referring to an Augmentation key  refering a required segment and Set OfferItemID refs attribute, which referring to an Augmentation key with notifyable value.
<ns:Query>
 <ns:Offers>
    <ns:Offer>
       <ns:OfferID Owner="V1" ResponseID="tx-08-201-f7e19798-c640-48e4">OF1-eJx9zkEKwjAUBNATWfKn-cnPMtYWXNhijWBWc-9bmCBSdeEsB.Yx4kUQJQ7inTCVPG.JojGYKVwLH1di8EznJXO6b5zGdVkvhT2CRuMtsy4YtOtxkA8uslrpdGycBYXtnAAs4yy-niE0rxDsTTv35RkrVh..PKvNfs-5f17CG6R7AvtjPfI_</ns:OfferID>
            <ns:OfferItemIDs>
                 <ns:OfferItemID Owner="V1" refs="V1_SEGREFS_1512868178668 V1_AUG.3">OF1_OI1-eJx9zkEKwjAUBNATWfKn-cnPMtYWXNhijWBWc-9bmCBSdeEsB.Yx4kUQJQ7inTCVPG.JojGYKVwLH1di8EznJXO6b5zGdVkvhT2CRuMtsy4YtOtxkA8uslrpdGycBYXtnAAs4yy-niE0rxDsTTv35RkrVh..PKvNfs-5f17CG6R7AvtjPfI_</ns:OfferItemID>                     
             </ns:OfferItemIDs>
         </ns:Offer>
  </ns:Offers>
</ns:Query>

Augmentation point SegmentIDReferences hold the segment keys.
(Under MetaData/shoppping/ShopMetadataGroup/Flight/FlightMetadatas/FlightMetadata/AugmentationPoint/AugPoint).
<ns:FlightMetadata MetadataKey="V1_MDK.11">
    <ns:AugmentationPoint>
        <ns:AugPoint Key="V1_SEGREFS_1512868178668">
            <ibs:SegmentIDReferences>V1_SEG.1512868178664</ibs:SegmentIDReferences>
        </ns:AugPoint>
    </ns:AugmentationPoint>
</ns:FlightMetadata>
  
Augmentation key NotifiableServiceAugPoint hold the true or false values.(Default will be false)
(Under MetaData/shoppping/ShopMetadataGroup/Offer/OfferMetadatas/OfferMetadata/AugmentationPoint/AugPoint).
 <ns:OfferMetadatas>
   <ns:OfferMetadata MetadataKey="V1_MDK.11">
          <ns:AugmentationPoint>
                <ns:AugPoint Key="V1_AUG.3">
                      <ibs:NotifiableServiceAugPoint>
                      <isNotifiableService>true</isNotifiableService>
                      </ibs:NotifiableServiceAugPoint>
                </ns:AugPoint>
           </ns:AugmentationPoint>
        </ns:OfferMetadata>
 </ns:OfferMetadatas>

Elements

Details

Mandatory/Optional

Query

Core Query for ServiceList

M

Offers

Airline Offers

M

Offer

To get a service 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

OfferItemIDs

Offer items

M

OfferItemID

The airline-assigned unique Offer Item ID. The client should pass the OfferItemID that is returned in AirShoppingRS.

OfferItemID (Attribute)

  • OfferItemID (Attribute) corresponds to Flight Fare Offer details will be passed from the AirShoppingRS of the selected offer.

M

refs (Attribute)

Object association(s) between this object and any other object or metadata instance(s).

refs (Attribute)

The values can be reference to the Augmentation point with respect to the Segment Reference and Notifiable Indicator.

Example: refs="V1_SEGREFS_1512868178668 V1_AUG.3"

O

<DataLists>

<ns:DataLists>
    <ns:PassengerList>
        <ns:Passenger PassengerID = "V1_PAX.1605138123033">
            <ns:PTC>ADT</ns:PTC>
        </ns:Passenger>
        <ns:Passenger PassengerID = "V1_PAX.1605138123038">
            <ns:PTC>ADT</ns:PTC>
        </ns:Passenger>
        <ns:Passenger PassengerID = "V1_PAX.1605138123039">
            <ns:PTC>CHD</ns:PTC>
        </ns:Passenger>
        <ns:Passenger PassengerID = "V1_PAX.1605138123036">
            <ns:PTC>INF</ns:PTC>
        </ns:Passenger>
    </ns:PassengerList>
</ns:DataLists>

PassengerList

Passenger data list definition/details.

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

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

<Metadata>

<ns:Metadata>
    <ns:Shopping>
        <ns:ShopMetadataGroup>
            <ns:Flight>
                <ns:FlightMetadatas>
                    <ns:FlightMetadata MetadataKey="V1_MDK.11">
                        <ns:AugmentationPoint>
                            <ns:AugPoint Key="V1_SEGREFS_1512868178668">
                                <ibs:SegmentIDRefsAugPoint>
                                    <SegmentIDReferences>V1_SEG_1512868178664</SegmentIDReferences>
                                </ibs:SegmentIDRefsAugPoint>
                            </ns:AugPoint>
                        </ns:AugmentationPoint>
                    </ns:FlightMetadata>
                </ns:FlightMetadatas>
            </ns:Flight>
            <ns:Offer>
                <ns:OfferMetadatas>
                    <ns:OfferMetadata MetadataKey="V1_MDK.11">
                        <ns:AugmentationPoint>
                            <ns:AugPoint Key="V1_AUG.3">
                                <ibs:NotifiableServiceAugPoint>
                                    <isNotifiableService>true</isNotifiableService>
                                </ibs:NotifiableServiceAugPoint>
                            </ns:AugPoint>
                        </ns:AugmentationPoint>
                    </ns:OfferMetadata>
                </ns:OfferMetadatas>
            </ns:Offer>
        </ns:ShopMetadataGroup>
    </ns:Shopping>
</ns:Metadata>

FlightMetadata

Used to mention the segment references in case of retrieve ancillaries in a particular segment/s out of the selected Itinerary.

SegmentIDReferences can be a space separated ones.

Eg: 

 <SegmentIDReferences>V1_SEG_1512868178664 V1_SEG_1512868178665</SegmentIDReferences>

O

OfferMetadata

Used to mention the notifiable values.

isNotifiableService values Can be true or false, default value will be false.

Eg:

<ibs:NotifiableServiceAugPoint>
      <isNotifiableService>true</isNotifiableService>
 </ibs:NotifiableServiceAugPoint>
<ibs:NotifiableServiceAugPoint>
      <isNotifiableService>false</isNotifiableService>
</ibs:NotifiableServiceAugPoint>

O

  • No labels