Hotel.searchReservations | Previo API

Hotel.searchReservations

Vrátí všechny rezervace a seznam aktuálně ubytovaných hostů pro daný hotel v požadovaném termínu, případně konkrétní rezervace.

Pokud nastavujete parametr "fulltext", tak funkci vždy volejte s parametrem limit, pokud tento parametr nenastavíte nebo bude větší než 300, bude Vám vráceno 300 záznamů.

Parametry

Název Popis
login Přihlašovací jméno
password Heslo
hotId Id hotelu
term Termín
comIds Identifikátory rezervací
fulltext Hledat rezervace dle textu - funkce hledá ve jménu, e-mailu, telefonu hosta, čísla voucheru a ve jménu a e-mailu firmy
statuses Seznam stavů rezervací, ve kterých se má hledat, pokud vynechán hledá se ve stavech - ubytován, potvrzeno, ukončeno, opce, jiné
limit Omezení počtu výsledků - bere se v potaz pouze pokud je nastaven parametr "fulltext" (pokud není zadáno nebo je větší než 300 vrací prvních 300 výsledků)
resId Id rezervace

term

Vrátí rezervace v daném rozsahu datumů.

Při použití tohoto parametru, funkce vypíše pouze rezervace, které jsou viditelné na plachtě. (např: opce, potvrzeno atd..)

Datumy uvádějte ve formátu W3 date. Např. 2010-04-29.

<term> [1]  
 
<from> [1] Datum od
<to> [1] Datum do
<termType> [0..1]

Typ termínu podle kterého se má hledat - povolené hodnoty:

  • created (hledá v datumu vytvoření)
  • check-in (hledá v datumu příjezdu)
  • check-out (hledá v datumu odjezdu)
  • overlap (hledá rezervace překrývající hledaný termín)
  • modified (hledá v datumu poslední změny rezervace)

Pokud je element vynechán, použije se overlap

comIds

Vrátí rezervace s danými identifikátory rezervací.

Pokud je hodnota zadána, funkce ignoruje zadané datum. Funkce vypisuje i rezervace, které nemusí být vidět na plachtě. (např: waiting list atd..)

<comIds> [0..1]  
 
<comId> [1..*] Identifikátor rezervace

statuses

Pokud je zadán element statuses, funkce hledá pouze v rezervacích, které mají příslušný stav rezervace.

<statuses> [0..1]  
 
<cosId> [1..*] Identifikátor stavu rezervace

Ukázkový požadavek

<request>
	<login>prihlasovaci_jmeno</login>
	<password>heslo</password>
	<hotId>745896</hotId>
	<term>
	    <from>2010-01-01</from>
	    <to>2010-12-31</to>
	</term>
	<comIds>
	    <comId>55565445</comId>
	</comIds>
    <fulltext>John Doe</fulltext>
    <statuses>
      <cosId>2</cosId>
      <cosId>3</cosId>  
    </statuses> 
    <limit>
        <offset>100</offset>
        <limit>200</limit>
    </limit>
</request>

Výstup

Kořenový element - reservationss

<reservations> [1]  
 
<reservation> [0..*] Reprezentuje jednu rezervaci

Rezervace - reservation

<reservation> [0..*] Pokud hotel nemá v zadaném termínu žádné rezervace, nevrátí nic.
 
<comId> [1] Id rezervace.
<resId> [1] Identifikátor případné skupinové rezervace
<voucher> [1] Číslo voucheru (string)
<term> [1] Termín rezervace.
 
<from> [0..1] Datum od
<to> [0..1] Datum do
<created> [1] Datum vytvoření rezervace
<cancellationDate> [0..1] Datum stornování rezervace (v případě, že je rezervace stornovaná)
<status> [1]  
 
<statusId> [1] Stav rezervace
<optionExpiration> [0..1] Vypršení opce
<price> [1] Celková cena
<cpsId> [0..1] Uhrazenost rezervace (uvedeno pouze pokud se hotel řídí stavem uhrazenosti nikoliv saldem hotelového účtu) - 1 - uhrazeno, 2 - neuhrazeno, 3 - částečně uhrazeno
<currency> [1] Měna
 
<curId> [1] Id měny
<code> [1] Kód měny
<guest> [0..*] Host, jenž patří do rezervace.
 
<gueId> [1] Id hosta
<name> [0..1] Jméno hosta (DEPRECATED) - složeno z <firstName>, <lastName>
<firstName> [0..1] Jméno hosta
<lastName> [0..1] Příjmení hosta
<phone> [0..1] Telefonní číslo hosta.
<email> [0..1] Email hosta.
<address> [0..1] Adresa hosta  (DEPRECATED) - složena ze <street>, <streetNumber>, <zip>, <city>
<street> [0..1] Ulice hosta
<streetNumber> [0..1] Číslo popisné host
<zip> [0..1] PSČ hosta
<city> [0..1] Město hosta
<countryCode> [0..1] ISO kód země původu návštěvníka (přednastavena CZE)
<isRecreation> [T/F]  
<guestCategory> [1]  
 
