V adrese URL použitej na načítanie údajov zo systému ABRA Flexi je možné použiť mnoho parametrov, ktoré ovplyvňujú získané výsledky.

Stránkovanie

Takmer každý používateľ ABRA Flexi API bude skôr či neskôr potrebovať nejakým spôsobom stránkovať výsledky vrátené systémom. Napríklad len z toho dôvodu, že bez akejkoľvek inej špecifikácie ABRA Flexi vráti len prvých 20 výsledkov. Štandardne je stránka veľká 20 záznamov. Ak teda potrebujete zo systému získať viac stránok alebo dlhšiu stránku, musíte začať používať parametre.

Dôležité parametre sú:

limit

Tento parameter určuje, koľko záznamov bude na jednej stránke.
Ak potrebujete získať stránku so všetkými záznamami naraz, musíte tento parameter nastaviť na 0.

demo.flexibee.eu/c/demo/addressar.xml

Vráti prvých dvadsať záznamov zo záznamu adresára.

demo.flexibee.eu/c/demo/adresar.xml?limit=5

Vráti prvých päť záznamov zo záznamu adresára.

demo.flexibee.eu/c/demo/adresar.xml?limit=0

Vráti všetky záznamy z registra adresárov.

spustenie

Ak sa vyžaduje stránkovanie výsledkov, nestačí len limit. Musíte použiť aj parameter start, ktorý vám povie, od koľkých záznamov sa stránka začína.
Prvý záznam a predvolená hodnota je start=0.

demo.flexibee.eu/c/demo/adresar.xml?limit=5&start=0

Vráti stránku o veľkosti 5 záznamov zo záznamu adresára a začína prvým záznamom.

demo.flexibee.eu/c/demo/adresar.xml?limit=5&start=5

Vráti druhú stranu s 5 záznamami zo záznamu adresára. Druhá strana je určená parametrom start s hodnotou 5.

add-row-count

Ak stránkujete záznamy, je užitočné určiť, kedy sa má zastaviť. Preto je možné do adresy URL pridať aj parameter, ktorý do výstupu pridá celkový počet záznamov, ktoré sa majú zobraziť. Tento parameter sa nazýva add-row-count a nadobúda hodnoty true alebo false v závislosti od toho, či sa má celkový počet pridať alebo nie.

demo.flexibee.eu/c/demo/adresar.xml?limit=5&add-row-count=true

Vráti stránku s 5 záznamami zo záznamu adresára. Do prvku winstrom sa pridá atribút rowCount, ktorý obsahuje celkový počet záznamov.

demo.flexibee.eu/c/demo/addressar.json?limit=5&add-row-count=true

Rovnaký postup možno použiť aj na výstup JSON. Potom sa do výstupu pridá "@rowCount": "457".

Pre čo najrýchlejšiu odozvu systému Flexi odporúčame používať stránkovanie!

Ďalšou optimalizáciou môže byť odstránenie parametra add-row-count pri načítaní ďalších stránok. Je to preto, že nie je potrebné sa pýtať na každú stránku, aby sa zistilo, či sa tento počet zmenil. Okrem toho je získanie tohto čísla dodatočným dopytom do databázy v systéme ABRA Flexi a každý zbytočný dodatočný dopyt predstavuje zdržanie.

Úrovne podrobnosti

Ďalším veľmi dôležitým parametrom je detail. Tento parameter umožňuje ovplyvniť, aké vlastnosti jednotlivých záznamov daného záznamu budú prítomné vo výstupe. Ide však o veľmi rozsiahlu tému, preto sa jej v budúcnosti budeme venovať v samostatnom článku.
Dokumentácia ku každému detailu je k dispozícii na webovej stránke ABRA Flexi.

Triedenie

Vo väčšine prípadov je potrebné záznamy, ktoré ABRA Flexi vracia, triediť aj podľa niektorých vlastností. Prečo by sme mali triediť záznamy v našej aplikácii, keď to za vás môže urobiť ABRA Flexi?
Záznamy sú zoradené podľa parametra poradia. Hodnota tohto parametra je vlastnosť, podľa ktorej chcete triediť.

demo.flexibee.eu/c/demo/adresar.xml?order=code

Ak teda do adresy URL pridáte parameter order=code, systém vráti záznamy zoradené podľa vlastnosti Abbreviation. Záznamy budú zoradené vzostupne.

