VermittlerWebservice - Vertragsverwaltung - Detaildaten

Funktionen

Name	HTTP	Eingabe	Ausgabe
getSpartenProductTemplate	GET ${pfad}/sparten/${Sparte-Id}/produkttemplate		JSON ProduktTemplate
getVertragProdukte	GET ${pfad}/{$vmt}/kunden/${Kunde-Id}/vertraege/${Vertrag-Id}/produkte		JSON ProduktKomponenten
patchVertragProdukte	PATCH ${pfad}/{$vmt}/kunden/${Kunde-Id}/vertraege/${Vertrag-Id}/produkte		JSON ArrayOf AktualisierungsAnweisung

getSpartenProductTemplate

Sollte die Sparte des Vertrages keine Detaildaten unterstützen wird ein 404 Fehler zurückgegeben

getVertragProdukte

Sollte die Sparte des Vertrages keine Detaildaten unterstützen wird ein 404 Fehler zurückgegeben

patchVertragProdukte

Sollte die Sparte des Vertrages keine Detaildaten unterstützen wird ein 404 Fehler zurückgegeben

KomponentenPfad

Die Pfade setzen sich anhand der Definitionen aus dem ProduktTemplate wie folgt zusammen:

DefinitionTyp[Definition.Name]/DefinitionTyp[Definition.Name] ...
Beispiel:

Produkt[Haftpflicht]/Elementarprodukt[Privathaftpflicht]/VersichertesRisikoOderWagniss[Versicherte Person]/VariableWert[Vorname]

Sollten in Definition.Name Schrägstriche "/" enthalten sein, müssen diese mit einem Rückwärtsschrägstrich "\" maskiert werden: Produkt[Haftpflicht]/Elementarprodukt[Privathaftpflicht]/VariableWert[Anmerkungen \/ Besonderheiten]

☛nicht existierende Komponenten werden automatisch erstellt
☛ setzen wird nur für VariableWert unterstützt
☛ löschen wird nicht für VariableWert unterstützt (stattdessen wert auf null setzen)

Beispiel Privathafpflicht: setzen unterschiedlicher Werte sowie löschen des Lebenspartners

[
    {"Setze":"Produkt[Haftpflicht]\/Elementarprodukt[Privathaftpflicht]\/VersichertesRisikoOderWagniss[Versicherte Person]\/VariableWert[Vorname]","Wert":"Max"},
    {"Setze":"Produkt[Haftpflicht]\/Elementarprodukt[Privathaftpflicht]\/VariableWert[Selbstbeteiligung]","Wert":150},
    {"Setze":"Produkt[Haftpflicht]\/Elementarprodukt[Privathaftpflicht]\/VariableWert[Diensthaftpflicht]","Wert":3},
    {"Setze":"Produkt[Haftpflicht]\/Elementarprodukt[Privathaftpflicht]\/VersicherungssummeOderLeistung[Deckungssummen]\/VariableWert[Personensch\u00e4den]","Wert":1000000},
    {"Setze":"Produkt[Haftpflicht]\/Elementarprodukt[Privathaftpflicht]\/VersicherungssummeOderLeistung[Deckungssummen]\/VariableWert[unbegrenzte Sachsch\u00e4den]","Wert":true},
    {"Loesche":"Produkt[Haftpflicht]\/Elementarprodukt[Privathaftpflicht]\/VersichertesRisikoOderWagniss[Lebenspartner]"}
]

Datentypen

ProduktTemplate

Name	Datentyp	Beschreibung
Versicherungsnehmer	DefinitionVersichertesRisikoOderWagniss
Produkte	ArrayOf DefinitionProdukt

Definition

Name	Datentyp	Beschreibung
Id	string
Name	string
Mindestanzahl	integer
Maximalanzahl	integer
Sortierung	integer

DefinitionProduktbaustein

Erbt von Definition

Name	Datentyp	Beschreibung
Variablen	ArrayOf DefinitionVariable
VersicherteRisikenUndWagnisse	ArrayOf DefinitionVersichertesRisikoOderWagniss
VersicherungssummenUndLeistungen	ArrayOf DefinitionVersicherungssummeOderLeistung

DefinitionProdukt

Erbt von DefinitionProduktbaustein

Name	Datentyp	Beschreibung
Elementarprodukte	ArrayOf DefinitionElementarprodukt

DefinitionElementarproduktProdukt

Erbt von DefinitionProduktbaustein

DefinitionVersichertesRisikoOderWagniss

Erbt von Definition

Name	Datentyp	Beschreibung
Variablen	ArrayOf DefinitionVariable
VersicherteRisikenUndWagnisse	ArrayOf DefinitionVersichertesRisikoOderWagnissBeziehung

DefinitionVersichertesRisikoOderWagnissBeziehung

Name	Datentyp	Beschreibung
Rolle	string
Mindestanzahl	integer
Maximalanzahl	integer
Sortierung	integer
Beziehungsvariable	DefinitionVariable
VersichertesRisikoOderWagniss	DefinitionVersichertesRisikoOderWagniss

DefinitionVersicherungssummeOderLeistung

Erbt von Definition

Name	Datentyp	Beschreibung
Variablen	ArrayOf DefinitionVariable

DefinitionVariable

Erbt von Definition

Name	Datentyp	Beschreibung
Datentyp	string	boolean,integer,decimal,amount,text,date,list
Standardwert	je nach Datentyp
Eigenschaften	object	je nach Datentyp
Gruppe	string	variablen der gleichen Gruppe können zusammengefasst werden

ProduktKomponenten

Name	Datentyp	Beschreibung
Versicherungsnehmer	VersichertesRisikoOderWagniss
Produkte	ArrayOf Produkt

Komponente

Name	Datentyp	Beschreibung
Id	string
Definition	string	Id der Definition
Titel	string	kann den Namen der Definition überschreiben

Produktbaustein

Erbt von Komponente

Name	Datentyp	Beschreibung
Werte	ArrayOf VariableWert
VersicherteRisikenUndWagnisse	ArrayOf VersichertesRisikoOderWagniss
VersicherungssummenUndLeistungen	ArrayOf VersicherungssummeOderLeistung

Produkt

Erbt von Produktbaustein

Name	Datentyp	Beschreibung
Elementarprodukte	ArrayOf Elementarprodukt

ElementarproduktProdukt

Erbt von Produktbaustein

VersichertesRisikoOderWagniss

Erbt von Komponente

Name	Datentyp	Beschreibung
Werte	ArrayOf VariableWert
VersicherteRisikenUndWagnisse	ArrayOf VersichertesRisikoOderWagniss

VersichertesRisikoOderWagnissBeziehung

Name	Datentyp	Beschreibung
Rolle	string
Beziehungswert	je nach Datentyp
VersichertesRisikoOderWagniss	DefinitionVersichertesRisikoOderWagniss

VersicherungssummeOderLeistung

Erbt von Komponente

Name	Datentyp	Beschreibung
Werte	ArrayOf VariableWert

VariableWert

Name	Datentyp	Beschreibung
Id	string	Id der Definition
Wert	je nach Datentyp	wenn Maximalanzahl in der Definition gleich 1
Werte	ArrayOf je nach Datentyp		wenn Maximalanzahl in der Definition größer als 1

AktualisierungsAnweisung

abstrakt SetzAnweisung oder LoeschAnweisung

SetzAnweisung

Name	Datentyp	Beschreibung
Setze	string	KomponentenPfad zur Variablen dessen Wert geändert werden soll
Wert	je nach Datentyp

LoeschAnweisung

Name	Datentyp	Beschreibung
Loesche	string	KomponentenPfad zur Komponente die gelöscht werden soll