<guaId> [1] ID kategorie hosta
<name> [1] Název kategorie vyplněné v previu
<localVisitorTax> [1] Zda daná kategorie platí rekreační poplatky
<discount> [0..1] Případná sleva pro kategorii
<birthDate> [1] Datum narození
<gender> [0..1] Pohlaví (m = muž, f = žena)
<visa> [0..1] Číslo víza
<numberPlate> [0..1] SPZ
<identity> [0..1]  
 
<idNumber> [1] Číslo OP / Číslo pasu / Číslo ŘP / Číslo trvalého pobytu
<guiId> [1] Typ dokladu (1 - občanský průkaz, 2 - cestovní pas, 3 - řidičský průkaz, 4 - trvalý pobyt)
<company> [0..1] Firma
 
<parId>[1] ID firmy
<name> [1] Jméno
<address> [0..1] Adresa
<ic> [0..1] IC firmy
<dic> [0..1] DIC firmy
<contactPersonName> [0..1] Jméno kontaktní osoby
<contactPersonPhone> [0..1] Telefón kontaktní osoby
<contactPersonEmail> [0..1] Email kontaktní osoby
<object> [1] Pokoj, na který se tato rezervace vztahuje.
 
<objId> [1] Id pokoje
<name> [0..1] Název pokoje
<contactPerson> [0..1] Informace o osobě, která rezervaci objednávala (nemusí být totožná se jménem hosta)
 
<name> [0..1] Jméno
<phone> [0..1] Telefon
<email> [0..1] Email
<objectKind> [1] Druh pokoje, na který se tato rezervace vztahuje.
 
<obkId> [1] Id druhu pokoje
<name> [1] Název druhu pokoje
<note> [0..1] Poznámka
<gNote> [0..1] Poznámka skupinové rezervace
<partner> [0..1] Název partnera
 
<prpId> [1] Id partnera
<name> [1] Název partnera

Ukázková odpověď

<reservations>
    <reservation>
        <resId>1</resId>
        <comId>1</comId>
        <term>
            <from>2010-01-01 14:00:00</from>
            <to>2010-01-10 10:00:00</to>
        </term>
        <currency>
            <curId>1</curId>
            <code>CZK</code>
        </currency>
        <price>2569</price>
        <guest>
            <gueId>1</gueId>
            <firstName>Jan</firstName>
            <lastName>Novák</lastName >
            <phone>+0420111111111</phone>
            <email>jiri@novak.tm</email>
            <address>Nováka 4</address>
        </guest>
        <object>
            <objId>1</objId>
            <name>101 - S</name>
        </object>
        <objectKind>
            <obkId>1</obkId>
            <name>Single Room</name>
        </objectKind>
    </reservation>
    <reservation>
        <resId>1</resId> 
        <comId>2</comId>
        <term>
            <from>2010-05-10 14:00:00</from>
            <to>2010-05-14 10:00:00</to>
        </term>
        <currency>
            <curId>1</curId>
            <code>CZK</code>
        </currency>
        <price>5879</price>
        <guest>
            <gueId>2</gueId>
            <firstName>Petra</firstName>
            <lastName>Nováková</lastName> 
        </guest>
        <guest>
            <gueId>2</gueId>
        </guest>
        <object>
            <objId>3</objId>
            <name>201</name>
        </object>
        <objectKind>
            <obkId>2</obkId>
            <name>Double Room</name>
        </objectKind>
    </reservation>
    <reservation>
        <resId>1</resId> 
        <comId>3</comId>
        <term>
            <from>2010-09-02 14:00:00</from>
            <to>2010-09-11 10:00:00</to>
        </term>
        <currency>
            <curId>1</curId>
            <code>CZK</code>
        </currency>
        <price>3657</price>
        <guest>
            <gueId>4</gueId>
            <firstName>Emil</firstName> 
            <lastName>Novák</lastName>
        </guest>
        <object>
            <objId>3</objId>
            <name>103 - S</name>
        </object>
        <objectKind>
            <obkId>1</obkId>
            <name>Single Room</name>
        </objectKind>
    </reservation>
    <reservation>
        <resId>1</resId> 
        <comId>6</comId>
        <term>
            <from>2010-10-02 14:00:00</from>
            <to>2010-10-07 10:00:00</to>
        </term>
        <currency>
            <curId>1</curId>
            <code>CZK</code>
        </currency>
        <price>1567</price>
        <guest>
            <gueId>6</gueId>
        </guest>
        <object>
            <objId>1</objId>
            <name>101 - S</name>
        </object>
        <objectKind>
            <obkId>1</obkId>
            <name>Single Room</name>
        </objectKind>
    </reservation>
</reservations>