POST /api/v1/archive/de/{clientId} – RetailForce

Området ARCHIVE i Middleware api (swagger) bruges til at overføre (og downloade) data til RetailForce Secure Archive uden brug af fiskalisering.

Brug af funktionerne/endpoints i dette område er kun nødvendigt, hvis fiskalisering er deaktiveret via RetailForce Middleware, dvs. IKKE anvendes.

Til dataarkivering inden for rammerne af fiscalisation kræves der kun en tilsvarende licens (tildeling via konfiguration). Uploading af fiscal-data til Cloud-arkivet håndteres derefter automatisk af fiscal-middlewaren.

Følgende

POST /api/v1/archive/de/{clientId}

-endpointet bruges til at overføre data til RetailForce Cloud-arkivet.

Resultat

Et vellykket opkald til endpointet (200) overførte de relevante data til det sikre arkiv.

Anvendelse

Hver gang data skal overføres til arkivet med henblik på sikkerhedskopiering.

Forudsætninger

RetailForce Middleware skal være installeret, og
clienten skal være initialiseret,

Anmodning

Formularfelter

Følgende parametre skal indsendes:

Betegnelse	Beskrivelse	Eksempel
clientId	Kasseapparatets uniqueClientId (fra RetailForce systemet).	c1062c55-57c4-4ed2-9c53-aff1762326a4

Request body

Data, der skal overføres til arkivet, skal angives i overensstemmelse hermed. Dette gøres via payloaden, der er beskrevet nedenfor i anmodningen.

Eksempel:

[
  {
    "type": 0,
    "container": "string",
    "entity": "string",
    "recursive": true
  }
]

Oplysninger i kolonnen "Type":

M ... obligatorisk / påkrævet
M* ... obligatorisk / påkrævet i visse lande eller under visse betingelser
R ... anbefalet
O... valgfrit

Elementer	Type	Beskrivelse
type	M	Definition af den datatype, der skal overføres til arkivet. Typer: 0 ... DSFinV-K (JSON) 1 ... DSFinV-K (CSV) 2 ... Sikkerhedskopieringsdata (diverse) Bemærk: Filstørrelserne er begrænset som følger: Type 0: 200 kB Type 1: 200 kB Type 2: 10 MB
container	M*	Navnet (betegnelsen) på containeren (.zip-fil) Bemærk: KUN hvis Type = 2 ("type": 2,)
enhed	M*	Data, der skal overføres til arkivet (fil eller mappe!).
rekursiv	M*	true, hvis undermapper også skal overføres, ellers false. Gælder ikke, hvis enheden IKKE er en mappe! Bemærk: KUN hvis Type = 2 ("type": 2,)

Svar

Mulige svar:

Kode	Beskrivelse	Eksempel
200	Data blev overført uden problemer	-

Denne artikel er oversat automatisk.