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

SoapHeader

XML Example

<soapenv:Header>
      <api_access_key>Airline Name-Channel Code</api_access_key>
</soapenv:Header>

<api_access_key>

AirlineCode-Channel Code

User Guidance - Service Input Parameters

Input Parameters

Type

Optional/Mandatory

Request Object

IATA_SeatAvailabilityRQ

M

  • <DistributionChain>

  • <PayloadAttributes>

  • <POS>

  • <Request>

<DistributionChain>

XML Example for the following elements

B2B Flow

<iata:DistributionChain>
            <!--1 or more repetitions:-->
            <iata1:DistributionChainLink>
               <iata1:Ordinal>1</iata1:Ordinal>
               <iata1:OrgRole>Carrier</iata1:OrgRole>
               <iata1:ParticipatingOrg>
                  <iata1:Name>Airline Name</iata1:Name>
                  <iata1:OrgID>Airline Code</iata1:OrgID>
               </iata1:ParticipatingOrg>
            </iata1:DistributionChainLink>
            <iata1:DistributionChainLink>
               <iata1:Ordinal>2</iata1:Ordinal>
               <iata1:OrgRole>Seller</iata1:OrgRole>
               <iata1:ParticipatingOrg>
                  <iata1:Name>Channel Name</iata1:Name>
                  <iata1:OrgID>Channel Code</iata1:OrgID>
               </iata1:ParticipatingOrg>
            </iata1:DistributionChainLink>
</iata:DistributionChain>

B2C Flow

<iata:DistributionChain>
    <!--1 or more repetitions:-->
    <iata1:DistributionChainLink>
        <iata1:Ordinal>1</iata1:Ordinal>
        <iata1:OrgRole>Carrier</iata1:OrgRole>
        <iata1:ParticipatingOrg>
            <iata1:Name>Airline Name</iata1:Name>
            <iata1:OrgID>Airline Code</iata1:OrgID>
        </iata1:ParticipatingOrg>
    </iata1:DistributionChainLink>
    <iata1:DistributionChainLink>
        <iata1:Ordinal>2</iata1:Ordinal>
        <iata1:OrgRole>Seller</iata1:OrgRole>
        <iata1:ParticipatingOrg>
            <iata1:Name>Channel Name</iata1:Name>
            <iata1:OrgID>Channel Code</iata1:OrgID>
        </iata1:ParticipatingOrg>
        <iata1:SalesAgent>
            <iata1:SalesAgentID>AgencyID</iata1:SalesAgentID>
        </iata1:SalesAgent>
        <iata1:SalesBranch>
            <iata1:SalesBranchID>AgencyCode</iata1:SalesBranchID>
        </iata1:SalesBranch>
    </iata1:DistributionChainLink>
</iata:DistributionChain>

Elements

Details

Optional/Mandatory

DistributionChain

The set of organizations involved in the development of the current transaction.

M

DistributionChainLink

An organization playing a participating role in an instance of a distribution channel.

M

Ordinal

The number defining the position of the distribution chain link in the distribution chain indicating the order in which the organization participated.

M

OrgRole

The distribution chain role performed by the participating organization

M

ParticipatingOrg

An organized structure set up for a particular purpose

M

Name

Name of the organization

O

OrgID

Organization code

M

SalesAgent

An individual conducting sales activities on behalf of a sales branch or organization.

O

SalesAgentID

The unique identifier of the sales agent. This value must be accompanied by the appropriate Sales Branch Identifier

M

SalesBranch

An organizational unit with responsibility over sales in a market, for a product or service and under any other specified criteria.

O

SalesBranchID

The industry wide unique identifier of the sales branch. 

M

<PayloadAttributes>

XML Example for the following elements

<iata:PayloadAttributes>

            <iata1:VersionNumber>21.3</iata1:VersionNumber>

</iata:PayloadAttributes>

Elements

Details

Mandatory/Optional

PayloadAttributes

IATA payload standard attributes.

O

VersionNumber

The version of the message 

O

<POS>

XML Example for the following elements

