DateRangeSearch

DateRangeSearch

Request for date range search.

Request

Format Description

• RequestedFlightInfo — contains information about the flight segments you want to find. Data type — complex.
• RequestedFlightInfo.ODPairs — contains information about the flight segments you want to find. Data type — complex.
• RequestedFlightInfo.ODPair — the flight segment you want to find. Data type — complex.
• RequestedFlightInfo.ODPair.StartDate — date and time from which the desired departure begins (mandatory). Data type — string, the format is yyy-MM-ddTHH:mm:ss.
• RequestedFlightInfo.ODPair.EndDate — date and time of the desired departure end (mandatory). Data type — string, the format is yyyy-MM-ddTHH:mm:ss.
• RequestedFlightInfo.ODPair.DepaturePoint — contains information about the departure point. Data type — complex.
• RequestedFlightInfo.ODPair.DepaturePoint.Code — 3-letter code of the airport/city of departure (mandatory). Data type — string.
• RequestedFlightInfo.ODPair.DepaturePoint.IsCity — indication that the transmitted code is the city code (airport aggregator). Data type — boolean.
• RequestedFlightInfo.ODPair.ArrivalPoint — contains information about the arrival point. Data type — complex. The format is similar to the DepaturePoint element.
• RequestedFlightInfo.ODPair.ArrivalPoint.Code — 3-letter code of the airport/city of arrival (mandatory). Data type — string.
• RequestedFlightInfo.ODPair.ArrivalPoint.IsCity — indication that the transmitted code is the city code (airport aggregator). Data type — boolean.
• Restrictions — contains restrictions applied to search results. Data type — complex.
• Restrictions.CurrencyCode — 3-letter code for the currency of the search results output. Data type — string.
• Restrictions.CompanyFilter — array of airline filters. Data type — array.
• Restrictions.CompanyFilter.Company — information about airline filtering. Data type — array.
• Restrictions.CompanyFilter.Company.Code — 2-letter airline code which triggers the filter criteria. Data type — string.
• Restrictions.CompanyFilter.Company.Include — filtering type. Data type — boolean:
  • false — the airline will be excluded from search results output;
  • true — the airline will be included to search results output.
• Restrictions.CompanyFilter.Company.SegmentNumber — number of the requested flight segment (numbering from 1 in this case), for which this airline is required. Data type — 32-bit integer.
• Restrictions.PrivateFaresOnly — search only for private fares. Data type — boolean.
• Restrictions.ClassPreference — list of preferred flight classes. Data type — complex.
• Restrictions.ClassPreference.ClassOfService — type of preferred flight class (mandatory). Data type — enumeration. Possible values are:
  • Economy — economy class only;
  • Business — business class only;
  • First — first class only;
  • PremiumEconomy — premium economy class only;
  • All — all classes.
• Restrictions.MaxConnectionTime — maximum connection time in minutes. Data type — 32-bit integer.
• Restrictions.PriceRefundType — required price type in the search request. Data type — enumeration. Possible values are:
  • AnyLowest — the lowest prices;
  • Refundable — the lowest prices with the possibility of a free refund;
  • Both — set of search retrieval searches for maximum and minimum return prices.
• Restrictions.ResultsGrouping — type of search results output grouping. Data type — enumeration. Possible values are:
  • Simple — simple grouping;
  • Advanced — advanced grouping;
  • None — no grouping.
• Restrictions.SourcePreference — list of preferred flights sources. Data type — complex.
• Restrictions.SourcePreference.Source — ID of preferred flights source (mandatory). Data type — 32-bit integer.
• Restrictions.RequestorTags — tags of request sender. Data type — array.
• Restrictions.RequestorTags.Tag — one of tags of request sender defining them by some criterion. Data type — string.
• Restrictions.MaxResultCount — maximum number of flights in GDS response. Data type — 32-bit integer.
• Restrictions.AsyncSearch search type. Data type — boolean:
  • false — synchronous search;
  • true — asynchronous search with ability pulling of supliers' response portions.
• EndUserData — data of end user. Data type — complex, The format is similar to the EndUserData element from DataItem.

Examples

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:avia="http://ws-ibe.com/Avia" xmlns:stl="http://ws-ibe.com/STL" xmlns:avia1="http://websky.travel/Avia">
   <soapenv:Header/>
   <soapenv:Body>
      <avia:DateRangeSearch>
         <avia:Request>
            <stl:Requisites>
               <stl:AuthToken>token</stl:AuthToken>
            </stl:Requisites>
            <stl:UserID>11111</stl:UserID>
            <stl:RequestType>P</stl:RequestType>
            <stl:RequestBody>
               <avia1:RequestedFlightInfo>
                  <avia1:ODPairs>
                     <avia1:ODPair>
                        <avia1:StartDate>2024-12-02T00:00:00</avia1:StartDate>
                        <avia1:EndDate>2024-12-21T00:00:00</avia1:EndDate>
                        <avia1:DeparturePoint>
                           <avia:Code>PAR</avia:Code>
                           <avia:IsCity>true</avia:IsCity>
                        </avia1:DeparturePoint>
                        <avia1:ArrivalPoint>
                           <avia:Code>BCN</avia:Code>
                           <avia:IsCity>true</avia:IsCity>
                        </avia1:ArrivalPoint>
                     </avia1:ODPair>
                  </avia1:ODPairs>
               </avia1:RequestedFlightInfo>
               <avia1:Restrictions>
                  <avia:ClassPreference>
                     <avia:ClassOfService>Economy</avia:ClassOfService>
                  </avia:ClassPreference>
                  <avia:ResultsGrouping>None</avia:ResultsGrouping>
                  <avia:SourcePreference>
                     <avia:Source>-10000</avia:Source>
                  </avia:SourcePreference>
               </avia1:Restrictions>
            </stl:RequestBody>
         </avia:Request>
      </avia:DateRangeSearch>
   </soapenv:Body>
