doku/docs/API/02_public.md

hide

hide
footer

Public API

Folgende API Endpunkte stellen wir zur Verfügung:

Allgemeine Erklärungen

• Die öffentliche API befindet sich meistens unter https://api.<tennant>.regattatech.de, kann aber je nach Wunsch auch unter einer anderen Domain publiziert werden.

• "öffentliche API" meint in dem Zusammenhang, dass kein API Key benötigt wird. Es können jedoch IP Beschränkungen oder andere Sicherheitsvorkehrungen für bestimmte Endpunkte definiert sein.

• Die Endpunkte enden meistens mit einem /current/ dies spezifiziert die aktuellste Regatta. Sollte eine andere Regatta gewünscht werden, kann diese mit der laufenden Regatta ID anstelle von /current/ gewählt werden (zB /2/)

/api/v1/bootliste/current/

Aufbau

Gibt in einem strukturierten JSON folgende Informationen aus:

• Eindeutige Boot-ID
• Name des Bootes
• Ggf. ehemalige Namen des Bootes
• Ob das betreffende Boot ein Jugendboot ist
• Wer an der Trommel sitzt
• Wer "Auf Schlag" sitzt
• Woher das Team kommt
• Wie sich das Team definiert
• Bisherige Platzierungen
• Ob dies die erste Teilnahme ist
• Wie häufig schon teilgenommen wurde
• Ziele bei der Regatta
• Was das Team auszeichnet
• Schlachtruf des Teams
• Notizen zum Team
• Status des Teams (Veröffentlicht J/N)
• Pager ID des Teams
• Link zum Teambild

Die Infos in Kursiv werden ggf. nur bestimmten Endpunkten mitgeteilt und sind hauptsächlich für Internetpräsenzen und Moderation gedacht.

Verwendung

• Apps
• Moderation
• Webseiten

/api/v1/message

Aufbau

Gibt in einem strukturierten JSON folgende Informationen aus:

• Nachricht
• Wichtigkeit der Nachricht

Verwendung

• Apps
• Webseiten
• Moderation
• Push

/api/v1/rennplan/current/

Aufbau

Gibt in einem strukturierten JSON folgende Informationen aus:

• Rennplan nach Lauf und Rennen
• UUID des jeweiligen Rennens
• Teilnehmende Boote nach Bahn des jeweiligen Rennens
• Zeitpunkt des jeweiligen Rennens
• Name des jeweiligen Rennens
• Laufende Nummer des jeweiligen Rennens
• Art des jeweiligen Rennens

Verwendung

• Apps
• Webseiten
• Moderation

/api/v1/results/current/

Aufbau

Gibt in einem strukturierten JSON folgende Informationen aus:

• Ergebnisse nach Rennen
• UUID des jeweiligen Rennens
• Teilnehmende Boote nach Bahn des jeweiligen Rennens
• Gefahrene Zeit des Bootes nach Bahn & Rennen
• Zeitpunkt des jeweiligen Rennens
• Name des jeweiligen Rennens
• Laufende Nummer des jeweiligen Rennens
• Art des jeweiligen Rennens

Verwendung

• Apps
• Webseiten
• Moderation

Besonderheiten

In bestimmten Modi werden während des letzten Laufes keine Ergebnisse über diese API publiziert!