Page Comparison

User Guidance - Service Input Parameters
Input Parameters	Type	Optional/Mandatory
Request Object	ServiceListRQ	M

...

<ServiceListRQ >

XML Example for the following elements

Code Block

language	xml

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

Elements

Details

Mandatory/Optional

Code Block
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

...

<Query>

XML Example for Query Object

ServiceList request for selected flights in the Selected Offer

Code Block

language	xml

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

Code Block

language	xml

<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

Code Block

language	xml

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

Code Block

language	xml

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.

Tip

Mapping Logic: From the selected Offer of AirShoppingRS

Xpath:/AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferID (Attribute)

M

ResponseID (Attribute)

ResponseID value

Info

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 (Attribute)

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

Info

OfferItemID (Attribute)

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

Tip

Mapping Logic: From the selected Offer of AirShoppingRS

Xpath:/AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/OfferItenID (Attribute)

M

refs (Attribute)

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

Info

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

...

Versions Compared

Old Version 14

New Version Current

Key

User Guidance - Service Input Parameters

<ServiceListRQ >

XML Example for the following elements

<Query>