Aktionen

API: Unterschied zwischen den Versionen

Aus TW-Sportsoft Wiki (Online-Dokumentation)
Zeile 148: Zeile 148:
  
 
Über diese Funktion werden Meldungen an das System gesendet.  
 
Über diese Funktion werden Meldungen an das System gesendet.  
 +
 +
{| class="wikitable"
 +
|-
 +
! Datenfeld !! Standard-Wert!! Beispiel-Wert(e)!! Datentyp!! Pflichtfeld!! Beschreibung
 +
|-
 +
| ACTION|| LEITSTELLE_MELDUNG_SPEICHERN || LEITSTELLE_MELDUNG_SPEICHERN || VARCHAR|| ja|| Angabe, welche Aktion ausgeführt wird
 +
|-
 +
| VERANSTALTUNG_ID || ||4711 ||INTEGER || ja|| Eindeutige Veranstaltungsid
 +
|-
 +
| MELDUNGART_ID  || ||3||INTEGER || ja|| 1=Zeitstrafe 2=Unfall 3=Technischer Defekt 4=Information 5=Sonstiges
 +
|-
 +
| MELDUNG  || ||Motorschaden ||VARCHAR(250) || ja|| Beschreibung der Meldung
 +
|-
 +
| WP_NR || ||1||INTEGER|| nein|| Nummer der WP/Lauf
 +
|-
 +
| STARTNUMMER || ||15||INTEGER|| nein|| Startnummer des Teilnehmers
 +
|-
 +
| KZ_OEFFENTLICH || ||0||INTEGER|| ja|| Kennzeichen, ob die Meldung öffentlich angezeigt werden soll oder nur eine interne Information an die Leitstelle ist
 +
|-
 +
| MELDUNG_ID || ||12345||INTEGER|| nein|| Externe ID der gesendeten Meldung
 +
|}
  
  
 
=== Request: Meldungen löschen===
 
=== Request: Meldungen löschen===
 +
 +
Über diese Funktion werden Meldungen an das System gesendet. Um Meldungen löschen zu können muss eine eindeutige externe Meldungsid oder Startnummer mit WP-/Lauf-Nr. übergeben werden.
 +
 +
{| class="wikitable"
 +
|-
 +
! Datenfeld !! Standard-Wert!! Beispiel-Wert(e)!! Datentyp!! Pflichtfeld!! Beschreibung
 +
|-
 +
| ACTION|| LEITSTELLE_MELDUNG_LOESCHEN  || LEITSTELLE_MELDUNG_LOESCHEN  || VARCHAR|| ja|| Angabe, welche Aktion ausgeführt wird
 +
|-
 +
| VERANSTALTUNG_ID || ||4711 ||INTEGER || ja|| Eindeutige Veranstaltungsid
 +
|-
 +
| MELDUNGART_ID  || ||3||INTEGER || ja|| 1=Zeitstrafe 2=Unfall 3=Technischer Defekt 4=Information 5=Sonstiges
 +
|-
 +
| WP_NR || ||1||INTEGER|| ja/nein|| Nummer der Wertungsprüfung
 +
|-
 +
| STARTNUMMER || ||15||INTEGER|| ja/nein|| Startnummer des Teilnehmers 
 +
|-
 +
| MELDUNG_ID || ||12345||INTEGER|| ja/nein|| Externe ID der gesendeten Meldung
 +
|}
 +
 +
 
=== Request: Kennzeichen setzen===
 
=== Request: Kennzeichen setzen===
 +
 +
Über diese Funktion können entsprechende Kennzeichen der Teilnehmer gesetzt werden. Dabei werden die bestehenden Kennzeichen immer durch den aktuellen Wert überschrieben.
 +
 +
 +
{| class="wikitable"
 +
|-
 +
! Datenfeld !! Standard-Wert!! Beispiel-Wert(e)!! Datentyp!! Pflichtfeld!! Beschreibung
 +
|-
 +
| ACTION|| KENNZEICHEN_SETZEN  || KENNZEICHEN_SETZEN  || VARCHAR|| ja|| Angabe, welche Aktion ausgeführt wird
 +
|-
 +
| VERANSTALTUNG_ID || ||4711 ||INTEGER || ja|| Eindeutige Veranstaltungsid
 +
|-
 +
| KENNZEICHEN_ART  || ||KZ_DOKU_ABNAHME_ERLEDIGT KZ_TECHN_ABNAHME_ERLEDIGT KZ_STARTBERECHTIGT KZ_GESTARTET KZ_ZIELANKUNFT KZ_PARC_FERME KZ_AUSWERTUNG_STATUS ||VARCHAR|| ja|| Art des Kennzeichens, welches gesetzt werden soll
 +
|-
 +
| KENNZEICHEN_WERT  || ||1||INTEGER || || 1=Kennzeichen setzen 0=Kennzeichen entfernen Besonderheit bei KZ_AUSWERTUNG_STATUS:
 +
1= DNS 2= DNF 3=DNC 4=DIS
 +
|-
 +
| WP_NR || ||1||INTEGER|| ja/nein|| Nummer der Wertungsprüfung/Lauf, sofern Zuordnung möglich. Z.B. Ausfall nach WP2
 +
|-
 +
| STARTNUMMER || ||15||INTEGER|| ja/nein|| Startnummer des Teilnehmers 
 +
|}

