Nastavení firmy v REST API

Jak získat či upravit nastavení firmy přes REST API

Ota Rádl avatar
Autor: Ota Rádl
Aktualizováno před více než týdnem

Nastavení firmy má vlastní evidenci /nastaveni, kterou naleznete zde.

V aplikaci jej naleznete v sekci Firma > Nastavení.

Získání nastavení firmy přes API

Nastavení firmy je dostupné v XML/JSON, základní informace lze získat metodou GET:

GET https://demo.flexibee.eu/v2/c/demo/nastaveni.xml?detail=full

Výstup XML vypadá následovně:

?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>

Nastavení jsou uložena jako jednotlivé verze podobně jako v desktopové aplikaci:

Nastavení je možné pomocí API i změnit

Pokud vytváříme nové nastavení, platné od určitého data, je potřeba uvést původní nastavení, ze kterého má nové nastavení vycházet. Ostatní neuvedené informace zůstanou totožné jako v původním nastavení:

Nastavení odešleme metodou POST nebo PUT:

POST https://demo.flexibee.eu/v2/c/demo/nastaveni.xml

Tělo požadavku:

<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>

Nastavení počátečního nastavení

Chceme-li vytvořit tzv. počáteční (první) nastavení firmy před již existujícím počátečním nastavením, je potřeba uvést další vlastnosti:

  • prvniNastaveni - příznak, že vytváříme první nastavení (hodnota true)

  • prvniNastaveniPlatiDoData - datum, do kdy má toto nastavení platit (bude automaticky nastaven již existujícímu počátečnímu nastavení jako platiOdData)

Opět využijeme metodu POST nebo PUT:

POST https://demo.flexibee.eu/v2/c/demo/nastaveni.xml

Tělo požadavku:

<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>
Dostali jste odpověď na svou otázku?