Diese Schnittstelle dient dazu, dass verbundene Einsatz-Führungs-Software (EFS, z.B. Ruatti.Commander) Einsatz-, Personal- und Materialdaten aus Ihrem HiOrg-Server abrufen können.

Zunächst muss einmalig (bzw. einmal pro EFS-Instanz) eine Verbindung zwischen den beiden Systemen hergestellt werden. Dann können folgende Daten automatisiert ausgetauscht werden:

1. Szenario 1: Sie haben einen Einsatz bereits im Vorfeld im HiOrg-Server geplant. Dazu haben Sie die Grunddaten des Einsatzes (Datum, Titel, Ort) im HiOrg-Server eingetragen, und bereits Personal und/oder Material zu diesem Einsatz geplant. Diese Daten können von der EFS abgerufen, und direkt zur weiteren Nutzung übernommen werden.
2. Szenario 2: Sie benötigen während eines Einsatzes zusätzliches Material. Über eine Suchmaske in der EFS können Sie die verbundenen HiOrg-Server danach abfragen.
3. Szenario 3 (in Planung): Sie benötigen während eines Einsatzes zusätzliches Personal, evtl. mit spezialisierter Ausbildung/Fähigkeiten. Über eine Suchmaske in der EFS können Sie die verbundenen HiOrg-Server danach abfragen.
4. Szenario 4 (in Planung): Nach Einsatzende können die von Ihrem Personal geleisteten Helferstunden direkt aus der EFS in den HiOrg-Server übernommen und dort gespeichert werden.

1. Gehen Sie in Ihrem HiOrg-Server zu „System - Einstellungen - API-Keys verwalten“.
2. Klicken Sie auf das [+] rechts oben, um einen neuen API-Key zu erstellen. Zu diesem können Sie eine Bemerkung eintragen, um später verschiedene vergebene Keys unterscheiden zu können:
   

1. Kopieren Sie den erzeugten Key, und tragen diesen in der EFS ein.

• Ruatti.Commander
• BOSassistant

Damit die Daten (Grunddaten, geplantes Personal und Material) eines Einsatzes für diese Schnittstelle übertragen werden können, müssen Sie zunächst bei dem betroffenen Einsatz das Häkchen setzen: „zum Abruf durch verbundene EFS freigeben“.

Dann können Sie in der EFS den Import der Einsatzdaten starten.

Wenn Sie selbst eine EFS entwickeln, können Sie hier die API-Beschreibung dieser Schnittstelle einsehen: efs-api_2.0.pdf

Für die Nutzung dieser API in PHP wurde von Andreas Müller eine komplette PHP-Bibliothek erstellt und unter MIT-Lizenz freigegeben - danke!