GetExchangeVariants

GetExchangeVariants

Getting flights (exchange variants) with information about the return penalty and the difference in price with the current flight booking.

Request

Format Description
  • BookID - ID of the booking with passengers. Data type - 64-bit integer.
  • Passengers - numbers of passengers whose tickets are needed to be exchanged in the booking. Data type - array.
  • Passengers.Ref - passenger number in the booking. Data type - 32-bit integer.
  • RequestedFlightInfo - similar to the RequestedFlightInfo parameter from the Search request.
  • Involuntary - attribute of the involuntary exchange (optional). Data type - bool.

To exchange a part of the segments, for required flight legs you need to indicate the IDs (RequestedFlightInfo.ODPair.ID) of flight legs from the booking which are needed to be exchanged.

To exchange all segments for a completely new flight, you do not need to indicate any flight leg IDs.

  • Restrictions - similar to the Restrictions parameter from the Search request.
Sample
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:avia="http://nemo-ibe.com/Avia" xmlns:stl="http://nemo-ibe.com/STL" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://nemo-ibe.com/STL" xmlns:ns2="http://nemo-ibe.com/Avia">
  <soapenv:Header/>
   <soapenv:Body>
    <avia:GetExchangeVariants>
         <avia:Request>
        <stl:Requisites>
               <stl:AuthToken>token</stl:AuthToken>
            </stl:Requisites>
            <stl:UserID>11111</stl:UserID>
            <stl:RequestType>P</stl:RequestType>
            <stl:RequestBody>
          <avia:BookID>168036</avia:BookID>
               <avia:Passengers>
                  <stl:Ref>1</stl:Ref>
               </avia:Passengers>
               <avia:RequestedFlightInfo>
                  <avia:Direct>false</avia:Direct>
                  <avia:AroundDates>0</avia:AroundDates>
                  <avia:ODPairs>
                     <avia:ODPair>
                    <avia:DepatureDateTime>2024-12-07T00:00:00</avia:DepatureDateTime>
                        <avia:DepaturePoint>
                          <avia:Code>HEL</avia:Code>
                           <avia:IsCity>true</avia:IsCity>
                        </avia:DepaturePoint>
                        <avia:ArrivalPoint>
                          <avia:Code>BCN</avia:Code>
                           <avia:IsCity>true</avia:IsCity>
                        </avia:ArrivalPoint>
                     </avia:ODPair>
                  </avia:ODPairs>
               </avia:RequestedFlightInfo>
               <avia:Restrictions>
                  <avia:ClassPreference>
                     <avia:ClassOfService>Business</avia:ClassOfService>
                  </avia:ClassPreference>
                  <avia:ResultsGrouping>None</avia:ResultsGrouping>
                  <avia:SourcePreference>
                     <avia:Source>-11111</avia:Source>
                  </avia:SourcePreference>
               </avia:Restrictions>
            </stl:RequestBody>
         </avia:Request>
      </avia:GetExchangeVariants>
   </soapenv:Body>
</soapenv:Envelope>

Response

Format Description
  • PlaneFlights - similar to the PlaneFlights parameter from the Search response.
  • SimpleGroupedFlights - similar to the SimpleGroupedFlights parameter from the Search response.
  • ServicesToRefund - container with infromation about ancillaries. Data type - complex.
  • ServicesToRefund.ID - additional service identifier. Data type - integer.
