Preskoči na glavno vsebino

Nastavenie firmy v REST API

Ako získať alebo upraviť nastavenia firmy cez REST API

Avtor: Petr Pech

Nastavenie firmy má vlastnú evidenciu /nastaveni, ktorú nájdete tu.

V aplikácii ho nájdete v sekcii Firma > Nastavenie.

Získanie nastavenia firmy cez API

Nastavenie firmy je dostupné v XML/JSON, základné informácie možno získať metódou GET:

Výstup XML vyzerá nasledovne:

?xml version="1.0" encoding="utf-8"?>
<winstrom version="1.0">
<!-- Nastavení -->
<nastaveni>
<!-- ID (celé číslo) - -->
<id>1</id>
<!-- Poslední změna (datum a čas) - -->
<lastUpdate>2020-12-08T15:49:29.868+01:00</lastUpdate>
<!-- Změny budou platné od data (datum) - -->
<platiOdData></platiOdData>
<!-- Jméno (řetězec) - max. délka: 255 -->
<nazFirmy>Demo firma</nazFirmy>
...
</nastaveni>
<nastaveni>
<id>2</id>
<nazFirmy>Demo firma s.r.o.</nazFirmy>
...
</nastaveni>
</winstrom>

Nastavenia sú uložené ako jednotlivé verzie podobne ako v desktopovej aplikácii:

Nastavenie je možné pomocou API aj zmeniť

Ak vytvárame nové nastavenie, platné od určitého dátumu, je potrebné uviesť pôvodné nastavenie, z ktorého má nové nastavenie vychádzať. Ostatné neuvedené informácie zostanú totožné ako v pôvodnom nastavení:

Nastavenie odošleme metódou POST alebo PUT:

Telo požiadavky:

<winstrom version="1.0"> 
<nastaveni>
<puvodniNastaveni>
<id>1</id>
</puvodniNastaveni>
<platiOdData>2021-12-29</platiOdData>
<uliceNazev>Přestěhovaná</uliceNazev>
<!-- Další vlastnosti "nastaveni", které chceme uložit. -->
...
</nastaveni>
</winstrom>

Nastavenie počiatočného nastavenia

Ak chceme vytvoriť tzv. počiatočné (prvé) nastavenie firmy pred už existujúcim počiatočným nastavením, je potrebné uviesť ďalšie vlastnosti:

  • prvniNastaveni - príznak, že vytvárame prvé nastavenie (hodnota true)

  • prvniNastaveniPlatiDoData - dátum, do ktorého má toto nastavenie platiť (bude automaticky nastavený už existujúcemu počiatočnému nastaveniu ako platiOdData)

Opäť využijeme metódu POST alebo PUT:

Telo požiadavky:

<winstrom version="1.0"> 
<nastaveni>
<puvodniNastaveni>
<id>1</id>
<prvniNastaveni>true</prvniNastaveni>
<prvniNastaveniPlatiDoData>2021-12-22</prvniNastaveniPlatiDoData>
</puvodniNastaveni>
<!-- Další vlastnosti "nastaveni", které chceme uložit. -->
</nastaveni>
</winstrom>
Ste s tem dobili odgovor na svoje vprašanje?