Vorig onderwerp

Volgend onderwerp

Inhoud boek

Book Index

WebApi - Ophalen schadegebeurtenissen

Een mutatie op een schade kan leiden tot een schade gebeurtenis. Deze gebeurtenissen kunnen opgehaald worden op basis van een filter via de url:

schade/api/v1/gebeurtenissen

Hierbij kunnen de volgende queryparameters opgegeven worden. Queryparameters kunnen worden gecombineerd Als een queryparameter niet is opgegeven, dan wordt dat filter niet toegepast:

  • schadeid: [Optioneel] Geef alle schadegebeurtenissen behorend bij de opgegeven schade. Als de opgegeven schade niet bestaat, dan is het resultaat een BadRequest met foutcode SchadeOngeldig.
  • gebeurtenisidvanaf: [Optioneel] Geef alle schadegebeurtenissen met een GebeurtenisId gelijk aan of groter dan de opgegeven waarde.
  • gebeurtenisidtotenmet: [Optioneel] Geef alle schadegebeurtenissen met een GebeurtenisId gelijk aan of kleiner dan de opgegeven waarde.
  • isafgehandeld: [Optioneel] true of false. Geef alle schadegebeurtenissen die wel, of juist niet, afgehandeld zijn (zie Schge_Afgehandeld_Jn).
  • tijdstipontstaanstart: [Optioneel] Geef alle schadegebeurtenissen die ontstaan zijn op of na het opgegeven tijdstip.
  • tijdstipontstaaneind: [Optioneel] Geef alle schadegebeurtenissen die ontstaan zijn op of voor het opgegeven tijdstip.
  • soortgebeurtenisid: [Optioneel] Geef alle schadegebeurtenissen van het opgegeven soort. Zie het onderdeel ‘Resultaat’, bij de omschrijving van Gebeurtenis.SoortGebeurtenisId.

Opmerkingen:

  • Het is niet toegestaan om geen enkele parameter op te geven. Het is ook niet toegestaan om alleen isafgehandeld op te geven. In deze gevallen moet een BadRequest gegeven worden.
  • Om de schadegebeurtenis(sen) in te zien is de SchadeInzien permissie noodzakelijk.
  • De kantorenmodule is van toepassing op het ophalen van de schadegebeurtenissen. Het is verplicht om het bedrijfid in de header mee te geven. Indien van toepassing kan ook het kantoorid en de medewerker waarvoor de gebeurtenissen opgehaald worden in de header opgenomen worden. Indien er sprake is van de kantorenmodule, dan is het verplicht om het kantoor en de medewerker op te geven. 

Om een specifieke schadegebeurtenis in te zien is de zien kan de volgende url gbruikt worden: 

schade/api/v1/gebeurtenissen/{id}

Hiermee halen we op:

{

"GebeurtenisId": 0,

"ContractGebeurtenisId": 0,

"Volgnummer": 0,

"TijdstipOntstaan": "",

"TijdstipGewijzigd": ""

"GewijzigdDoorMedewerker": 0,

"Gebeurtenis" {

"GebeurtenisSchadeId": 0,

"SoortGebeurtenisId": "",

"TypeGebeurtenisId": "",

"Omschrijving": "",

},

"IsAfgehandeld" : true,

"Omschrijving": string,

"ExternBoekingId": ""

}

Dit is dezelfde inhoud als bij de lijst met schadegebeurtenissen, met de volgende uitbreiding:

  • ExternBoekingId: Alleen beschikbaar voor SchadeGebeurtenissen met een bijbehorend SchadeBoekingVoorlopig. Deze tabel bevat velden voor administratie-, boekjaar, dagboek- en borderel-nummers, waarmee een bijbehorende FinBoekingGebeurtenis opgehaald kan worden. Het getoonde veld is FinBoekingGebeurtenis.ExternBoekingId.

Fouten
Er wordt Not Found (404) teruggegeven als de gevraagde schadegebeurtenis niet bestaat.