NV WebApi

Erscheinungsbild

Schaden ​

Zur API-Dokumentation

Mithilfe des Schaden-Controllers können Daten zu Schäden abgefragt werden.

Die Schnittstelle bietet drei Endpunkte:

  • GET .../get-schaden/{schadenNr}: Liefert die Daten zu einem Schaden.
  • GET .../get-schaeden/{policeNr}/{vertragNr}: Liefert eine Liste der Schäden zu einem Vertrag.
  • POST .../search-schaeden: Sucht Schäden anhand von Filterkriterien.

Schaden abfragen (Get Schaden) ​

Mit dem Endpunkt GET .../get-schaden/{schadenNr} können die Daten zu einem Schaden abgefragt werden.

Anfrage ​

json
// URL: .../get-schaden/{schadenNr}

Antwort ​

json
{
    "schadenNr": "...",
    "schadendatum": "01.01.2024",
    "meldedatum": "01.01.2024",
    "status": "geschlossen",
    "beschreibung": "Eine Beschreibung",
    "schadenursache": "...",
    "zahlungen": [
        {
        "zahlungsdatum": "02.02.2024",
        "zahlungsbetrag": 10.23,
        "leistungsart": "...", // z.B "Sachschaden" oder "Externe Regulierungskosten"
        "zahlungsempfaengerArt": "VN"
        }
    ],
    "reserve": 0.00,
    "smaLink": null, // Link zum Schadenmeldeassistenten, wenn vorhanden
    "sachbearbeiter": {
        "vorname": "...",
        "name": "...",
        "email": "...",
        "telefon": "..."
    }
}

Schäden abfragen (Get Schäden) ​

Mit dem Endpunkt GET .../get-schaeden/{policeNr}/{vertragNr} können die Schäden zu einem bestimmten Vertrag abgefragt werden.

Anfrage ​

json
// URL: .../get-schaeden/{policeNr}/{vertragNr}

Antwort ​

json
[
    {
        "schadenNr": "...",
        "schadendatum": "01.01.2024",
        "meldedatum": "01.01.2024",
        "status": "geschlossen",
        "beschreibung": "Eine Beschreibung",
        "schadenursache": "...",
        "zahlungen": [
            {
            "zahlungsdatum": "02.02.2024",
            "zahlungsbetrag": 10.23,
            "leistungsart": "...", // z.B "Sachschaden" oder "Externe Regulierungskosten"
            "zahlungsempfaengerArt": "VN"
            }
        ],
        "reserve": 0.00,
        "smaLink": null, // Link zum Schadenmeldeassistenten, wenn vorhanden
        "sachbearbeiter": {
            "vorname": "...",
            "name": "...",
            "email": "...",
            "telefon": "..."
        }
    },
    ...
]

Schäden suchen (Search Schäden) ​

Mit dem Endpunkt POST .../search-schaeden können Schäden anhand von Filterkriterien gesucht werden.

Unterstüzte Filterkriterien sind:

  • Meldedatum von/bis
  • Schadendatum von/bis

Sind bei Kriterien angegeben, werden nur Schäden zurückgegeben, die beiden Kriterien entsprechen.

Anfrage ​

json
{
    "meldedatumBis": "01.01.2024",
    "meldedatumVon": "01.01.2024",
    "schadendatumBis": "01.01.2024",
    "schadendatumVon": "01.01.2024"
}

Antwort ​

json
[
    {
        "schadenNr": "...",
        "policenNr": ...,
        "vertragsNr": ...
    },
    ...
]