0.32 change: opvragen dossiers lokaal bestuur o.b.v. laatste wijziging

Context

De (integratoren van de) lokale besturen kunnen via endpoint /burgerlijke-stand/v1/dossierseen lijst van dossiers voor hun gemeente ophalen vanuit eLys. Om de belasting op het eLys platform te beperken willen we een nieuw endpoint invoeren, waarmee enkel de gewijzigde dossiers opgehaald worden en willen we het aantal opgehaalde dossiers per request beperken.

Beschrijving van de functionaliteit

Toevoeging van een nieuw endpoint om gewijzigde dossiers gepagineerd op te halen

GET /burgerlijke-stand/v1/dossiers/gewijzigd

Met dit endpoint worden alle dossiers opgezocht die gewijzigd zijn in een bepaalde periode. De resultatenlijst wordt gepagineerd als er teveel gewijzigde vaststellingen zijn.

We limiteren tot 100 gewijzigde vaststellingen per response.

Een wijziging kan betrekking hebben op:

de dossiergegevens in het dossier (DossierBurgerlijkeStandJSON)
de opgeladen documenten en aktes bij het dossier (VERZOEK_NABESTAANDE, TOESTEMMING_EIGENAAR, VERZOEK_NABESTAANDE_AS_PARTNER, VERZOEK_OPNAME_ALS_VADER_OF_MEEMOEDER, NATIONALE_AKTE, INTERNATIONALE_AKTE, TOESTEMMING_BEGRAFENIS_OF_CREMATIE)
de statistische gegevens bij het dossier (StatistischeGegevensJSON) - dus ook een nieuwe bevraging van het rijksregister wordt meegenomen als ‘wijziging’
het verslag beëdigd arts gekoppeld aan het dossier (VerslagBeedigdArtsJSON)
de laatste wilsbeschikking bij het dossier (LaatsteWilsbeschikkingJSON)
het verwijderen of verplaatsen (naar een andere gemeente) van een dossier.

Elke wijziging aan één van de hierboven vermelde gegevens vertaalt zich in een update van de laatsteWijzigingdatum van het dossier.

Van de integratoren wordt verwacht dat ze (zodra een dossier als gewijzigd wordt beschouwd en teruggeven wordt in de resultatenlijst van het nieuwe endpoint) zelf de nodige GET API calls uitvoeren om alle gegevens opnieuw te synchroniseren.

Request/response van het nieuwe endpoint

Request
- van datumtijd verplicht (laatste wijzigingsdatum vanaf)
- tot datumtijd optioneel
- lijst van postcodesoptioneel (vooral relevant in Antwerpen, waarbij elk district een eigen postcode heeft)
Response
- lijst van dossiers (cfr. /burgerlijke-stand/v1/dossiers/)
  - ook verwijderde dossiers (soft delete)
- parameters voor het paginatie mechanisme (cfr. /datadeling/v1/vaststellingen)
  - nogElementen
  - laatsteWijzigingDatum
- parameter totaalAantalElementen- geeft het totale aantal gewijzigde dossiers weer voor de gegeven request parameters over alle pagina’s heen

Ook verplaatste (naar een andere gemeente) dossiers worden als gewijzigd beschouwd. In dit geval mogen de dossiergegevens niet langer getoond worden, dit lossen we op door in die gevallen een DossierGebeurtenis terug te geven

CODE

[
  {
    "id": "dossiernummer", //verplaatst dossier
    "dossierDetailsOfGebeurtenis": DossierGebeurtenis,
  },
  { 
    "id": "dossiernummer", //gewijzigd maar niet verplaatst noch verwijderd dossier
    "dossierDetailsOfGebeurtenis": DossierBurgerlijkeStandJSON
  }
]

Als een lijst van postcodes meegegeven wordt als request parameter dan worden enkel gewijzigde dossiers voor die postcodes teruggegeven. Dossiers die niet meer toegankelijk zijn voor die postcodes (bv. omdat een dossier voor niscode Antwerpen is verplaatst van het ene district naar het andere) worden hier ook via een DossierGebeurtenis teruggegeven.

Link naar swagger (beta): Swagger UI