</soapenv:Envelope>

Response

Format Description

• PlaneFlights — contains search results output (Flight elements) Search Data type — complex.

Examples

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <DateRangeSearchResponse xmlns="http://ws-ibe.com/Avia">
         <DateRangeSearchResult xmlns:a="http://ws-ibe.com/STL" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:RequestID>1000000006</a:RequestID>
            <a:ResponseBody>
               <SearchData>
                  <Now i:nil="true"/>
                  <StartTime>2024-12-27 17:13:10 +03:00</StartTime>
                  <IsComplete>true</IsComplete>
                  <IsAsync>false</IsAsync>
                  <Sources i:nil="true"/>
                  <SearchThreads>
                     <SearchThreadInfo>
                        <SourceID>-10000</SourceID>
                        <IsComplete>true</IsComplete>
                        <StartTime>2024-12-27 14:13:10 +00:00</StartTime>
                        <Duration>00:00:00.1691782</Duration>
                        <FromCache>false</FromCache>
                        <OriginalSearchID>1000000006</OriginalSearchID>
                     </SearchThreadInfo>
                  </SearchThreads>
                  <ProcessingData>
                     <FlightsFromSuppliersCount>2</FlightsFromSuppliersCount>
                  </ProcessingData>
               </SearchData>
               <PlaneFlights>
                  <Flight>
                     <a:ID i:nil="true"/>
                     <SourceID>-10000</SourceID>
                     <TypeInfo>
                        <Type>Regular</Type>
                        <DirectionType>OW</DirectionType>
                     </TypeInfo>
                     <MandatoryLatinNames>true</MandatoryLatinNames>
                     <Segments>
                        <Segment>
                           <a:ID>0</a:ID>
                           <DepAirp>
                              <AirportCode>CDG</AirportCode>
                              <CityCode>PAR</CityCode>
                              <UTC>3</UTC>
                           </DepAirp>
                           <ArrAirp>
                              <AirportCode>BCN</AirportCode>
                              <CityCode>BCN</CityCode>
                              <UTC>5</UTC>
                           </ArrAirp>
                           <FlightNumber>373</FlightNumber>
                           <DepDateTime>2024-12-27T00:00:00</DepDateTime>
                           <ArrDateTime>2024-12-27T00:00:00</ArrDateTime>
                           <ETicket>false</ETicket>
                           <RequestedSegment>0</RequestedSegment>
                        </Segment>
                     </Segments>
                     <PriceInfo>
                        <Price>
                           <a:ID>0</a:ID>
                           <ValidatingCompany i:nil="true"/>
                           <Refundable>Unknown</Refundable>
                           <PrivateFareInd>false</PrivateFareInd>
                           <PassengerFares>
                              <PassengerFare>
                                 <Type>ADT</Type>
                                 <Quantity>1</Quantity>
                                 <TotalFare>
                                    <a:Amount>92.74</a:Amount>
                                    <a:Currency>USD</a:Currency>
                                 </TotalFare>
                              </PassengerFare>
                           </PassengerFares>
                        </Price>
                     </PriceInfo>
                  </Flight>
                  <Flight>
                     <a:ID i:nil="true"/>
                     <SourceID>-10000</SourceID>
                     <TypeInfo>
                        <Type>Regular</Type>
                        <DirectionType>OW</DirectionType>
                     </TypeInfo>
                     <MandatoryLatinNames>true</MandatoryLatinNames>
                     <Segments>
                        <Segment>
                           <a:ID>0</a:ID>
                           <DepAirp>
                              <AirportCode>CDG</AirportCode>
                              <CityCode>PAR</CityCode>
                              <UTC>3</UTC>
                           </DepAirp>
                           <ArrAirp>
                              <AirportCode>BCN</AirportCode>
                              <CityCode>BCN</CityCode>
                              <UTC>5</UTC>
                           </ArrAirp>
                           <FlightNumber>373</FlightNumber>
                           <DepDateTime>2024-12-28T00:00:00</DepDateTime>
                           <ArrDateTime>2024-12-28T00:00:00</ArrDateTime>
                           <ETicket>false</ETicket>
                           <RequestedSegment>0</RequestedSegment>
                        </Segment>
                     </Segments>
                     <PriceInfo>
                        <Price>
                           <a:ID>0</a:ID>
                           <ValidatingCompany i:nil="true"/>
                           <Refundable>Unknown</Refundable>
                           <PrivateFareInd>false</PrivateFareInd>
                           <PassengerFares>
                              <PassengerFare>
                                 <Type>ADT</Type>
                                 <Quantity>1</Quantity>
                                 <TotalFare>
                                    <a:Amount>92.74</a:Amount>
                                    <a:Currency>USD</a:Currency>
                                 </TotalFare>
                              </PassengerFare>
                           </PassengerFares>
                        </Price>
                     </PriceInfo>
                  </Flight>
               </PlaneFlights>
            </a:ResponseBody>
         </DateRangeSearchResult>
      </DateRangeSearchResponse>
   </s:Body>
</s:Envelope>