V této části článku si projdeme způsob tvorby URL adresy Flexi.
Struktura URL má následující podobu:
/c/<identifikátor firmy>/<evidence>/<ID záznamu>.<výstupní formát>
<identifikátor firmy>: jednoznačná identifikace firmy
<evidence>: typ evidence (adresář, objednávka, faktura, …); Seznam evidencí, do URL uvádějte hodnotu elementu <evidencePath>
<ID záznamu>: identifikátor záznamuseznam identifikátorů: Identifikátory záznamů
<výstupní formát>: výstupní formát (XML, JSON, …)
Příklady URL:
demo.flexibee.eu – adresa serveru, v tomto případě našeho cloudu (instance demo)
demo – identifikátor firmy (naleznete pro přihlášení do web. rozhraní v URL)
faktura-vydana – evidence vydaných faktur
15 – identifikátor záznamu (naleznete v XML agendy záznamů - element <id>, případně v aplikaci po přidání sloupce ID)
xml – formát dat
Tato URL adresa nám tedy zobrazí ve formátu XML vydanou fakturu s ID 15 ve firmě „demo“ na adrese demo.flexibee.eu.
https://localhost:5434/c/testovaci/faktura-vydana/15.xml
příklad URL adresy pro lokální instalaci
https://93.170.19.14:xxxx/c/testovaci/faktura-vydana/15.xml
příklad URL vlastního serveru, nastavení portu je na vašem správci sítě
Pro podrobnější informace o struktuře URL doporučujeme nastudovat naši dokumentaci: Sestavování URL
Pro každou evidenci je také možné získat seznam všech atributů, které evidence obsahuje.
Přehled atributů pro každou evidenci:
/c///properties
Využití mají jako atributy daného záznamu v XML/JSON requestu, např.:
KOD - záznam bude obsahovat kód/zkratku “KOD”
Vysvětlivky ke sloupcům v properties:
* - požadovaná položka (Vnitřní vazby mohou způsobit, že není nutné povinnou položku vyplňovat.)
rw - položka je zapisovatelná
ro - pouze pro čtení
1 - položka je součástí seznamu 'id'
2 - položka je součástí seznamu 'summary'
3 - položka je součástí seznamu 'full'
S - je možné dle položky řadit či filtrovat
Pro každou evidenci je možné si zobrazit seznam podporovaných tiskových sestav (reportů):
/c/<identifikátor firmy>/<evidence>/reports
Export do PDF konkrétního reportu:
/c/firma/faktura-vydana/1.pdf?report-name=dodaciList
exportuje do PDF tiskovou sestavu dodacího listu
Pokud máte vytvořené vlastní uživatelské reporty, je možné jej exportovat do PDF obdobně jako standardní reporty.
Export do PDF upraveného uživatelského reportu:
/c/firma/cenik/15.pdf?report-name=stitky
exportuje do PDF upravenou tiskovou sestavu se zkratkou “stitky”
Podrobnější informace o tom, jak si pomocí URL zobrazit PDF dané sestavy naleznete v naší dokumentaci: Export do PDF
Pomocí URL se záznamy dají také filtrovat:
/c/<identifikátor firmy>/<evidence>/(<filtr>)
Příklad:
vyfiltruje všechny faktury, u kterých kód začíná na 'FV'
Je samozřejmě možné využívat logické operátory (and, or, not):
Příklad č. 1:
vyfiltruje všechny faktury, u kterých kód začíná na ‘FV’ a končí na ‘P’
Příklad č. 2:
vyfiltruje všechna faktury, u kterých kód začíná na ‘FV’ nebo na ‘VF’
Pro podrobnější informace o filtrování záznamů doporučujeme nastudovat naši dokumentaci: Filtrování
Úroveň detailu
Kvůli zvýšení rychlosti nejsou standardně zobrazovány všechny údaje, které u záznamu evidujeme. Pomocí URL je tedy možné určovat úroveň detailu.
Úrovně detailu:
id - pouze idNapř.: https://demo.flexibee.eu/c/demo/faktura-vydana.xml?detail=id
summary - id, lastUpdate, kodNapř.: https://demo.flexibee.eu/c/demo/faktura-vydana.xml?detail=summary
full - všechny položky, které záznam obsahujeNapř.: https://demo.flexibee.eu/c/demo/faktura-vydana.xml?detail=full
custom - pouze vyjmenované položkyNapř.: https://demo.flexibee.eu/c/demo/faktura-vydana.xml?detail=custom:kod,nazev,firma,varSym,datVyst
Pro více informací o úrovních detailu doporučujeme nastudovat naši dokumentaci: Úrovně detailu
Stránkování
Kvůli zvýšení výkonu webových aplikací se běžně používá systém „stránkování“. Seznam je rozdělen na stránky, které jsou uživateli zobrazeny a on mezi nimi může přepínat.
Parametry stránkování:
limit - maximální počet záznamů, implicitně je 20
start - kolik záznamů přeskočit, není závislý na limitu
Příklad:
od 10. záznamu bude zobrazeno 25 záznamů (tedy 10.-35. záznam)
Pro další informace o parametrech stránkování prohlédněte naši dokumentaci: Stránkování
Přehled relací/podevidencí:
Pomocí URL lze také získat informace o záznamech v relacích - doplněním parametru ?relations na konec URL adresy.
Příklad:
vypíše všechny vazby k faktuře ID 15