Úrovně detailu
Kvůli zvýšení rychlosti nejsou implicitně vraceny všechny údaje, které evidujeme. Úroveň detailnosti údajů lze řídit. Lze vybrat vždy jen jednu z úrovní.
Úroveň detailu je určena parametrem detail. Pro výpis seznamu záznamů je výchozí úroveň summary, pro detail záznamu je to full.
Ukázka:
https://api.tipmoto.com/c/12345/moto.xml?detail=full
| Kód | Název | Popis |
|---|---|---|
id |
Identifikátor | Jen primární klíč záznamu id, idApi a lastModified (popř. aktivni) |
summary |
Přehled | id + základní přehled, např. nazev |
full |
Plný detail | Přehled všech položek, které základní záznam obsahuje. |
custom:... |
Uživatelský detail | Pouze id a vyjmenované položky (viz níže).. |
Uživatelský detail
Uživatelská úroveň detailu umožňuje vybrat libovolné položky k zobrazení. Je vhodné, pokud chcete pouze některé údaje, ale summary neobsahuje to, co potřebujete, nebo je naopak rozsáhlejší.
Zápis v URL je speciální - po řetězci custom následuje dvojtečka a za ní čárkou oddělený seznam položek, které se mají vyexportovat. Např.:
http://api.tipmoto.com/c/12345/moto.xml?detail=custom:nazev,manufacturer
Vyexportují se pouze položky z úrovně id plus název a výrobce. Položka id se exportuje vždy, takže ji není třeba uvádět. Neznámé vlastnosti se ignorují.
