Zaken API
API voor het opslaan en ontsluiten van zaakgegevens.
De API ondersteunt het opslaan en het naar andere applicaties ontsluiten van gegevens over alle gemeentelijke zaken, van elk type. Opslag vindt plaats conform het RGBZ waarin objecten, gegevens daarvan en onderlinge relaties zijn beschreven. Het bevat echter niet alle gegevens uit het RGBZ: documenten worden bijv. opgeslagen in de Documenten API, besluiten in de Besluiten API, etc. Vanuit zaken worden er dan ook relaties gelegd naar andere resources.
Gegevensmodel
De zaak vormt de kern van het zaakgericht werken. De omvang en afbakening worden bepaald door het traject van (aan)vraag tot (passend) antwoord. Een zaak komt daarmee overeen met een bedrijfsproces.
Hoofd- en deel-zaken
Als een product of dienst via verschillende bedrijfsprocessen tot stand komt, wordt gewerkt met deelzaken. De hoofdzaak coördineert dat alle deelzaken samen leiden tot het (passende) antwoord op de (aan)vraag van de initiator.
Relevante andere zaken
Soms heeft de ene zaak betrekking op een andere zaak, zoals een bezwaarzaak die volgt op een vergunningzaak.
Aan elkaar gerelateerde zaken (met elk hun eigen bedrijfsproces/aanleiding) worden vastgelegd als AndereRelevanteZaak. Dit zijn zowel zaken binnen dezelfde organisatie als van verschillende organisaties.
Zaakobject
Elke zaak heeft ergens betrekking op wat is vastgelegd met de relatie naar zaakobject. De, bij de ontwikkeling van de API’s gebruikte, zaakobjecten (mor, verblijfsobject, …) kunnen als resource of m.b.v. identificerende gegevens worden opgenomen bij het zaakobject. Aangezien nog niet kan worden aangenomen dat deze vanuit de bron beschikbaar zijn.
Betrokken en rollen
Ook heeft elke zaak één of meer betrokkenen, die via hun rol aan de zaak gerelateerd zijn. De verschillende typen betrokkenen (medewerker, natuurlijk persoon, niet natuurlijk persoon en organisatieonderdeel), zijn nu opgenomen in de ZakenAPI. Aangezien nog niet kan worden aangenomen dat deze vanuit de bron beschikbaar zijn.
Relatie met besluiten en documenten
Een besluit kan een uitkomst zijn van een zaak van de zaakbehandelende organisatie. Besluit heeft dan ook een optionele relatie met de zaak waarvan het een uitkomst is. Deze relatie wordt in de Zaken API vastgelegd in zaakbesluit. Een informatieobject kan tot meer dan één zaak behoren en een zaak kan meer dan één informatieobjecten bevatten. De relatie tussen zaak en informatieobject is vastgelegd in zaakinformatieobject (Zaken API) en objectinformatieobject (Documenten API), waarbij zaakinformatieobject leidend is.
Zaakdossier
Een zaak, met eventuele deelzaken dan wel de verwijzing naar de hoofdzaak, alle kenmerken, alle daaraan gerelateerde Informatieobjecten en alle andere gerelateerde gegevens (via rol, zaakobject, etc.) vormen gezamenlijk het zaakdossier.
Specificatie van de Zaken API
Release Notes
De release notes van de versies staan beschreven op deze pagina.
Known Issues
De known issues van de versies staan beschreven op deze pagina.
Releases
Referentie-implementatie Zaken API
| Versie | Release datum | API specificatie | Specificatie van gedrag |
|---|---|---|---|
| 1.7.0 | Concept | ReDoc | |
| 1.6.0 | 20-03-2026 | ReDoc | spec 1.6.0 |
| 1.5.1 | 26-09-2023 | ReDoc, Swagger | spec 1.5.1 |
| 1.4.1 | 26-09-2023 | ReDoc, Swagger | spec 1.4.1 |
| 1.3.1 | 26-09-2022 | ReDoc, Swagger | spec 1.3.1 |
| 1.5.0 | 22-08-2023 | ReDoc, Swagger, YAML | spec 1.5.0 |
| 1.4.0 | 21-03-2023 | ReDoc, Swagger, YAML | spec 1.4.0 |
| VERVALLEN |
|||
| 1.3.0 | 19-12-2022 | ReDoc, Swagger, Diff | spec 1.3.0 |
| 1.2.0 | 2021-08-31 | ReDoc, Swagger, Diff | spec 1.2.0 |
| 1.1.0 | 24-05-2021 | ReDoc, Swagger, Diff | spec 1.1.0 |
| 1.0.2 | 2020-06-12 | ReDoc, Swagger, Diff | spec 1.0.2 |
| 1.0.1 | 2019-12-16 | ReDoc, Swagger, Diff | spec 1.0.1 |
| 1.0.0 | 2019-11-18 | ReDoc, Swagger | spec 1.0.0 |