UDDS OX API - documentation ver.2.4 (2022-04-06) ( www.dlaoperatora.pl )

SearchParams structure

Rodzaje parametrów:

  $searchParams [ 'xxxx' ] = array() to parametr wielokrotny typu array.
  $searchParams [ 'xxxx' ] = array() oznaczony jako ( from - to ) to parametr przekazujący zakres od - do.
                             Wartość od jest zawsze w elemencie o indeksie [0].
                             Wartość do jest zawsze w elemencie o indeksie [1].    
  
  $searchParams [ 'xxxx' ] = '' to parametr pojedyńczy typu string lub data w formacie ( YYYY-MM-DD ).
  $searchParams [ 'xxxx' ] = 0 to parametr pojedyńczy typu integer.
  
Struktura parametrów wyszukiwania::

  $searchParams = array() ;
  
  // dot. wszystkich ofert :
  
  $searchParams [ 'offerGroup' ] = array() ;        // OFERTY_WWW.RODZAJ_OFERTY
  $searchParams [ 'offerSubGroup' ] = array() ;     // OFERTY_WWW.ID_GRUPY
  $searchParams [ 'offerCode' ] = array() ;         // OFERTY_WWW.NUMER_OFERTY
  $searchParams [ 'idOffer' ] = array() ;           // OFERTY_WWW.ID_OFERTY
  $searchParams [ 'offerActive' ] = '' ;            // OFERTY_WWW.AKTYWNA ( domyślnie = 1 )
  $searchParams [ 'category' ] = array() ;          // ( from - to ) - ilość gwiazdek *10 ( czyli od *** do **** to wartości od 30 do 40 ) OFERTY_BP.KATEGORIA
  $searchParams [ 'accommodation' ] = array() ;     // OFERTY_BP_PLAN_ZAKWATEROWANIE.ID_ZAKWATEROWANIA
  $searchParams [ 'transport' ] = array() ;         // OFERTY_BP_PLAN_TRANSPORT.ID_TRANSPORTU ( możliwe wartości : autokar | samolot | pociąg | statek | własny )
  $searchParams [ 'countryRegionCity' ] = array() ; // OFERTY_BP_PLAN_PANSTWA.NAZWA_PANSTWA && OFERTY_BP_PLAN_OBSZARY.NAZWA_OBSZARU && OFERTY_BP_PLAN_MIEJSCOWOSCI.NAZWA_MIEJSCOWOSCI
                                                    //    Przykład wyboru wielokrotnego:
                                                    //    Array
                                                    //    (
                                                    //        [0] => Francja,Alpy Południowe
                                                    //        [1] => Francja,Alpy Wysokie
                                                    //        [2] => Włochy
                                                    //        [3] => Polska,Tatry,Zakopane
                                                    //    )
                                                    //    W każdym rekordzie Możemy podać oddzielone przecinkami wartości:
                                                    //    [] => [country],[region],[city]
                                                    //    
                                                    //    Możliwe warianty:
                                                    //    [] => [country]
                                                    //    [] => [country],[region]
                                                    //    [] => [country],[region],[city]
                                                    //
                                                    // zalecane jest używanie tego parametry zamiast parametrów wyszukujących po jednym rodzaju "obszaru" : country, region, city
                                                                                                        
  $searchParams [ 'country' ] = array() ;           // OFERTY_BP_PLAN_PANSTWA.NAZWA_PANSTWA ( zalecane używanie parametru countryRegionCity )
  $searchParams [ 'region' ] = array() ;            // OFERTY_BP_PLAN_OBSZARY.NAZWA_OBSZARU ( zalecane używanie parametru countryRegionCity )
  $searchParams [ 'city' ] = array() ;              // OFERTY_BP_PLAN_MIEJSCOWOSCI.NAZWA_MIEJSCOWOSCI ( zalecane używanie parametru countryRegionCity )
  $searchParams [ 'offerAttribute' ] = array() ;    // OFERTY_WWW_ATRYBUTY.GRUPA && OFERTY_WWW_ATRYBUTY.ATRYBUT. Pojedyńczy element przekazywany jako "[grupa],[nazwa_atrybutu]"
  $searchParams [ 'offerProfile' ] = array() ;      // OFERTY_WWW_PROFIL.NAZWA_PROFILU ( między profilami jest spójnik AND czyli oferta musi mieć wszystkie )
  $searchParams [ 'offerPromotion' ] = array() ;    // OFERTY_WWW_WYROZNIENIA.ID_WYROZNIENIA
  $searchParams [ 'text' ] = '' ;                   // TextSearch in: title, offerNo, country, region, city, profiles, attributes ( simple like search ).

  // dotyczy ofert z terminami i bez
  
  $searchParams [ 'feeding' ] = array() ;           // OFERTY_BP.WYZYWIENIE albo dla trips OFERTY_BP_TERMINY.WYZYWIENIE
  $searchParams [ 'roomCode' ] = array() ;          // OFERTY_BP.POKOJ_KOD albo dla trips OFERTY_BP_TERMINY.POKOJ_KOD
  $searchParams [ 'priceAdult1' ] = array() ;       // ( from - to ) OFERTY_WWW.CENA * KURS OFERTY_WWW.CENA_NETTO_WALUTA albo dla trips kalkulowana
  $searchParams [ 'priceTotal' ] = array() ;        // ( from - to ) OFERTY_BP_TERMINY. zawsze kalkulowana

  // dotyczy ofert z terminami
  
  $searchParams [ 'idTrip' ] = array() ;            // OFERTY_BP_TERMINY.ID_TERMINU
  $searchParams [ 'departureDateFrom' ] = '' ;      // OFERTY_BP_TERMINY.DATA_OD
  $searchParams [ 'departureDateTo' ] = '' ;        // OFERTY_BP_TERMINY.DATA_OD
  $searchParams [ 'returnDateFrom' ] = '' ;         // OFERTY_BP_TERMINY.DATA_DO
  $searchParams [ 'returnDateTo' ] = '' ;           // OFERTY_BP_TERMINY.DATA_DO
  $searchParams [ 'lengthDays' ] = array() ;        // ( from - to ) OFERTY_BP_TERMINY.ILOSC_DNI
  $searchParams [ 'lengthNights' ] = array() ;      // ( from - to ) OFERTY_BP_TERMINY.ILOSC_NOCLEGOW
  $searchParams [ 'participantAges' ] = array() ;   // na potrzeby kalkulacji cen całkowitych w kontekscie konkretnych dat oferty.
                                                    // Podajemy wiek uczestnika jaki będzie miał w ostatnim dniu imprezy !
                                                    // TODO: dorobić parametr [ 'participantBirthDates' ] jako alternatywa dla participantAges
  $searchParams [ 'departureFrom' ] = array() ;     // OFERTY_BP_TERMINY.WYJAZD_Z_ID_R2_PRZYSTANKI
  $searchParams [ 'departureFromCity' ] = array() ; // OFERTY_BP_TERMINY.WYJAZD_Z_ID_R2_PRZYSTANKI => R2_PRZYSTANKI.MIASTO

  // dotyczy przygotowania danych do odpowiedzi
  $searchParams [ 'sortBy' ] = '' ;                 // firstPersonPrice | totalPrice | departureDate | roomCode | roomDescription : domyślnie nie określony
  $searchParams [ 'sortOrder' ] = '';               // a | d : domyślnie jest 'a'
  $searchParams [ 'groupBy' ] = '' ;                // noGroup | offer | departureDate ( only for trips ) : domyślnie jest 'offer' 
  $searchParams [ 'resultsPageNumber' ] = '' ;      // first page index is = 1 ( in API 0 is converted to 1 )
  $searchParams [ 'resultsPerPage' ] = '' ;         //
  $searchParams [ 'currencyCode' ] = '' ;           // default PLN
  $searchParams [ 'languageCode' ] = '' ;           // default pl 
  $searchParams [ 'additionalData' ] = array(); // Szczegółowe dane dotyczące: 'dates': daty wyjazdów, powrotów i zakwaterowania