Sample
<?xml version="1.0"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetExchangeVariantsResponse xmlns="http://ws-ibe.com/Avia">
      <GetExchangeVariantsResult xmlns:a="http://ws-ibe.com/STL" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:RequestID>1118603714</a:RequestID>
        <a:ResponseBody>
          <PlaneFlights>
            <Flight>
              <a:ID>1138603714000000</a:ID>
              <SourceID>11111</SourceID>
              <TypeInfo>
                <Type>Regular</Type>
                <DirectionType>OW</DirectionType>
              </TypeInfo>
              <Segments>
                <Segment>
                  <a:ID>1</a:ID>
                  <DepAirp>
                    <AirportCode>HEL</AirportCode>
                    <CityCode>HEL</CityCode>
                    <UTC>2</UTC>
                    <Terminal>2</Terminal>
                  </DepAirp>
                  <ArrAirp>
                    <AirportCode>BCN</AirportCode>
                    <CityCode>BCN</CityCode>
                    <UTC>2</UTC>
                    <Terminal>D</Terminal>
                  </ArrAirp>
                  <FlightNumber>6843</FlightNumber>
                  <OpAirline>AY</OpAirline>
                  <MarkAirline>AY</MarkAirline>
                  <AircraftType>320</AircraftType>
                  <DepDateTime>2017-03-10T21:10:00</DepDateTime>
                  <ArrDateTime>2017-03-10T23:45:00</ArrDateTime>
                  <BookingClass>
                    <BaseClass>Business</BaseClass>
                    <BookingClassCode>I</BookingClassCode>
                    <FreeSeatCount>9</FreeSeatCount>
                  </BookingClass>
                  <ETicket>true</ETicket>
                  <RequestedSegment>0</RequestedSegment>
                </Segment>
              </Segments>
              <PriceInfo>
                <Price>
                  <a:ID>1</a:ID>
                  <ValidatingCompany>AY</ValidatingCompany>
                  <Refundable>Refundable</Refundable>
                  <PrivateFareInd>false</PrivateFareInd>
                  <TicketTimeLimit>2017-03-10T22:10:00</TicketTimeLimit>
                  <PassengerFares>
                    <PassengerFare>
                      <Type>ADT</Type>
                      <Quantity>1</Quantity>
                      <BaseFare>
                        <a:Amount>10</a:Amount>
                        <a:Currency>EUR</a:Currency>
                      </BaseFare>
                      <EquiveFare>
                        <a:Amount>10</a:Amount>
                        <a:Currency>EUR</a:Currency>
                      </EquiveFare>
                      <TotalFare>
                        <a:Amount>15</a:Amount>
                        <a:Currency>EUR</a:Currency>
                      </TotalFare>
                      <Taxes>
                        <Tax>
                          <a:Amount>5</a:Amount>
                          <a:Currency>EUR</a:Currency>
                          <TaxCode>XT</TaxCode>
                        </Tax>
                      </Taxes>
                      <Tariffs>
                        <Tariff>
                          <Code>IBU2FI</Code>
                          <Type>Public</Type>
                          <SegNum>1</SegNum>
                        </Tariff>
                      </Tariffs>
                      <ExchangePriceInfo>
                        <AirlinePenalty>
                          <a:Amount>0</a:Amount>
                          <a:Currency>EUR</a:Currency>
                        </AirlinePenalty>
                        <FlightPriceDifference>
                          <a:Amount>0</a:Amount>
                          <a:Currency>EUR</a:Currency>
                        </FlightPriceDifference>
                      </ExchangePriceInfo>
                    </PassengerFare>
                  </PassengerFares>
                </Price>
              </PriceInfo>
            </Flight>
            <Flight>
              <a:ID>1138603714000001</a:ID>
              <SourceID>11111</SourceID>
              <TypeInfo>
                <Type>Regular</Type>
                <DirectionType>OW</DirectionType>
              </TypeInfo>
              <Segments>
                <Segment>
                  <a:ID>1</a:ID>
                  <DepAirp>
                    <AirportCode>HEL</AirportCode>
                    <CityCode>HEL</CityCode>
                    <UTC>2</UTC>
                    <Terminal>2</Terminal>
                  </DepAirp>
                  <ArrAirp>
                    <AirportCode>BCN</AirportCode>
                    <CityCode>BCN</CityCode>
                    <UTC>2</UTC>
                  </ArrAirp>
                  <FlightNumber>6839</FlightNumber>
                  <OpAirline>AY</OpAirline>
                  <MarkAirline>AY</MarkAirline>
                  <AircraftType>320</AircraftType>
                  <DepDateTime>2017-03-10T12:25:00</DepDateTime>
                  <ArrDateTime>2017-03-10T15:05:00</ArrDateTime>
                  <BookingClass>
                    <BaseClass>Business</BaseClass>
                    <BookingClassCode>I</BookingClassCode>
                    <FreeSeatCount>9</FreeSeatCount>
                  </BookingClass>
                  <ETicket>true</ETicket>
                  <RequestedSegment>0</RequestedSegment>
                </Segment>
              </Segments>
              <PriceInfo>
                <Price>
                  <a:ID>1</a:ID>
                  <ValidatingCompany>AY</ValidatingCompany>
                  <Refundable>Refundable</Refundable>
                  <PrivateFareInd>false</PrivateFareInd>
                  <TicketTimeLimit>2017-03-10T13:25:00</TicketTimeLimit>
                  <PassengerFares>
                    <PassengerFare>
                      <Type>ADT</Type>
                      <Quantity>1</Quantity>
                      <BaseFare>
                        <a:Amount>15</a:Amount>
                        <a:Currency>EUR</a:Currency>
                      </BaseFare>
                      <EquiveFare>
                        <a:Amount>15</a:Amount>
                        <a:Currency>EUR</a:Currency>
                      </EquiveFare>
                      <TotalFare>
                        <a:Amount>25</a:Amount>
                        <a:Currency>EUR</a:Currency>
                      </TotalFare>
                      <Taxes>
                        <Tax>
                          <a:Amount>10</a:Amount>
                          <a:Currency>EUR</a:Currency>
                          <TaxCode>XT</TaxCode>
                        </Tax>
                      </Taxes>
                      <Tariffs>
                        <Tariff>
                          <Code>IBU2FI</Code>
                          <Type>Public</Type>
                          <SegNum>1</SegNum>
                        </Tariff>
                      </Tariffs>
                      <ExchangePriceInfo>
                        <AirlinePenalty>
                          <a:Amount>0</a:Amount>
                          <a:Currency>EUR</a:Currency>
                        </AirlinePenalty>
                        <FlightPriceDifference>
                          <a:Amount>0</a:Amount>
                          <a:Currency>EUR</a:Currency>
                        </FlightPriceDifference>
                      </ExchangePriceInfo>
                    </PassengerFare>
                  </PassengerFares>
                </Price>
              </PriceInfo>
            </Flight>
          </PlaneFlights>
        </a:ResponseBody>
      </GetExchangeVariantsResult>
    </GetExchangeVariantsResponse>
  </s:Body>
</s:Envelope>