V tejto časti článku si prejdeme postup tvorby adresy URL Flexi.
Štruktúra adresy URL je nasledujúca:
/c/<identifikátor spoločnosti>/<záznam>/<ID záznamu>.<výstupný formát>
<identifikátor firmy>: jedinečná identifikácia firmy
<records>: typ záznamov (adresár, objednávka, faktúra, ...); Soznam záznamov, v URL uveďte hodnotu elementu <recordsPath>
<record id>: identifikátor záznamuIdentifikátory záznamu
.
<output format>: výstupný formát (XML, JSON, ...)
Príklady URL:
demo.flexibee.eu - adresa servera, v tomto prípade nášho cloudu (demo inštancia)
demo - identifikátor spoločnosti (nachádza sa v adrese URL na prihlásenie do webového rozhrania)
vydané faktúry - záznam vydaných faktúr
15 - identifikátor záznamu (nájdete ho v záznamoch agendy XML - element <id>, alebo v aplikácii po pridaní stĺpca ID)
xml - formát údajov
Táto adresa URL nám teda vo formáte XML zobrazí faktúru vystavenú s ID 15 v spoločnosti "demo" na adrese demo.flexibee.eu.
https://localhost:5434/c/testovaci/faktura-vydana/15.xml
príklad URL pre lokálnu inštaláciu
https://93.170.19.14:xxxx/c/testovaci/faktura-vydana/15.xml
príklad adresy URL pre vlastný server, nastavenie portu je na správcovi siete
Podrobnejšie informácie o štruktúre URL odporúčame preštudovať našu dokumentáciu:Tvorba URL
Pre každý záznam je možné získať aj zoznam všetkých atribútov, ktoré záznam obsahuje.
Súpis atribútov pre každý záznam:
/c//vlastnosti
Používajú sa ako atribúty daného záznamu v požiadavke XML/JSON, napr.:
KOD - záznam bude obsahovať kód/skratku "KOD"
Vysvetlenia pre stĺpce vo vlastnostiach:
* - povinná položka (kvôli interným odkazom nemusí byť potrebné vyplniť povinnú položku)
rw- položka je zapisovateľná
ro - len na čítanie
1 - položka je súčasťou 'id'
2 - položka je súčasťou "zhrnutia"
3 - položka je súčasťou zoznamu 'full'
S - možno triediť alebo filtrovať podľa položky
Pre každý záznam je možné zobraziť zoznam podporovaných tlačových zostáv:
/c/<identifikátor spoločnosti>/<záznamy>/správy
Exportovať do PDF konkrétnu správu:
/c/company/invoice-issued/1.pdf?report-name=dodaciList
exportuje tlačovú zostavu dodacieho listu do formátu PDF
Ak ste vytvorili vlastnú používateľskú správu, môžete ju exportovať do formátu PDF podobne ako štandardné správy.
Exportovanie prispôsobenej používateľskej správy do formátu PDF:
/c/company/pricing/15.pdf?report-name=stitky
exportuje do PDF prispôsobenú tlačovú zostavu so skratkou "stitky"
Podrobnejšie informácie o tom, ako zobraziť PDF danej správy pomocou adresy URL, nájdete v našej dokumentácii: Export do PDF
Záznamy môžete filtrovať aj pomocou adries URL:
/c/<identifikátor spoločnosti>/<záznamy>/(<filter>)
Príklad:
vyfiltruje všetky faktúry, ktorých kód začína na 'FV'
Je samozrejme možné použiť logické operátory (a, alebo, nie):
Príklad 1:
vyfiltruje všetky faktúry, ktorých kód začína na 'FV' a končí na 'P'
Príklad 2:
vyfiltruje všetky faktúry, ktorých kód začína na 'FV' alebo 'VF'
Podrobnejšie informácie o filtrovaní záznamov vám odporúčame preštudovať si našu dokumentáciu: Filtrovanie
Úroveň detailov
Vzhľadom na zvýšenie rýchlosti sa v predvolenom nastavení nezobrazujú všetky údaje, ktoré zaznamenávame pre záznam. Preto je možné určiť úroveň podrobnosti pomocou adresy URL.
Detailné úrovne:
id - iba idNapríklad: https://demo.flexibee.eu/c/demo/faktura-vydana.xml?detail=id
summary - id, lastUpdate, codeNapríklad: https://demo.flexibee.eu/c/demo/faktura-vydana.xml?detail=summary
full - všetky položky, ktoré záznam obsahujeNapríklad: https://demo.flexibee.eu/c/demo/faktura-vydana.xml?detail=full
vlastné - len uvedené položkyNapr.: https://demo.flexibee.eu/c/demo/faktura-vydana.xml?detail=custom:kod,nazev,firma,varSym,datVyst
Pre viac informácií o úrovniach detailov odporúčame preštudovať našu dokumentáciu: Úrovne detailov
Paginácia
Na zlepšenie výkonu webových aplikácií sa bežne používa systém stránkovania. Zoznam je rozdelený na stránky, ktoré sa používateľovi zobrazia a môže medzi nimi prepínať.
Parametre stránkovania:
limit - maximálny počet záznamov, predvolená hodnota je 20
start - koľko záznamov sa má preskočiť, nezávisí od limitu
Príklad:
25 záznamov sa zobrazí od 10. záznamu (t. j. 10.-35. záznam)
Podrobnejšie informácie o parametroch stránkovania nájdete v našej dokumentácii: Stránkovanie
Prehľad relácií/podaní:
Pomocou adries URL môžete tiež získať informácie o záznamoch v reláciách - pridaním parametra ?relations na koniec adresy URL.
Príklad:
uvádza všetky odkazy na faktúru ID 15