Skip to content

Korrespondenz

Zur API-Dokumentation

Mithilfe des Korrespondenz-Controllers können Dokumente importiert oder (später) auch abgerufen werden.

Importieren von Dokumenten (Import Dokument)

Dokumente werden nicht direkt in das JSON eingebettet, sondern per Multi-Part-Form-Data übertragen. Die Dokumente werden dabei als Datei übertragen. Erlaubt sind die Bild-Typen wie image/jpeg oder image/png und PDF-Dateien application/pdf.

Die Anfrage besteht aus den Metadaten und dem Dokument. Das Dokument wird im Form-Data-Feld file, die Metadaten in metadata übertragen.

Wichtig

Es ist wichtig bei den Metadaten den Medientyp application/json zu setzen, da die WebApi sonst ohne weitere Information mit einen HTTP 415 Unsupported Media Type antwortet.

json
// Form-Data-Feld: metadata
{
    "accessToken": {
        "id": "string",
        "signatureIssuer": "string",
        "signatureTimestamp": "string",
        "signature": "string",
        "context": {
            "partnerNr": 0,
            "policenNr": 0,
            "vertragsNr": 0,
            "schadenNr": "string"
        }
    },
    "beschreibung": "Eine Beschreibung"
}
json
{
    "korrespondenzNr": 0
}

Achtung

Die Korrespondenznummer ist für technische Zwecke und nicht für den Benutzer bestimmt und sollte diesem nicht angezeigt werden.