Dieser Endpunkt ermöglicht die Wiederherstellung eines Clients (Mandanten) in der RetailForce Middleware, mit Daten (inkl. Konfigurationsinformationen) aus der RetailForce Cloud.
Eine Wiederherstellung eines Clients kann etwa bei Wechsel der Registrierkassenhardware oder -defekten notwendig sein.
Die Funktion POST /api/v1/management/clients/recovery/restoreByCloud/Id ist im Wesentlichen identisch zu PUT /api/v1/management/clients/byCloud, allerdings kann Letzterer nur einmal bei der erstmaligen Inbetriebnahme eines Clients ausgeführt werden.
Ergebnis
Ein erfolgreicher Aufruf des Endpunktes (200):
- Stellt einen bereits vorhandenen Client in der Middleware wieder her und weist diesem die entsprechende uniqueClientId des Terminals aus der RetailForce Cloud zu.
- Lädt das Konfigurationsobjekt aus dem Cloud-System erneut herunter und konfiguriert den Client dementsprechend.
Verwendung
Dieser Endpunkt wird verwendet, wenn ein Client, der bereits einmal erstellt wurde und dessen ClientId bekannt ist, wiederhergestellt werden muss (etwa bei Wechsel der Hardware).
Voraussetzungen
- Der Client muss bereits einmal erstellt worden und die ClientId bekannt sein.
- Organisationsstruktur und Konfigurationsobjekt wurden in der RetailForce Cloud erstellt und entsprechend zugewiesen.
- Die `storeNumber` und die `terminalNumber` sind bekannt.
- Die `LicenseConsumerId` ist bekannt.
- Fiskal Middleware ist installiert.
Formularfelder
Die folgende Information muss übermittelt werden:
| Bezeichnung | Beschreibung | Beispiele |
| LicenseConsumerId |
Die ID der Organisation. |
ID: d92254ca-d0fe-XXXX-bc3c-XXXXXX |
| storeNumber |
Die Nummer der Filiale, in welcher sich die Kasse befindet. Muss mit den Informationen, welche in der RetailForce Cloud eingetragen wurden, übereinstimmen. Länderinformation:
|
|
| terminalNumber |
Kassennummer. Muss mit den Informationen, welche in der RetailForce Cloud eingetragen wurden, übereinstimmen. |
0010 |
| cloudApiKey | API Key um die Cloud-Kommunikation zu authentisieren | RFC_4a2abc... |
| cloudApiSecret |
API Secret zur Authentisierung der Cloud-Kommunikation |
ypts7u5OU... |
Antwort
Mögliche Antworten:
| Code | Beschreibung | Beispiel |
| 200 | Der Client wurde erfolgreich wiederhergestellt und konfiguriert. Als Response-Objekt wird die uniqueClientId des wiederhergestellten Clients zurückgegeben. Die uniqueClientId muss vom Kassensystem gespeichert und für den gesamten weiteren Kommunikations-Prozess (den Client betreffend) vom Kassensystem verwendet werden. | b7cf6d59-cec4-4cc2-a647-01XXXX |
| 406 |
Typ des angegebenen Unternehmenskennzeichens ist kein eindeutiger Typ. Fehlerbehandlung: Verwenden Sie einen der folgenden Unternehmenskennzeichen: [0] = VatNumber, |
- |
Kommentare
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.