DELETE api/hit/{entity}?subcodes={subcodes}&bnr={bnr}&mbn={mbn}&pin={pin}&mandant={mandant}&tfaToken={tfaToken}&tfaLight={tfaLight}&act={act}&cid={cid}&cacheTimeout={cacheTimeout}&cacheSecret={cacheSecret}&meldeWeg={meldeWeg}&bhvWrongCol={bhvWrongCol}&bhvFillCol={bhvFillCol}&kompeV2={kompeV2}&deltaSub={deltaSub}

Verarbeite ein DELETE (=Stornieren) mit ein oder mehreren Meldungen.

Request Information

Parameters

NameDescriptionAdditional information
entity
HIT Meldung (Entity), die storniert werden soll

Define this parameter in the request URI.

values
JSON-Objekt für Einzelmeldung oder JSON-Array mit JSON-Objekten für mehrere

Define this parameter in the request body.

subcodes
HIT-Protokoll Befehlssubcodes zum jeweiligen Befehl wie z.B. S

Define this parameter in the request URI.

bnr
Anmelde-Betriebsnummer, muss immer angegeben werden!

Define this parameter in the request URI.

mbn
Anmelde-Mitbenutzerkennung

Define this parameter in the request URI.

pin
PIN für Anmeldung. Muss nur angegeben werden, wenn  leer

Define this parameter in the request URI.

mandant
i.d.R. leer; ist Mandanten-Betriebsnummer, wenn  als Bevollmächtigter für diesen arbeiten soll

Define this parameter in the request URI.

tfaToken
optional, i.d.R. leer. Wenn Nutzer sich mit zweitem Faktor (zusätzlich zu ) authentifizieren muss, dann ist hier das TOTP-Token aus dem Authenticator anzugeben

Define this parameter in the request URI.

tfaLight
optional, i.d.R. leer. Soll ein Login ohne zweiten Faktor probiert werden, obwohl ggf. einer erforderlich ist? 1=ja, 0=nein

Define this parameter in the request URI.

act
optional, i.d.R. leer. OAuth Access Token, falls OIDC verwendet wird, i.d.R. leer

Define this parameter in the request URI.

cid
optional, i.d.R. leer. OAuth Client ID, falls OIDC verwendet wird, i.d.R. leer

Define this parameter in the request URI.

cacheTimeout
Timeout (in Sekunden), positiver Wert = Sitzung mit ; keine Angabe = keine Sitzung; Wert 0 = Sitzung beenden

Define this parameter in the request URI.

cacheSecret
Sitzungsschlüssel, wenn  positiv. Bei 1.Schritt leer, nachfolgend den in der Server-Antwort gelieferten verwenden

Define this parameter in the request URI.

meldeWeg
optional, i.d.R. leer. Code für expliziten Meldeweg in der angemeldeten Sitzung; Vorgabe ist 3 (=O, Online)

Define this parameter in the request URI.

bhvWrongCol
optional, i.d.R. leer. Code für Verhalten, wenn ein unbekanntes Feld in  angegeben wird; Vorgabe ist 0 (=Nachfrage)

Define this parameter in the request URI.

bhvFillCol
optional, i.d.R. leer. Code für Verhalten, wenn ein leeres Feld in  angegeben wird; Vorgabe ist 0 (=Nachfrage)

Define this parameter in the request URI.

kompeV2
optional, i.d.R. leer. Code für Verhalten bei Anhängen der Kompetenzbedingung; Vorgabe ist 0, d.h. nur primäre Kompetenzspalten berücksichtigen

Define this parameter in the request URI.

deltaSub
optional, i.d.R. leer. Anzahl Sekunden vom aktuellen Timestamp abgezogen, um Reserve für DELTA zu bekommen; Vorgabe ist 0

Define this parameter in the request URI.

Request body formats

Samples

application/json, text/json, application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

Samples

application/json, text/json

Sample:

Sample not available.