Zaken-API

ZAKEN API

FUNCTIONELE BESCHRIJVING

Hieronder lichten we de gebruiksmogelijkheden van deze API toe. Voor de werking van deze API verwijzen wij u naar de OAS-specificatie (zie ‘link’ hieronder).

Aspect Beschrijving
Doel Het kunnen aanspreken van een voorziening voor het onderhouden en raadplegen van zaken inclusief bijbehorende statussen, rollen en relaties naar betrokkenen, objecten, zaaktypen en statustypen.
Domein Zaakgericht werken
Versiedatum documentatie 19 november 2018
Provider Zaakregistratiecomponent (GEMMA2)
Consumer Componenten waarmee zaken behandeld worden (Zaakafhandelcomponenten; ZAC’s) en (andere) componenten die zaakgegevens raadplegen.
Informatiemodel RGBZ, versie 2.00.02 (in-ontwikkeling)
API-specificaties https://ref.tst.vng.cloud/zrc/api/v1/schema
Bijzonderheden Het RGBZ wordt in meerdere API’s uitgewerkt. Zo wordt bijvoorbeeld de relatie van een Zaak met Informatieobjecten gelegd vanuit een op die Informatieobjecten gerichte API. De versie van het RGBZ waarnaar verwezen wordt omvat meer dan hetgeen in deze API is uitgewerkt.
De hierboven beschreven doelen zijn nog niet volledig in deze versie van de API geimplementeerd.

Deze API omvat de navolgende resources (‘bronnen’) en de daarvan beschreven mogelijkheden.

Resource: Zaken

</tbody> </table> ### Resource: Zaakobjecten
Aspect Beschrijving
Doel
  • Opvragen van een overzicht van alle beschikbare Zaken of Zaken van een zaaktype.
  • Opvragen van een overzicht van Zaken binnen een geo-contour (locatie), eventueel van een Zaaktype.
  • Opvragen van de gegevens van een specifieke Zaak.
  • Aanmaken van een Zaak en deze relateren aan het van toepassing zijnde Zaaktype.
  • Wijzigen van alle gegevens van een Zaak.
  • Wijzigen van enkele gegevens van een Zaak.
  • Opvragen van een overzicht van informatieobjecten bij een Zaak.
  • Relateren van een informatieobject aan een Zaak.
Gegevens

Objecttype ZAAK, inclusief relatie naar ZAAKTYPE.
https://www.gemmaonline.nl/index.php/rgbz_2.0/doc/objecttype/zaak</td> </tr>

OAS-specificaties https://ref.tst.vng.cloud/zrc/api/v1/schema/#tag/zaken
Bijzonderheden
  • Het verwijderen van Zaken wordt nog niet ondersteund: Zaken kunnen wel beeindigd maar niet zomaar verwijderd worden, hooguit als ‘correctie’ of na verstrijken van de archiverings-vernietigingstermijn.
  • De relatie naar Zaaktype (cq. het Zaaktype van de Zaak) kan niet gewijzigd worden. Indien het Zaaktype onjuist blijkt te zijn, dient de Zaak beeindigd te worden en een nieuwe Zaak (met het juiste Zaakype) toegevoegd te worden.
  • De einddatum van de Zaak kan alleen opgevraagd worden. Muteren hiervan gebeurt in de resource: Statussen.
  • Het relateren van een Informatieobject aan een Zaak wordt aangestuurd vanuit de Documenten-API.
Aspect Beschrijving
Doel
  • Opvragen van een overzicht van Objecten bij een Zaak.
  • Opvragen van – de gegevens van - een specifiek Zaakobject die de relatie beschijft tussen een Object en een Zaak.
  • Relateren van een Object aan een Zaak d.m.v. het toevoegen van een Zaakobject.
Gegevens Relatieklasse ZAAKOBJECT, inclusief relatie ‘ZAAK betreft OBJECT’.
https://www.gemmaonline.nl/index.php/rgbz_2.0/doc/relatieklasse/zaakobject
OAS-specificaties https://ref.tst.vng.cloud/zrc/api/v1/schema/#tag/zaakobjecten
Bijzonderheden
  • Het verwijderen van Zaakobjecten wordt nog niet ondersteund. Overigens kunnen Zaakobjecten niet zomaar verwijderd worden, hooguit als ‘correctie’ of na verstrijken van de archiverings-vernietigingstermijn.
  • Het aanpassen van Zaakobjecten wordt nog niet ondersteund.
### Klantcontacten
Aspect Beschrijving
Doel
  • Opvragen van een overzicht van alle Klantcontacten met per Klantcontact enkele gegevens.
  • Opvragen van – de gegevens van - een specifiek Klantcontact.
  • Aanmaken van een Klantcontact en deze relateren aan een Zaak.
Gegevens https://www.gemmaonline.nl/index.php/rgbz_2.0/doc/objecttype/klantcontact
OAS-specificaties https://ref.tst.vng.cloud/zrc/api/v1/schema/#tag/klantcontacten
Bijzonderheden
  • Het verwijderen van Klantcontacten wordt nog niet ondersteund. Overigens kunnen Klantcontacten niet zomaar verwijderd worden, hooguit als ‘correctie’ of na verstrijken van de archiverings-vernietigingstermijn.
  • Het aanpassen van Klantcontacten wordt nog niet ondersteund.
### Resource: Rollen
Aspect Beschrijving
Doel
  • Opvragen van een overzicht van alle Rollen, desgewenst bij een Zaak, bij een Betrokkene en/of van een bepaald generiek roltype met per rol enkele gegevens.
  • Opvragen van – de gegevens van - een specifieke Rol.
  • Aanmaken van een Rol en deze relateren aan een Zaak en een Betrokkene.
Gegevens Relatieklasse ROL, inclusief relatie naar ZAAK. https://www.gemmaonline.nl/index.php/rgbz_2.0/doc/relatieklasse/rol
OAS-specificaties https://ref.tst.vng.cloud/zrc/api/v1/schema/#tag/rollen
Bijzonderheden
  • Het verwijderen van Rollen wordt nog niet ondersteund. Overigens kunnen Rollen niet zomaar verwijderd worden, hooguit als ‘correctie’ of na verstrijken van de archiverings-vernietigingstermijn.
  • Het aanpassen van Rollen wordt nog niet ondersteund.
### Resource: Statussen
Aspect Beschrijving
Doel
  • Opvragen van een overzicht van alle Statussen, desgewenst bij een Zaak en/of van een bepaald Statustype, met de gegevens per Status.
  • Opvragen van – de gegevens van - een specifieke Status.
  • Aanmaken van een Status en deze relateren aan een Zaak en het Statustype.
Gegevens Objecttype STATUS, inclusief relatie naar ZAAK en STATUSTYPE. https://www.gemmaonline.nl/index.php/rgbz_2.0/doc/objecttype/status
OAS-specificaties https://ref.tst.vng.cloud/zrc/api/v1/schema/#tag/statussen
Bijzonderheden
  • Het verwijderen van Statussen wordt nog niet ondersteund. Overigens kunnen Statussen niet zomaar verwijderd worden, hooguit als ‘correctie’ of na verstrijken van de archiverings-vernietigingstermijn.
  • Het aanpassen van Statussen wordt nog niet ondersteund.
  • Wanneer een zaak een nieuwe status krijgt wordt een nieuwe Status aangemaakt en krijgt deze de meest actuele datumStatusGezet (incl. tijd). Tevens wordt het element ‘status’ bij de zaak (Zaken-resource) geupdate.
  • De huidige status van een zaak is de status met de meest actuele datumStatusGezet. Dit is tevens de waarde van het element ‘status’ in de Zaken-resource.