API: order_rating
>> zurück zur Liste aller Schnittstellen
| Beschreibung | Gibt eine Bewertung (Anzahl der Sterne) und optional einen Kommentar für eine Bestellung ab. |
|---|---|
| URL |
https://api.booklooker.de/2.0/order_rating?token=REST_API_TOKEN
REST_API_TOKEN = Der von der Authentifizierung zurückgelieferte Token. |
| Methode | PUT |
| Version | 2.0 |
Parameter
| Name | Beschreibung | Optional? | Default-Wert |
|---|---|---|---|
| orderId | Interne booklooker orderIdder Bestellung, wird von der Schnittstelle order zurückgeliefert. |
Nein | – |
| rating | Anzahl der Sterne, mögliche Werte
|
Nein | – |
| comment | Kommentar zur Bewertung, bei negativen Bewertungen (1 oder 2 Sterne) verpflichtend (mindestens 15 Buchstaben). | Ja | – |
Rückgabe
| Status | Rückgabewert | Beschreibung |
|---|---|---|
| OK | SUCCESS | Die Bewertung wurde gespeichert. |
| NOK | INVALID_PARAMETERS | Einer der Parameter orderIdoder ratingist leer oder nicht vorhanden. Auch ein ungültiger Wert für ratingerzeugt diesen Fehler. |
| NOK | NOT_FOUND | Die orderIdwurde nicht gefunden. |
| NOK | RATING_INVALID | Eine bereits abgegebene Bewertung kann nur verbessert, nicht verschlechtert werden. |
| NOK | RATING_LOCKED | Die Bewertung für diese Bestellung ist gesperrt und kann nicht mehr geändert werden. |
| NOK | RATING_EXPIRED | Eine Bewertung muss innerhalb von 6 Monaten nach Bestelleingang erfolgen. |
| NOK | COMMENT_MANDATORY | Bei einer Bewertung von 1oder 2ist ein Kommentar von mindestens 15 Zeichen (ohne Sonderzeichen) erforderlich. |
| NOK | ENCODING_ERROR | Die Rückgabe enthält ungültige Zeichen. |
| NOK | INVALID_INTERFACE | Es wurde eine ungültige Schnittstelle verwendet. |
| NOK | INVALID_REQUEST_METHOD | Die Schnittstelle wurde mit einer ungültigen HTTP-Methode aufgerufen. |
| NOK | QUOTA_EXCEEDED | Die maximale Anzahl Abfragen/Minute wurde überschritten. |
| NOK | SERVER_DOWN | Aufgrund von Wartungsarbeiten ist die REST API momentan nicht verfügbar. |
| NOK | TEMPORARILY_BLOCKED | Der Zugang wurde vorübergehend gesperrt, bitte wenden Sie sich an unseren Kundensupport. |
| NOK | TOKEN_EXPIRED | Der Token ist nicht mehr gültig, eine erneute Authentifizierung ist notwendig. |
| NOK | TOKEN_MISSING | Der Token ist leer oder nicht vorhanden. |
| NOK | TOKEN_UNKNOWN | Der Token wurde nicht gefunden. |