DCB - Opvragen en muteren van dynamiek regels

Dynamiekregels zorgen ervoor dat aangegeven kan worden dat bepaalde dekkingen, objecten, partijen of rubrieken uit dekkingen, objecten, partijen alleen van toepassing zijn als aan bepaalde voorwaarden voldaan is. Dynamiekregels kunnen gekoppeld worden aan een productdefinitie.

Bij een dynamiekregel is er altijd een trigger (bron) die op basis van opgegeven rekenregels bepaald of het doel van toepassing is of niet. Zowel de trigger als het doel kan een dekking, object, partij of een rubriek uit een dekking, object of partij zijn.

Opvragen

Voor het opvragen gelden de volgende urls:

GET beheer/api/v1/administratie/assurantie/regels/dynamiekregels

Hiermee wordt een lijst met dynamiekregels opgehaald.

GET beheer/api/v1/administratie/assurantie/regels/dynamiekregels/{id}

Hiermee worden de detailgegevens van een specifieke dynamiekregel opgehaald.

De detailregel ziet er als volgt uit:

{

"RegelId": 0,

"Omschrijving": "",

"Herkomst": "Intern"/ "Tp"

“AFDBrancheId”: 0,

"Bron": {

"EntiteitCodeId": “”,

"AttribuutCodeId": “”,

"AFDDekkingCodeId": “”,

"RubriekId": 0

},

"Rekenregels": [

{

"RekenregelId": "",

"Operator": "",

"Waarde": {},

"Doel": {

"EntiteitCodeId": “”,

"AttribuutCodeId": “”,

"AFDDekkingCodeId": “”,

"RubriekId": 0

}

],

"Gevolg": "TonenOptioneel"/"TonenVerplicht",

}

RegelId

Het identificerende gegeven van de regel.

Omschrijving

Een omschrijving die getoond wordt bij het koppelen van de regel aan een product.

Herkomst

Regels onder de 10000 zijn uitgeleverd door Dias Software en mogen niet gewijzigd of verwijderd worden. Door de tussenpersoon ingevoerde regel mogen wel gewijzigd en verwijderd worden.

AFDBrancheId

De afd branche van de regel. Hiermee wordt gefilterd bij het koppelen van de regel aan het product. Het product van de branche en de branche van de regel moeten overeenkomen.

Bron

De trigger voor de dynamiek. Dit kan een dekking, object, partij (AttribuutCodeId en RubriekId zijn niet gevuld) of een rubriek in een dekking object of partij (AttribuutCodeId of RubriekId is gevuld)) zijn. Als de bron een waarde heeft die voldoet aan een opgegeven rekenregel, dan is de dynamiek van toepassen. Deze dynamiek kan tonen en verplicht of tonen maar optioneel zijn. Dit is vastgelegd in Gevolg.

Rekenregels

Via het Doel wordt de dekking, object, partij of de rubriek onder een dekking, object of partij waarop de dynamiek toegepast moet worden opgegeven. Via de operator en de waarde wordt bepaald wanneer de Bron waarde leidt tot het toepassen van de dynamiek.

Gevolg

Tonen, maar optioneel of tonen en verplicht invullen.

Voorbeelden van bestaande regels:

