Filtrování záznamů
Záznamy v API je možné filtrovat. Seznam podporovaných atributů a jejich hodnoty (dle typu) lze získat v dokumentace každé agendy.
Filtrování se provádí URL parametrem ?filter= .
Podporované operátory
| Operátor | Název | Popis | Ukázka |
|---|---|---|---|
= |
Rovnost | Element se rovná hodnotě | a = 1 |
!= nebo <> |
Nerovnost | Element se nerovná hodnotě | a!=1 |
< |
Menší | Menší než (je možné použít např. i s časem) | a < 1 |
<= |
Menší nebo rovno | Menší nebo rovno než (je možné použít např. i s časem) | a <= 1 |
> |
Větší | Větší než (je možné použít např. i s časem) | a > 1 |
>= |
Větší nebo rovno | Větší nebo rovno než (je možné použít např. i s časem) | a >= 1 |
like |
Obsahuje | like funguje jako operátor v MySQL, tj. je možné používat % a vyhodnocuje se tak diakritika |
a like 'inStr' |
begins |
Začíná na | Zda hodnota začíná na řetězec | a begins 'yzf' |
ends |
Končí na | Zda hodnota končí na řetězec | a ends 'r1' |
in [] |
Je prvkem výčtu | Výčet hodnot, kterých prvek nabývá | a in [1, 5, 'inStr'] |
not in [] |
Není prvkem výčtu | Výčet hodnot, kterých prvek nenabývá | a not in [1, 5, 'inStr'] |
Řetězení operátorů:
| Operátor | Název | Popis | Ukázka |
|---|---|---|---|
and |
Logický operátor and | Umožňuje kombinovat podmínky | a = 1 and b = 1 |
or |
Logický operátor or | Umožňuje kombinovat podmínky | a = 1 or b = 1 |
not |
Logický operátor not | negace podmínky | not a = 1 |
() |
Závorky | Nastavení priorit | (a = 1 or b = 1) and (c = 2) |
Operátory mají obvyklou prioritu, pokud si nejste jistí, použijte závorky.
Upozornění: Filtry musí být v URL správně zakódovány.
Zápis hodnot
Ve výrazech jako a = 1 lze zadat čísla, textové řetězce a datum+čas. Kromě toho lze použít funkce uvedené v tabulce výše.
Čísla mohou být celá i desetinná. Při zápisu je možné použít číslo, popř. číslo v apostrofech.
Textové řetězce uvádějte v apostrofech. Uvozovky nejsou podporovány.
Datum a čas se zadává ve tvaru: 'YYYY-MM-DD HH:MM:SS' nebo YYYYMMDDHHMMSS.
Upozornění: Výčtové hodnoty musí být použity v apostrofech, i když se jedná o čísla. Zjednodušeně doporučujeme použít apostrofy pro obalení všech hodnot.
Fulltextový filtr (hledání)
Možnosti vyhledávání (filtrování) dle fulltextu jsou popsány v referenci fulltextového vyhledávání.
Filtr v číselnících dle firmy
Agenda lists standardně vypisuje všechny číselníky z TipMoto.com
Na základě Vašeho zájmu přidáváme URL parametr ?c=IDfirmy , kdy použijete-li parametr c, tak po jeho doplnění jsou číselníky omezeny pouze na data, která aktuálně používá tato konkrétní firma.
Pokud obsahuje podstrukturu (např. značky), jsou při použití omezení na firmu data podstruktury rovněž omezena pouze na data, která firma aktuálně používá.
U čísleníků, které jsou použity napříč více agendami (manufacturer, model) lze ještě použít doplňující URL parametr ?cagenda=agenda , kdy se výpis omezí pouze na číselníky z dané agendy (např. ?c=ID&cagenda=moto nebo ?c=ID&cagenda=dily).
Pro použití filtru dle firmy je nutné přihlášení do API i pro čísleníky!
