API-Dokumentation

Die Daten der Hochwassersensoren lassen sich über eine einfache API via HTTP GET Requests abfragen.

Sensorliste

Jeder Sensor hat eine eindeutige, immer gleich bleibende Nummerierung. Diese Nummer wird nachfolgend als Parameter in den Anfragen verwendet.

            1: Sensor Herdbrücke (48.396026, 9.995994)
            2: Sensor Eisenbahnbrücke Blau (48.403812, 9.949625)

Status

Ruft den aktuellen Hochwasserstand ab, mit Angabe der aktuellen Höhe des Wassers in mm auf dem Strassenbelag.

Request

            https://api.hochwasser.ttnulm.de/state/[id]

Response

            {
            "diff": 0,
            "flood": false
            }

Abstände

Ruft die Abstandswerte in Millimeter im genannten Interval ab.
Datumsformat: YYYY-MM-DD hh:mm:ss, die Zeit kann weggelassen werden.
Auf korrektes URL-Encoding achten.

Request

        https://api.hochwasser.ttnulm.de/distance/[id]?from=2019-07-01&to=2019-07-04

Response

    
[
    {
        "distance": 3264,
        "time": "2019-07-03 23:24:41"
    },
    {
        "distance": 3266,
        "time": "2019-07-03 23:34:40"
    },
    {
        "distance": 3264,
        "time": "2019-07-03 23:44:38"
    },
    {
        "distance": 3264,
        "time": "2019-07-03 23:54:38"
    }
]