Der Bereich ARCHIVE der Middleware API (swagger) wird verwendet, um Daten an das RetailForce Secure Archive zu übermitteln (bzw. herunterladen), ohne die Fiskalisierung zu nutzen.
Die Verwendung der Funktionen / Endpunkte in diesem Bereich ist nur notwendig, wenn die Fiskalisierung über die RetailForce Middleware deaktiviert, also NICHT verwendet wird.
Für die Daten-Archivierung im Rahmen der Fiskalisierung ist lediglich eine entsprechende Lizenz notwendig (Zuweisung über Konfiguration).
Der Endpunkt
- POST /api/v1/archive/de/{clientId}
wird verwendet, um Daten an das Cloud Archiv der RetailForce zu übertragen.
Ergebnis
Bei einem erfolgreichen Aufruf des Endpunktes (200), wurden die entsprechenden Daten erfolgreich an das Secure Archive übermittelt.
Verwendung
Jedes Mal, wenn Daten zur Sicherung an das Archiv übertragen werden sollen.
Voraussetzungen
- RetailForce (Fiscal) Middleware installiert und
- Client initialisiert.
Request
Formularfelder
Folgende Parameter müssen müssen übermittelt werden:
Bezeichnung | Beschreibung | Beispiele |
clientId |
Die uniqueClientId der Registrierkasse (aus RetailForce System) |
c1062c55-57c4-4ed2-9c53-aff1762326a4 |
Request body
Daten, welche an das Archiv übermittelt werden sollen, müssen entsprechend spezifiziert werden. Dies erfolgt über die nachfolgend beschriebene Payload im Request.
Beispiel:
[
{
"type": 0,
"container": "string",
"entity": "string",
"recursive": true
}
]
Informationen in der Spalte "Typ":
- M ... erforderlich ("mandatory)
- M* ... erforderlich unter bestimmten Voraussetzungen
- R ... empfohlen ("recommended")
- O ... optional
Element | Typ | Beschreibung |
type | M |
Definition des Daten-Typs, der an das Archiv übertragen werden soll. Typen: 0 ... DSFinV-K (JSON) 1 ... DSFinV-K (CSV) 2 ... Backup-Daten (TAR-Daten, sonstige) Hinweis: Die Dateigrößen sind wie folgt beschränkt:
|
container | M* |
Der Name (Bezeichnung) des Containers (.zip-Datei) Hinweis: NUR bei Type = 2 ("type": 2,)
|
entity | M* | Daten, welche an das Archiv übermittelt werden sollen (Datei oder Ordner!). |
recursive | M* |
true (wahr) wenn auch Unterordner übermittelt werden sollen, ansonsten false (falsch). Nicht anwendbar, wenn die Entity KEIN Ordner ist! Hinweis: NUR bei Type = 2 ("type": 2,)
|
Antwort
Mögliche Antworten:
Code | Beschreibung | Beispiel |
200 |
Daten wurde erfolgreiche übermittelt |
- |
Kommentare
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.