demo.flexibee.eu/c/demo/adresar.xml?order=code@D

Ak potrebujete zoradiť záznamy zostupne (užitočné napríklad na zoradenie podľa súm, faktúry s najvyššou hodnotou budú na začiatku), pridajte za názov vlastnosti @D

Triedenie podľa viacerých hodnôt sa vykonáva opakovaným použitím parametra order. Potom záleží aj na poradí, v akom sú parametre objednávky vložené do adresy URL.

demo.flexibee.eu/c/demo/adresar.xml?order=stat&order=code

Tento príklad vráti záznamy adresára zoradené najprv podľa štátu a ak je štát rovnaký, záznamy sa zoradia podľa skratky.

demo.flexibee.eu/c/demo/adresar.xml?order=code&order=stat

Dotaz s triedením najprv podľa skratky a potom podľa štátu samozrejme vráti odlišné výsledky.

Parameter objednávky je možné použiť aj priamo vo webovom rozhraní ABRA Flexi.

Iné

Systém ABRA Flexi umožňuje v adrese URL uvádzať mnoho ďalších parametrov. Ich úplný zoznam nájdete na stránke zostavenia adresy URL, preto spomenieme len tie najdôležitejšie a najpoužívanejšie.

Logické parametre s možnými hodnotami true / false možno aktivovať jednoduchým zadaním parametra (t. j. s prázdnou hodnotou). Napríklad ?no-ids=true možno skrátiť na ? no-ids.

only-ext-ids

Flexi vypisuje identifikátory pre každý objekt.
Ak sa použije tento parameter, na výstup sa dostanú len externé identifikátory objektov.

demo.flexibee.eu/c/demo/adresar.xml?only-ext-ids=true demo.flexibee.eu/c/demo/adresar.json?only-ext-ids=true

V tomto prípade teda interné identifikátory ABRA Flexi zmizli a vo výstupe sú len externé identifikátory záznamov, ktoré ich obsahujú.

no-ext-ids

Opakom predchádzajúceho parametra je parameter no-ext-ids. Ak sa použije tento parameter, vo výstupe nebudú žiadne externé identifikátory. Parameter no-ext-ids sa používa najmä na urýchlenie vyhľadávania údajov z ABRA Flexi. Každý pokus o načítanie externých identifikátorov spomaľuje výstup.

demo.flexibee.eu/c/demo/adresar.xml?no-ext-ids=true demo.flexibee.eu/c/demo/adresar.json?no-ext-ids=true

no-ids

Podobne ako predchádzajúci parameter, ale vo výstupe nebudú žiadne interné identifikátory ABRA Flexi. Takže napríklad externé identifikátory môžu zostať zobrazené.

Parameter no-ids=true ovplyvňuje export na všetkých úrovniach, t. j. aj položky dokumentu a vložené odkazy.

demo.flexibee.eu/c/demo/adresar.xml?no-ids=true demo.flexibee.eu/c/demo/adresar.json?no-ids=true

bez komentárov

Bol pridaný nový logický parameter no-comments na potlačenie komentárov vo výstupe XML.

demo.flexibee.eu/c/demo/adresar.xml?no-comments

mode=simple

Nový režim exportu"simple"(?mode=simple) generujúci minimalistický výstup bez atribútov ref a showAs a v prípade XML bez vysvetľujúcich komentárov.

demo.flexibee.eu/c/demo/adresar.xml?mode=simple

code-as-id

Tento parameter sa používa na výstup skratky ako identifikátora namiesto interných identifikátorov ABRA Flexi pre záznamy, ktoré ju podporujú.

demo.flexibee.eu/c/demo/adresar.xml?code-as-id=true demo.flexibee.eu/c/demo/adresar.json?code-as-id=true

Tento parameter možno použiť v kombinácii s no-ids na zabezpečenie prenosu údajov medzi spoločnosťami v systéme Flexi. Ak napríklad potrebujete preniesť adresár zo spoločnosti A do spoločnosti B, najlepšie je použiť export cez REST-API zo spoločnosti A a import do spoločnosti B. Adresa URL na získanie adresára by napríklad vyzerala takto:

demo.flexibee.eu/c/demo/adresar.xml?code-as-id=true&no-ids=true
Did this answer your question?