Version vom 23. Januar 2020, 21:32 Uhr

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

  1. Es muss eine Installation des Veranstaltungssystems mit den Modulen „Online-Nennung“ und „Auswertung“ vorhanden sein.
  2. Alle Teilnehmer-Daten müssen mit Startnummern, Wertungsgruppen/Klassen und ggf. Prädikatszuordnungen angelegt sein.
  3. Das Gateway muss über den Systemparameter im Administrationsbereichs der Veranstaltung geöffnet werden.
  4. 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>

Gateway

Die Daten sind an folgende Gateway-URL (Systemherkunft TW-Sportsoft) zu senden: https://www.tw-sportsoft.de/GATEWAY/index.php

Die Daten sind an folgende Gateway-URL (Systemherkunft DMSB) zu senden: https://www.dmsb-sport.de/GATEWAY/index.php

Die Daten sind an folgende Gateway-URL (Systemherkunft ADAC Sportabteilung) zu senden: https://www.adac-sport.com/GATEWAY/index.php


Requests

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
WP_NR 1 INTEGER ja Nummer der WP/Lauf
LAP 1 INTEGER nein Rundenzahl
ART START, ZIEL, FAHRZEIT VARCHAR ja Art der gesendeten Zeit. Startzeit, Zielzeit oder Fahrzeit
STATUS Folgende Status-Werte können übermittelt werden. 1= DNS 2= DNF 3=DNC 4=DIS 2 INTEGER nein Eine ggf. gesendete Zeit wird dann ignoriert.
ZEIT 43591.862 DECIMAL(9,3) ja Die Zeit in Sekunden mit Nachkommastellen
STARTNUMMER 15 INTEGER ja Startnummer des Teilnehmers


Request: Zeiten löschen

Über diese Funktion können Zeiten aus dem System entfernt werden.

Datenfeld Standard-Wert Beispiel-Wert(e) Datentyp Pflichtfeld Beschreibung
ACTION WP_ZEIT_LOESCHEN WP_ZEIT_LOESCHEN VARCHAR ja Angabe, welche Aktion ausgeführt wird
VERANSTALTUNG_ID 4711 INTEGER ja Eindeutige Veranstaltungsid
WP_NR 1 INTEGER ja Nummer der WP/Lauf
ART START, ZIEL, FAHRZEIT VARCHAR ja Art der gesendeten Zeit. Startzeit, Zielzeit oder Fahrzeit
ZEIT 43591.862 DECIMAL(9,3) ja Die Zeit in Sekunden mit Nachkommastellen
STARTNUMMER 15 INTEGER ja Startnummer des Teilnehmers


Request: Strafzeiten speichern

Über diese Funktion werden Strafzeiten an das System gesendet. Hinweis: Wird eine Strafzeiten zu gleicher Veranstaltung, WP/Lauf-Nummer und Startnummer nochmals gesendet, so wird die vorherige automatisch überschrieben. Darüber können eventuelle Fehleingaben korrigiert werden.

Datenfeld Standard-Wert Beispiel-Wert(e) Datentyp Pflichtfeld Beschreibung
ACTION STRAFZEIT_SPEICHERN STRAFZEIT_SPEICHERN VARCHAR ja Angabe, welche Aktion ausgeführt wird
VERANSTALTUNG_ID 4711 INTEGER ja Eindeutige Veranstaltungsid
WP_NR 1 INTEGER ja Nummer der WP/Lauf
ZEIT 10.0 DECIMAL(6,3) ja Die Zeit in Sekunden mit Nachkommastellen
GRUND Frühstart VARCHAR(50) nein Grund für die Strafzeit
STARTNUMMER 15 INTEGER ja Startnummer des Teilnehmers


Request: Strafzeiten löschen

