Schnittstellen Externe Systeme

Änderungshistorie

6.12.2014 / Version 1.0

  • Dokumente gesplittet und Interfacereihenfolge überarbeitet

12.03.2015 / Version 1.5

  • Schnittstelle zur Prüfung der Starterlaubnis ergänzt

  • (Angleichung des Versionsstandes)

Meldesysteme

Starterlaubnis abfragen

Aufruf

  • HTTP-Verb: GET

  • HTTP Header: User + Passwort (Basic Authentication)

  • HTTP Header: User-Agent (Software inkl. Version + Kennschlüssel)

  • URL-Parameter: Turnier-ID

  • URL-Parameter: Starter-ID

GET /api/v1/starterlaubnis/{turnierId}/{starterId} HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
User-Agent: Software/1.0; Token=abcdefghijklmnopqrstuvwxyz

Rückgabe

Erlaubnisstatus true oder false (JSON) mit HTTP-Ergebniscode

Meldeeingang schreiben

Aufruf

  • HTTP-Verb: POST

  • HTTP Header: User + Passwort (Basic Authentication)

  • HTTP Header: User-Agent (Software inkl. Version + Kennschlüssel)

  • URL-Parameter: Turnier-ID

  • URL-Parameter: Starter-ID

  • URL-Parameter: Meldung/Abmeldung als true/false

POST /api/v1/meldung/{turnierId}/{starterId}/{meldungAbmeldung} HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
User-Agent: Software/1.0; Token=abcdefghijklmnopqrstuvwxyz

Rückgabe

nur HTTP-Ergebniscode

Bestätigungsstatus lesend

Aufruf

  • HTTP-Verb: GET

  • HTTP Header: User + Passwort (Basic Authentication)

  • HTTP Header: User-Agent (Software inkl. Version + Kennschlüssel)

  • URL-Parameter: Turnier-ID

  • URL-Parameter: Starter-ID

GET /api/v1/bestaetigung/{turnierId}/{starterId} HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
User-Agent: Software/1.0; Token=abcdefghijklmnopqrstuvwxyz

Rückgabe

Mit HTTP-Ergebniscode für offen, bestätigt oder abgelehnt: Bestätigungsstatus true (bestätigt), false (abgelehnt) oder NULL (offen) (JSON)

Vereinswebseiten

Ergebnisse der Tänzer für Club-CMS aufbereitet

Rückblickend für begrenzten Zeitraum (z.B. vergangenes Wochenende)

Anfrage: Datum, Zeitraum, Club

Ergebnis:

Array aller Ergebnisse der letzten Woche (falls Zeitraum leer)

StarterID, TurnierID, Platz, Punkte