Všechny sbírky
Dokumentace REST API
Práce s firmami
Identifikátor firmy (ID firmy) a seznam založených firem pomocí API
Identifikátor firmy (ID firmy) a seznam založených firem pomocí API

Jak naleznout identifikátor firmy a seznam založených firem?

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

Pro přístup k datům přes REST API Flexi je nutné znát identifikátor firmy. Ten obvykle vychází z názvu firmy, pokud nebyl název měněn. Identifikátor je vždy unikátní pro firmu na daném serveru.

Povolené znaky identifikátoru jsou malá písmena, číslice a podtržítko, ostatní znaky v názvu firmy jsou nahrazeny právě podtržítkem. Pokud již existuje firma se stejným názvem doplní se identifikátor o pořadové číslo. Pokud tedy firmu zálohujete a obnovíte ve stejném datovém zdroji, dostane jiný identifikátor. Identifikátor zůstává neměný, pokud firmu přejmenujete. Pokud firmu smažete a znovu vytvoříte, může být pod stejným identifikátorem nová firma.

Existují dvě možnosti, jak získat identifikátor firmy

1) Přihlásíme se do webového rozhraní přes internetový prohlížeč a identifikátor firmy zjistíme ihned v adresním řádku webového prohlížeče, v tomto případě je identifikátor demo_neziskova:

2) Pomocí REST API a HTTP metody GET požadavkem na URL server:port/c.xml nebo-li https://demo.flexibee.eu:5434/c.xml?limit=0, alternativně pro JSON.

Tímto dotazem do REST API, získáme kompletní seznam firem v XML/JSON. V poli dbNazev zjistíme identifikátor, v poli nazev uživatelsky čitelný název firmy, jak jej vidíme v aplikaci. Ukázka výstupu:

<companies>
<company>
<createDt>2020-03-05T12:51:18.757+01:00</createDt>
<dbNazev>demo</dbNazev>
<id>-2</id>
<licenseGroup>39fa897328d1e6a55ab199f1410015d2</licenseGroup>
<nazev>Demo firma</nazev>
<show>true</show>
<stavEnum>ESTABLISHED</stavEnum>
<watchingChanges>true</watchingChanges>
</company>
<company>
<createDt>2012-09-10T13:24:49.765+02:00</createDt>
<dbNazev>demo_de</dbNazev>
<id>-2</id>
<licenseGroup>39fa897328d1e6a55ab199f1410015d2</licenseGroup>
<nazev>Já Živnostník</nazev>
<show>true</show>
<stavEnum>ESTABLISHED</stavEnum>
<watchingChanges>true</watchingChanges>
</company>
</companies>

K dispozici jsou další pole jako datum vytvoření (createDt), zda je firma přístupná (show) a v jakém je stavu (stavEnum): ESTABLISHING - zakládání, ESTABLISHED - aktivní, MAINTENANCE - údržba, nebo zda je povoleno sledování změn (watchingChanges).

Dostali jste odpověď na svou otázku?