Über diese Funktion können Strafzeiten aus dem System entfernt werden.

Datenfeld Standard-Wert Beispiel-Wert(e) Datentyp Pflichtfeld Beschreibung
ACTION STRAFZEIT_LOESCHEN STRAFZEIT_LOESCHEN VARCHAR ja Angabe, welche Aktion ausgeführt wird
VERANSTALTUNG_ID 4711 INTEGER ja Eindeutige Veranstaltungsid
WP_NR 1 INTEGER ja Nummer der WP/Lauf
ZEIT 10.0 DECIMAL(6,3) ja Die Zeit in Sekunden mit Nachkommastellen
STARTNUMMER 15 INTEGER ja Startnummer des Teilnehmers

Request: Meldungen speichern

Über diese Funktion werden Meldungen an das System gesendet.

Datenfeld Standard-Wert Beispiel-Wert(e) Datentyp Pflichtfeld Beschreibung
ACTION LEITSTELLE_MELDUNG_SPEICHERN LEITSTELLE_MELDUNG_SPEICHERN VARCHAR ja Angabe, welche Aktion ausgeführt wird
VERANSTALTUNG_ID 4711 INTEGER ja Eindeutige Veranstaltungsid
MELDUNGART_ID 3 INTEGER ja 1=Zeitstrafe 2=Unfall 3=Technischer Defekt 4=Information 5=Sonstiges
MELDUNG Motorschaden VARCHAR(250) ja Beschreibung der Meldung
WP_NR 1 INTEGER nein Nummer der WP/Lauf
STARTNUMMER 15 INTEGER nein Startnummer des Teilnehmers
KZ_OEFFENTLICH 0 INTEGER ja Kennzeichen, ob die Meldung öffentlich angezeigt werden soll oder nur eine interne Information an die Leitstelle ist
MELDUNG_ID 12345 INTEGER nein Externe ID der gesendeten Meldung


Request: Meldungen löschen

Über diese Funktion werden Meldungen an das System gesendet. Um Meldungen löschen zu können muss eine eindeutige externe Meldungsid oder Startnummer mit WP-/Lauf-Nr. übergeben werden.

Datenfeld Standard-Wert Beispiel-Wert(e) Datentyp Pflichtfeld Beschreibung
ACTION LEITSTELLE_MELDUNG_LOESCHEN LEITSTELLE_MELDUNG_LOESCHEN VARCHAR ja Angabe, welche Aktion ausgeführt wird
VERANSTALTUNG_ID 4711 INTEGER ja Eindeutige Veranstaltungsid
MELDUNGART_ID 3 INTEGER ja 1=Zeitstrafe 2=Unfall 3=Technischer Defekt 4=Information 5=Sonstiges
WP_NR 1 INTEGER ja/nein Nummer der Wertungsprüfung
STARTNUMMER 15 INTEGER ja/nein Startnummer des Teilnehmers
MELDUNG_ID 12345 INTEGER ja/nein Externe ID der gesendeten Meldung


Request: Kennzeichen setzen

Über diese Funktion können entsprechende Kennzeichen der Teilnehmer gesetzt werden. Dabei werden die bestehenden Kennzeichen immer durch den aktuellen Wert überschrieben.


Datenfeld Standard-Wert Beispiel-Wert(e) Datentyp Pflichtfeld Beschreibung
ACTION KENNZEICHEN_SETZEN KENNZEICHEN_SETZEN VARCHAR ja Angabe, welche Aktion ausgeführt wird
VERANSTALTUNG_ID 4711 INTEGER ja Eindeutige Veranstaltungsid
KENNZEICHEN_ART KZ_DOKU_ABNAHME_ERLEDIGT KZ_TECHN_ABNAHME_ERLEDIGT KZ_STARTBERECHTIGT KZ_GESTARTET KZ_ZIELANKUNFT KZ_PARC_FERME KZ_AUSWERTUNG_STATUS VARCHAR ja Art des Kennzeichens, welches gesetzt werden soll
KENNZEICHEN_WERT 1 INTEGER 1=Kennzeichen setzen 0=Kennzeichen entfernen Besonderheit bei KZ_AUSWERTUNG_STATUS:

1= DNS 2= DNF 3=DNC 4=DIS

WP_NR 1 INTEGER ja/nein Nummer der Wertungsprüfung/Lauf, sofern Zuordnung möglich. Z.B. Ausfall nach WP2
STARTNUMMER 15 INTEGER ja/nein Startnummer des Teilnehmers
Abgerufen von „https://www.tw-sportsoft-wiki.de/index.php?title=API&oldid=414“