API: file_status
>> zurück zur Liste aller Schnittstellen
| Beschreibung | Abfragen des Status einer hochgeladenen Angebotsdatei |
|---|---|
| URL |
https://api.booklooker.de/2.0/file_status?token=REST_API_TOKEN
REST_API_TOKEN = Der von der Authentifizierung zurückgelieferte Token. |
| Methode | GET |
| Version | 2.0 |
Parameter
| Name | Beschreibung | Optional? | Default-Wert |
|---|---|---|---|
| filename | Name der hochgeladenen Datei.
Existieren mehrere hochgeladene Dateien mit diesem Namen, bezieht sich der zurückgegebene Wert auf die zuletzt hochgeladene Datei. |
Nein | – |
| showErrors | Der Rückgabewert ist eine Liste von Fehlern, die beim Import der Datei identifiziert wurden.
Mögliche Werte:
Achtung: Die Liste der Fehler kann nur für komplett verarbeitete Dateien abgefragt werden! |
Nein | 0 |
Rückgabe
| Status | Rückgabewert | Beschreibung | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| OK | FILE_RECEIVED | Die Datei wurde vollständig hochgeladen, aber noch nicht verarbeitet. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OK | UPLOAD_IN_PROGRESS | Die Datei befindet sich aktuell in Verarbeitung. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OK | UPLOAD_DONE | Die Datei komplett verarbeitet. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OK |
Sofern der Parameter
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| NOK | INVALID_PARAMETERS | Der Parameter filenameist leer oder nicht vorhanden. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| NOK | FILE_NOT_FOUND | Die Datei wurde nicht gefunden. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| NOK | UPLOAD_FAILED | Datei konnte nicht eingelesen werden (es wurde kein gültiger Datensatz gefunden). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||