Hotel.getGuests | Previo API

Hotel.getGuests

Vyhledávání hostů hotelu

Funkci vždy volejte s parametrem limit, pokud tento parametr nenastavíte bude Vám vráceno 100 záznamů. Pokud nastavíte limit větší než 100, bude vráceno 100 záznamů.

Parametry

Název Popis
login Přihlašovací jméno
password Heslo
hotId ID hotelu
filter Filtr výsledků
order Pořadí výsledků
limit Omezení počtu výsledků

filter

Příklad: Vyhledávání dle jména

<filter>
    <like>
        <field>name</field>
        <value>Petr%</value>
    </like>
</filter>

Další povolené hodnoty, dle kterých lze filtrovat:

  • fulltext - hledá ve jménu, emailu a adrese
  • name - jméno hosta
  • email - email hosta
  • country - stát hosta (zadává se ID státu dle číselníku System.getCountries)

Ukázkový požadavek

<request>
    <login>prihlasovaci_jmeno</login>
    <password>heslo</password>
    <order>
        <by>name</by>
        <desc>false</desc>
    </order>
    <limit>
        <offset>100</offset>
        <limit>100</limit>
    </limit>
</request>

 

Výstup

<guests> [1]  
 
<foundRows> [1] Počet hostů bez limit  
<guest> [0..*] Podrobné informace o hostech.  
  <gueId> [1] ID hosta
  <guaId> [1] ID kategorie hosta
  <guiId> [0..1] ID typu dokladu 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
  <sex> [0..1] Pohlaví hosta
  <identity> [0..1] Číslo dokladu
  <birthday> [0..1] Datum narození
  <address> [0..1] Adresa (DEPRECATED) - složena ze <street>, <streetNumber>, <zip>, <city>
  <street> [0..1] Ulice
  <streetNumber> [0..1] Číslo popisné
  <zip> [0..1] PSČ
  <city> [0..1] Město
  <phone> [0..1] Telefon
  <email> [0..1] Email
  <visa> [0..1] Číslo víza
  <numberplate> [0..1] SPZ
  <note> [0..1] Poznámka
  <couId> [0..1] ID země
  <newsletter> [0..1] Má povolen newsletter?

Ukázková odpověď

<guests>
    <foundRows>1356</foundRows>
    <guest>
    	<gueId>478</gueId>
        <guaId>160</guaId>
        <guiId>1</guiId>
        <name>Petr Klas</name>
        <firstName>Petr</firstName>
        <lastName>Klas</lastName>  
        <sex>m</sex>
    	<identity>866876</identity> 
        <birthday>1999-01-01</birthday>
        <email>petr@buchalcev.cz</email>
        <couId>507</couId>
    	<newsletter>1</newsletter> 
    </guest>
    <guest>
        <gueId>34528406</gueId>
        <guaId>14372</guaId>
        <guiId>1</guiId>
        <email>tomas.holy@previo.cz</email>
        <couId>1</couId>
    </guest>
</guests>