Eine offizielle Website der Bundesrepublik Deutschland
Zum Hauptinhalt springen

ReportV2

statusstring

Das Ergebnis der Validierung.

Example: Valide, ValideMitWarnungen, NichtValide
vollstaendigboolean

Report wurde gekürzt/nicht gekürzt.

infostring | nullnullable

Zusatzinformationen zum Report.

warnungeninteger<int64>

Anzahl valider Dokumente mit Warnungen.

hinweiseinteger<int64>

Anzahl valider Dokumente mit Hinweisen.

fehlerhaftinteger<int64>

Anzahl fehlerhafter Dokumente.

validiertinteger<int64>

Anzahl bereits validierter Dokumente.

gesamtinteger<int64>

Gesamtzahl der zu validierenden Dokumente.

validierungsprotokolle object[]

Liste aller Validierungsprotokolle aller Dokumente.

  • Array [
  • statusstring

    Status der Validierung eines Dokumentes.

    dokumentNamestring

    Name bzw. Pfad eines Dokumentes.

    validatorErgebnisse object[]

    Liste aller Protokolleinträge eines Dokumentes.

  • Array [
  • validatorIdstring

    Wenn vorhanden, die ID des Validators, welcher diesen Eintrag protokolliert hat.

    Example: VAL0001
    meldungen object[]

    Sammlung an Meldungen für diesen Validator.

  • Array [
  • typstring

    Der Typ des Protokolleintrags.

    Possible values: [INFO, FEHLER, WARNUNG, HINWEIS]

    Example: FEHLER
    nachrichtstring

    Die Nachricht des Protokolleintrags.

    nachrichtIdstring

    Eindeutiger Bezeichner für die Art von Fehlernachricht.

    uebersetzungsModusSprachestring

    Die Sprache in der diese Meldung aufgetreten ist (nur gefüllt, wen der Validator im Übersetzungsmodus arbeitet)

    nachrichtParameterstring[]

    Eindeutige Parameter wie z.B. XZuFi-IDs oder ungültige Inhalte, welche auf die Fehlerursache hinweisen.

    anzahlinteger<int32>

    Anzahl, wie häufig dieser Eintrag erstellt wurde.

  • ]
  • ]
  • ]
  • ReportV2
    {
    "status": "Valide, ValideMitWarnungen, NichtValide",
    "vollstaendig": true,
    "info": "string",
    "warnungen": 0,
    "hinweise": 0,
    "fehlerhaft": 0,
    "validiert": 0,
    "gesamt": 0,
    "validierungsprotokolle": [
    {
    "status": "string",
    "dokumentName": "string",
    "validatorErgebnisse": [
    {
    "validatorId": "VAL0001",
    "meldungen": [
    {
    "typ": "FEHLER",
    "nachricht": "string",
    "nachrichtId": "string",
    "uebersetzungsModusSprache": "string",
    "nachrichtParameter": [
    "string"
    ],
    "anzahl": 0
    }
    ]
    }
    ]
    }
    ]
    }