API
Aus TW-Sportsoft Wiki (Online-Dokumentation)
Inhaltsverzeichnis
Einleitung
Über die TW-Sportsoft API (Gateway-Schnittstelle) können externe Systeme angeschlossen werden.
Extern anfallende Daten z.B. aus dem Bereich Auswertung/Zeitnahme (Startartzeiten, Zielzeiten, Fahrzeiten, Strafzeiten, Meldungen etc.) müssen somit nicht manuell erfasst werden, sondern könnten automatisch über diese Schnittstelle in das System übertragen werden.
Voraussetzungen
- Es muss eine Installation des Veranstaltungssystems mit den Modulen „Online-Nennung“ und „Auswertung“ vorhanden sein.
- Alle Teilnehmer-Daten müssen mit Startnummern, Wertungsgruppen/Klassen und ggf. Prädikatszuordnungen angelegt sein.
- Das Gateway muss über den Systemparameter im Administrationsbereichs der Veranstaltung geöffnet werden.
- Die eindeutige Veranstaltungsid muss bekannt sein. Ersichtlich auf der Startseite (Cockpit) des Admin-Bereiches des Veranstaltungssystems.
Rechtzeitig vor der Veranstaltung sollten entsprechende Tests und eine Probe-Auswertung mit dem Veranstaltungssystem durchgeführt werden.
Technik
Die Daten müssen als POST-Daten mittels einem Request versendet werden. Beispiel – JavaScript <script> $(document).ready(function() { //Daten var data = { ACTION: 'WP_ZEIT_SPEICHERN', VERANSTALTUNG_ID: '123456789', WP_NR: '1', ART: 'FAHRZEIT', ZEIT: '320.6', STARTNUMMER: '5' }; //Request an Gateway senden $.ajax({ url: 'https://www.tw-sportsoft.de/GATEWAY/index.php', type: 'POST', data: data }); }); </script>
Request: Zeiten speichern
Über diese Funktion werden Zeiten oder Status-Kennzeichen an das System gesendet. Hinweis: Wird eine Zeit zu gleicher Veranstaltung, WP/Lauf-Nummer und Startnummer nochmals gesendet, so wird die vorherige Zeit automatisch überschrieben. Darüber können eventuelle Fehleingaben korrigiert werden.
Datenfeld | Standard-Wert | Beispiel-Wert(e) | Datentyp | Pflichtfeld | Beschreibung |
---|---|---|---|---|---|
ACTION | WP_ZEIT_SPEICHERN | WP_ZEIT_SPEICHERN | VARCHAR | ja | Angabe, welche Aktion ausgeführt wird |
VERANSTALTUNG_ID | 4711 | INTEGER | ja | Eindeutige Veranstaltungsid |