Response-Format

Jede Abfrage hat folgendes Antwortformat:

{
    message: {
        type: string,
        content: string
    },
    data: object
}

Die API liefert immer ein JSON Format zurück wobei folgender HTTP-Header immer mitgesendet wird:

Content-type: application/json

Parameter-Beschreibung

message.type: Dieser Parameter enthält die Werte “success” bei erfolgreicher Abfrage oder “error” bei einem Fehler

message.content: Dieser Parameter enthält bei erfolgreicher Abfrage informationen was die Abfrage zurückliefert und im Fehler die beschreibung des Fehlers

Allgemeine Fehler

message.type = “error” / message.content = “invalid api key”

Der angegebene API Key ist nicht korrekt oder der API Key wird von einem Account verwendet, der gesperrt ist. Um einen API Key zu bekommen registrieren dich hier. Wenn dein Account nicht aktiviert ist, bestätige die von uns an deine Mailadresse geschriebene E-Mail oder nimm schreib uns eine Mail an hotline@wiennetz.at.

message.type = “error” / message.content = “no method”

Die URL führt keine API-Methode aus. Alle API-Methoden werden weiter in dieser Dokumentation beschrieben.