Um über die REST-API von Flexi auf Daten zuzugreifen, müssen Sie die Unternehmenskennung kennen. Diese basiert in der Regel auf dem Firmennamen, es sei denn, der Name wurde geändert. Die Kennung ist immer eindeutig für das Unternehmen auf diesem Server.
Erlaubte Zeichen in der Kennung sind Kleinbuchstaben, Zahlen und Unterstrich, andere Zeichen im Firmennamen werden durch den Unterstrich ersetzt. Gibt es bereits ein Unternehmen mit demselben Namen, wird die Kennung durch eine laufende Nummer ergänzt. Wenn Sie also das Unternehmen in derselben Datenquelle sichern und wiederherstellen, erhält es eine andere Kennung. Die Kennung bleibt unverändert, wenn Sie das Unternehmen umbenennen. Wenn Sie eine Firma löschen und neu anlegen, kann eine neue Firma unter der gleichen Kennung entstehen.
Es gibt zwei Möglichkeiten, ein Unternehmenskennzeichen zu erhalten
1) Loggen Sie sich über einen Webbrowser in die Weboberfläche ein und suchen Sie sofort in der Adressleiste des Webbrowsers die Firmenkennung, in diesem Fall ist die Kennung demo_unprofitable:
2) Fordern Sie mit der REST-API und der HTTP-GET-Methode die URL server:port/c.xml oder https://demo.flexibee.eu:5434/c.xml?limit=0 an , alternativ für JSON.
Durch Abfrage der REST-API erhalten wir die vollständige Liste der Unternehmen in XML/JSON. Im Feld dbName steht der Bezeichner, im Feld name der für den Benutzer lesbare Name des Unternehmens, wie er in der Anwendung zu sehen ist. Beispielhafte Ausgabe:
<Firmen> <Firma> <createDt>2020-03-05T12:51:18.757+01:00</createDt> <dbName>demo</dbName> <id>-2</id> <licenseGroup>39fa897328d1e6a55ab199f1410015d2</licenseGroup> <name>Demo Firma</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>
Es gibt zusätzliche Felder wie das Erstellungsdatum (createDt), ob die Gesellschaft zugänglich ist(show) und in welchem Zustand sie sich befindet(stateEnum): ESTABLISHING - Gründung, ESTABLISHED - aktiv, MAINTENANCE - Wartung, oder obwatchingChanges aktiviert ist.