{

"RegelId": 4,

"Omschrijving": "Bij het meeverzekeren van nieuwwaardegarantie bij een auto of motor moet verplicht het aantal maanden garantie worden ingevuld",

"Herkomst": "Intern"

“AFDBrancheId”: 20,

"Bron": {

"EntiteitCodeId": “CA”,

"AttribuutCodeId": “NWEGAR”,

"AFDDekkingCodeId": “2002”,

},

"Rekenregels": [

{

"RekenregelId": "1",

"Operator": "GelijAan",

"Waarde": “J”,

"Doel": {

"EntiteitCodeId": “CA”,

"AttribuutCodeId": “NWEGMND”,

"AFDDekkingCodeId": “2002”,

}

],

"Gevolg": "TonenVerplicht",

}

Hierbij wordt het verplicht om het aantal maanden nieuwwaarde garantie in te voeren als nieuwwaarde garantie meeverzekerd is. Geldt voor volledig casco en kan alleen toegepast worden op producten uit de motorrijtuigen branche.

{

"RegelId": 11,

"Omschrijving": "Bij Woonhuis moet bij het meeverzekeren van de dekking Glas verplicht het Glas object worden ingevuld",

"Herkomst": "Intern"

“AFDBrancheId”: 50,

"Bron": {

"EntiteitCodeId": “GP”,

"AFDDekkingCodeId": “5021”,

"Rekenregels": [

{

"RekenregelId": "1",

"Operator": "GelijAan",

"Doel": {

"EntiteitCodeId": “GL”,

}

"Gevolg": "TonenVerplicht",

Dekking die dynamisch om een object vraagt.

Invoeren

Voor het invoeren van een nieuwe dynamiek regel:

PUT beheer/api/v1/administratie/assurantie/regels/dynamiekregels/invoeren

Hierbij moet het volgende formulier meegestuurd worden:

{

"ResourceId:" "",

"Omschrijving": "",

“AFDBrancheId”: 0,

"Bron": {

"EntiteitCodeId": “”,

"AttribuutCodeId": “”,

"AFDDekkingCodeId": “”,

"RubriekId": 0

},

"Rekenregels": [

{

"Operator": "",

"Waarde": {},

"Doel": {

"EntiteitCodeId": “”,

"AttribuutCodeId": “”,

"AFDDekkingCodeId": “”,

"RubriekId": 0

}

],

"Gevolg": "TonenOptioneel"/"TonenVerplicht",

}

Bij invoeren geldt:

AFD BrancheId moet een waarde van een bestaande afd branche hebben en is maximaal 3 cijfers lang. Opgeven van deze rubriek is optioneel.
EntiteitCodeId moet een bestaande afd entiteit zijn en precies 2 alfanumerieke tekens lang. Opgeven van deze rubriek is verplicht.
AttribuutCodeId is optioneel, maximaal 7 alfanumerieke tekens lang. Indien ingevuld, dan moet de combinatie van EntiteitCodeId en AttribuutCodeId bestaande combinatie in de afd datacatalogus vormen.
AFD DekkingCodeId is optioneel, precies 4 cijfers lang. Indien ingevuld, Het moet een bestaande afd dekkingcode zijn. Verder moet de dekkingcode gekoppeld zijn aan de gekozen entiteit.
RubriekId is optioneel, maximaal 6 cijfers lang. Indien ingevuld, dan moet de waarde inaar een bestaande rubriek met Herkomst = 1 (TP) verwijzen.
Omschrijving moet verplicht een waarde hebben.
Waarde is optioneel, maximaal 30 alfanumerieke tekens lang. Als de Bron een dekking, object of partij is (AttribuutCodeId en RubriekId zijn niet gevuld) dan mag de waarde niet gevuld zijn.
Operator is verplicht. Toegestane waardes zijn: GelijkAan, GroterDan, GroterGelijkAan, KleinerDan, KleinerGelijkAan en Ongelijk. Als de bron een dekking, object of partij is, dan mag alleen voor GelijkAan of Ongelijk gekozen worden.
AttribuutCodeId en RubriekId mogen niet beide zijn gevuld.
Regels die ingevoerd worden krijgen een RegelId van minimaal 10000.
Voor voorbeelden zie Ophalen.

Wijzigen

Voor het wijzigen van een dynamiek regel kan de volgende url gebruikt worden:

PUT beheer/api/v1/administratie/assurantie/regels/dynamiekregels/wijzigen

Hierbij moet het volgende formulier meegestuurd worden:

{

"ResourceId:" "",

"Omschrijving": "",

"RegelId": 0,

“AFDBrancheId”: 0,

"Bron": {

"EntiteitCodeId": “”,

"AttribuutCodeId": “”,

"AFDDekkingCodeId": “”,

"RubriekId": 0

},

"Rekenregels": [

{

"Actie": "",

"RekenregelId": "",

"Operator": "",

"Waarde": {},

"Doel": {

"EntiteitCodeId": “”,

"AttribuutCodeId": “”,

"AFDDekkingCodeId": “”,

"RubriekId": 0

}

],

"Gevolg": "TonenOptioneel"/"TonenVerplicht",

}

Wijzigen

Voor het wijzigen van een dynamiek regel kan de volgende url gebruikt worden:

PUT beheer/api/v1/administratie/assurantie/regels/dynamiekregels/wijzigen

Hierbij moet het volgende formulier meegestuurd worden:

{

"ResourceId:" "",

"Omschrijving": "",

"RegelId": 0,

“AFDBrancheId”: 0,

"Bron": {

"EntiteitCodeId": “”,

"AttribuutCodeId": “”,

"AFDDekkingCodeId": “”,

"RubriekId": 0

},

"Rekenregels": [

{

"Actie": "",

"RekenregelId": "",

"Operator": "",

"Waarde": {},

"Doel": {

"EntiteitCodeId": “”,

"AttribuutCodeId": “”,

"AFDDekkingCodeId": “”,

"RubriekId": 0

}

],

"Gevolg": "TonenOptioneel"/"TonenVerplicht",

}

Bij wijzigen geldt:

Zie invoeren, de regel moet aan alle voorwaarden blijven voldoen.
Het RegelId moet verwijzen naar een bestaande dynamiek regel.
Alleen dynamiek regels met herkomst Tp kunnen gewijzigd worden, Als de herkomst Intern is, dan is wijzigen niet toegestaan. Dit betekent dat het RegelId altijd minstens 10000 moet zijn.
De regel mag niet gebruikt worden in een product.
Bij de rekenregel moet de Actie: Toevoegen, Wijzigen of Verwijderen zijn. Bij Toevoegen mag geen RekenregelId opgegeven worden, bij Wijzigen en Verwijderen is het verplicht om een bestaande RekenregelId op te geven.
Gegevens die niet opgenomen zijn in het formulier houden hun waarde.
Wissen van b.v. een AttribuutCodeId moet gedaan worden door een lege string mee te geven. De RubriekId kan gewist worden door 0 mee te geven.

Verwijderen

Het verwijderen van een dynamiek regel kan met de volgende url:

DELETE beheer/api/v1/administratie/assurantie/regels/dynamiekregels/{id}

De id is het nummer van de dynamiekregel die verwijderd moet worden.

Bij verwijderen geldt:

De regel moet bestaan
Alleen dynamiek regels met herkomst Tp kunnen verwijderd worden, Als de herkomst Intern is, dan is verwijderen niet toegestaan. Dit betekent dat het RegelId altijd minstens 10000 moet zijn.
De regel mag niet gebruikt worden in een product.