Skip to end of metadata
Go to start of metadata

Die REST-API ist über folgende Basis-URL zu erreichen:

UmgebungBasis-URL
Produktionhttp://www.nextcarwash.ch/api/rest
Nightly Buildhttp://beta.nextcarwash.ch/api/rest
Developmenthttp://localhost:8080/nextcarwash-beta/api/rest

Die REST-Schnittstelle folgt der HAL-Spezifikation. Die Schnittstelle kann über den HAL-Browser durchforstet werden:

Waschanlagen

URLVerbBeschreibung
/carwashGETGibt alle Anlagen zurück
/carwashPOSTFügt eine neue Anlage hinzu
/carwash/[carwashId]GETGibt eine bestimmte Anlage zurück
/carwash/[carwashId]PUTAktualisiert eine bestehende Anlage
/carwash/[carwashId]DELETELöscht eine bestimmte Anlage

Tags zu einer Anlage

Jede Waschanlage kann mehrere Tags haben. Diese beschreiben die angebotenen Dienstleistungen dieser Anlage.

URLVerbBeschreibung
/carwash/[carwashId]/tagsGETGibt alle Tags zu einer bestimmten Anlage zurück
/carwash/[carwashId]/tags/[tagId]POSTFügt ein Tag einer Anlage hinzu
/carwash/[carwashId]/tags/[tagId]DELETEEntfernt ein Tag von einer Anlage

Bewertungen

URLVerbBeschreibung
/rating/[carwashId]GETGibt die Bewertungen zu einer bestimmten Anlage zurück
/rating/[carwashId]/likePOSTPositive Bewertung für diese Anlage. Kein Body erforderlich
/rating/[carwashId]/dislikePOSTNegative Bewertung für diese Anlage. Kein Body erforderlich

Kommentare zu einer Anlage

Zu einer Anlage können Kommentare erfasst werden

URLVerbBeschreibung
/carwash/[carwashId]/commentsGETGibt alle Kommentare zu einer bestimmten Anlage zurück
/carwash/[carwashId]/comments/[commentId]GETGibt einen bestimmten Kommentar zurück
/carwash/[carwashId]/commentsPOSTFügt einen neuen Kommentar hinzu

Tags

Über diese Schnittstelle können die Tags an sich verwaltet werden.

URLVerbBeschreibung
/tagGETGibt alle Tags zurück
/tagPOSTFügt ein neues Tag hinzu
/tag/[tagId]GETGibt ein bestimmtes Tag zurück
/tag/[tagId]DELETELöscht ein bestimmtes Tag

Suche

URLVerbBeschreibung
 /search/location/area/[coord]GET 

Sucht alle Anlage in einem bestimmten geografischen Bereich. Der Bereich wird als Rechteck beschrieben.

Beispiel-Anfrage 

/search/location/radius/[coord]/[radius]GET

Sucht alle Anlage im Umkreis um einen bestimmten Punkt.

  • [coord]: Zentrum der Suche im Format latitude,longitude. Z.B. 7.441692352294922,46.943567817953515
  • [radius]: Radius der Suche in Metern.

Kundenfeedback

URLVerbBeschreibung
 /feedbackPOST 
Übermittelt ein Kundenfeedback
  • No labels