Ak chcete získať prístup k údajom prostredníctvom rozhrania API REST spoločnosti Flexi, musíte poznať identifikátor spoločnosti. Zvyčajne sa zakladá na názve spoločnosti, pokiaľ sa názov nezmenil. Identifikátor je vždy jedinečný pre spoločnosť na danom serveri.
Povolené znaky v identifikátore sú malé písmená, číslice a podčiarkovník, ostatné znaky v názve spoločnosti sú nahradené podčiarkovníkom. Ak už existuje spoločnosť s rovnakým názvom, identifikátor sa doplní poradovým číslom. Ak teda zálohujete a obnovíte spoločnosť v tom istom zdroji údajov, dostane iný identifikátor. Identifikátor zostane nezmenený, ak spoločnosť premenujete. Ak vymažete a znovu vytvoríte spoločnosť, môže vzniknúť nová spoločnosť pod rovnakým identifikátorom.
Existujú dva spôsoby, ako získať identifikátor spoločnosti
1 ) Prihláste sa do webového rozhrania prostredníctvom webového prehliadača a ihneď v adresnom riadku webového prehliadača vyhľadajte identifikátor firmy, v tomto prípade je to identifikátor demo_unprofitable:
2) Pomocou rozhrania REST API a metódy HTTP GET si vyžiadajte adresu URL server:port/c.xml alebo https://demo.flexibee.eu:5434/c.xml?limit=0, prípadne JSON.
Dotazom na rozhranie REST API získame kompletný zoznam spoločností vo formáte XML/JSON. Do poľa dbName dostaneme identifikátor, do poľa name používateľsky čitateľný názov spoločnosti, ako ho vidíme v aplikácii. Ukážka výstupu:
<spoločnosti> <spoločnosť> <createDt>2020-03-05T12:51:18.757+01:00</createDt> <dbName>demo</dbName> <id>-2</id> <licenseGroup>39fa897328d1e6a55ab199f1410015d2</licenseGroup> <name>Demo company</name> <show>true</show> <statEnum>ESTABLISHED</statEnum> <watchingChanges>true</watchingChanges> </company> <company> <createDt>2012-09-10T13:24:49.765+02:00</createDt> <dbName>demo_de</dbName> <id>-2</id> <licenseGroup>39fa897328d1e6a55ab199f1410015d2</licenseGroup> <name>Me Sole Trader</name> <show>true</show> <statEnum>ESTABLISHED</statEnum> <watchingChanges>true</watchingChanges> </company></companies>
K dispozícii sú ďalšie polia, ako napríklad dátum vytvorenia (createDt), či je spoločnosť prístupná(show) a v akom stave sa nachádza(stateEnum): ESTABLISHING - založenie, ESTABLISHED - aktívne, MAINTENANCE - údržba, alebo či je povolenésledovanieZmien.