Frontend zum Backend Schnittstellen

← zurück zur Schnittstellenübersicht

Verantwortlicher: Kim Rinderknecht, Daniel Reichert

Allgemeiner Aufbau der Rückgabe

{
  "name": "", 
  "description": "", 
  "timestamp": "", 
  "status": "", 
  "data": Object|Object[]
}

Beispiel:

{
  "name": "/bars/{barId}", 
  "description": "Detailinformationen zu einer Bar", 
  "timestamp": "2014-12-02 15:00:00", 
  "status": "success", 
  "data": Object|Object[]
}

GET

Alle Bars in einem definierten Umkreis eines Standorts auslesen

Liefert unter Berücksichtigung des Wochentages Informationen zu Bars in einem definierten Umkreis eines Standorts um die Routenerstellung zu ermöglichen und alternative Bars anzeigen lassen zu können.

URL

/bars

Parameter

• latitude (Double): Latitude aus den Routenoptionen
• longitude (Double): Longitude aus den Routenoptionen
• radius (Double): Radius, in dem die relevanten Bars liegen
• weekday (Integer): Wochentag, an dem die Route stattfinden soll

Rückgabewert

(Bar[]): Die angeforderten Bars

Gespeicherte Route auslesen

Liefert ein Routenobjekt zurück um eine nicht lokal gespeicherte/geteilte Route aufzurufen.

URL

/routes/{hash}

• hash (String): Hashwert der gespeicherten Route

Parameter

Keine

Rückgabewert

(Route): Die angeforderte Route

Toprouten auslesen

Liefert ein Array aus Routenobjekten zurück, die als Toproute gekennzeichnet sind.

URL

/toproutes

Parameter

Keine

Rückgabewert

(Route[]): Die gespeicherten Toprouten

Gemeldete Bars anzeigen

Liefert alle Meldungen über falsche Informationen zurück, die aktuell in der Datenbank stehen.

URL

/bars/reports

Parameter

• admin (String): Admin User Name
• adminpw (String): Admin User Passwort

Rückgabewert

[
  {
    barId: "",
    description: ""
  }
]

POST

Route speichern

Alle notwendigen Informationen um geteilte Route zu speichern oder eine Top Route anlegen.

URL

/routes

Nutzdaten

(Route): zu speichernde Route

Rückgabewert

(String): Hashwert der gespeicherten Route

Fehler einer Bar melden

Falsche Happy Hour Zeiten oder andere gemeldete Fehler einer Bar ans Backend schicken.

URL

/bars/{barId}/reports

• barId: ID der Bar

Nutzdaten

(String): Beschreibung der Meldung

Rückgabewert

(Boolean): Ob das Melden erfolgreich war

Neue Happy Hour speichern

Eine neue Happy Hour einer Bar in die Datenbank schreiben.

URL

/bars/{barId}/hour

• barId: Hashwert der Bar

Nutzdaten

(HappyHour): Die HappyHour, die angelegt werden soll.

Parameter

• admin (String): Admin User Name
• adminpw (String): Admin User Passwort

Rückgabewert

(Boolean): Ob das Schreiben erfolgreich war

DELETE

Happy Hour löschen

Happy Hour einer Bar in der Datenbank löschen.

URL

/delHour/{hourId}

• hourId: ID der Happy-Hour

Parameter

• admin (String): Admin User Name
• adminpw (String): Admin User Passwort

Rückgabewert

(Boolean): Status des Löschens

Bestimmte Meldung löschen

Eine bestimmte Meldung zur einer Bar wird gelöscht.

URL

/report/{id}

• id: ID der Meldung

Parameter

• admin (String): Admin User Name
• adminpw (String): Admin User Passwort

Rückgabewert

(Boolean): Status des Löschens

Alle Meldungen einer Bar löschen

Alle Meldungen zu der Bar mit der übergebenen ID werden gelöscht.

URL

/bars/{barID}/report

• barId: ID der Bar

Parameter

• admin (String): Admin User Name
• adminpw (String): Admin User Passwort

Rückgabewert

(Boolean): Status des Löschens