<iata:POS>
            <iata1:Country>
               <iata1:CountryCode>DE</iata1:CountryCode>
            </iata1:Country>
</iata:POS>

Elements

Details

Mandatory/Optional

POS

Point of Sale Information

O

Country

A nation with its own government

O

CountryCode

Country Code

O

<Request>

<Pax>

Elements

Details

Mandatory/Optional

Request

SeatAvailabilityRQ request information

M

XML Example for the following elements

<!--1 or more repetitions:-->

<iata1:Pax>
                    <iata1:PaxID>V1_PAX.1687515895394</iata1:PaxID>
                    <iata1:PTC>ADT</iata1:PTC>
</iata1:Pax>

Elements

Details

Mandatory/Optional

Pax

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

M

PaxID

Uniquely identifies a Passenger within the context of one message

M

PTC

Type code applying to the Passenger which typically drives pricing (e.g. ADT, CHD, etc).

O

<SeatAvailCoreRequest>

  <!--You have a CHOICE of the next 2 items at this level-->

Elements

Details

Mandatory/Optional

SeatAvailCoreRequest

Seat Availability Core Request

M

<OfferRequest>

XML Example for the following elements

 <iata1:OfferRequest>

                  <!--1 or more repetitions:-->
                  <iata1:Offer>
                     <iata1:OfferID>OF1-eJw1jDEOgCAUQ0.k6QeB72j8GhYhxjgw9f63EAbbpS9pnkRNSwoKiUFpm.WtUKKqOCSM8M5c4dmM72M89lrq1frHeXRinxRgBkfLBNZThuL3emX7AEFgGkE_</iata1:OfferID>

                     <!--1 or more repetitions:-->
                     <iata1:OfferItem>
                        <iata1:OfferItemID>OF1_OI1-eJwzNLMwNzE3tTAwNDO10PV3M1T29zSMN0SIGlsAAIjpB6E_</iata1:OfferItemID>
                     </iata1:OfferItem>
                     <iata1:OwnerCode>QH</iata1:OwnerCode>

                 </iata1:Offer>
</iata1:OfferRequest>

Elements

Details

Mandatory/Optional

OfferRequest

This is a request using offers

M

Offer

This is a specialized seat availability offer used in the context of a Shopping Request.

M

OfferID

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

M

OfferItem

This is a specialized seat availability offer item used in the context of a Shopping Request.

M

OfferItemID

Carrier assigned ID which exists uniquely within an Offer. 

M

OwnerCode

Designator of Airline that owns/ assigned 

M

PaxSegmentRefID

Reference to a Passenger Segment ID from a previously returned Offer.

O

<OrderRequest>

XML Example for the following elements

<iata1:OrderRequest>
                  <iata1:Order>
                     <iata1:OrderID>QH926HV3W22HV</iata1:OrderID>

                      <!--zero or more repetitions:-->
                     <iata1:OrderItem>
                        <iata1:OrderItemID>V1_ORITM_PAX.48611456_SEG.500-SEG.501</iata1:OrderItemID>
                       <iata1:OwnerCode>QH</iata1:OwnerCode>

                      <!--zero or more repetitions:-->    

                       <iata1:PaxSegmentRefID>V1_SEG.501</iata1:PaxSegmentRefID>

                     </iata1:OrderItem>
                     <iata1:OwnerCode>QH</iata1:OwnerCode>
                  </iata1:Order>
  </iata1:OrderRequest>

Elements

Details

Mandatory/Optional

OrderRequest

This is request using Order(s)

M

Order

A specialized order used in a Seat Availability request defined as a uniquely identified record of the agreement of one party with another to receive products and services under specified terms and conditions.

M

OrderID

Carrier assigned ID which uniquely identifies a specific Order.

M

OrderItem

A seat availability request individually priced item within a Service Request Order, 

O

OrderItemID

Carrier assigned ID which exists uniquely within an Order.

M

OwnerCode

Airline code assigned to a carrier.

M

PaxSegmentRefID

Reference to a Passenger Segment ID from a previously returned Offer.

O

  • No labels