Zaaktypen-API

ZAAKTYPEN 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 catalogussen, inclusief hierin opgenomen zaaktypen en hieraan gekoppelde statustypen, roltypen, besluittypen, eigenschappen en informatieobjecttypen.
Domein Zaakgericht werken
Versiedatum documentatie 21 januari 2019
Provider Zaaktypecataloguscomponent (GEMMA2)
Consumer Componenten waarmee zaken behandeld worden (Zaakafhandelcomponenten; ZAC’s) en (andere) componenten die zaaktypegegevens raadplegen.
Informatiemodel ImZTC, versie 2.2 (in-ontwikkeling)
API-specificaties https://ref.tst.vng.cloud/ztc/api/v1/schema/
Bijzonderheden

Hieronder wordt een diagram getoond van de Zaaktypen-API op hoofdlijnen. Boven het diagram kunt u op het betreffende object (resource) klikken voor nadere informatie.

Besluittype, Catalogussen, Eigenschappen, Informatieobjectype Roltypen, Statustypen, Zaaktype Datamodel_Zaaktypen_API_Overview.png

Een andere manier om dit te tonen is:

Objecten Diagram
<img src="./assets/Datamodel_Zaaktypen_API_Overview.png" width="818" height="645" border="0" " />

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

Resource: Catalogussen

</tbody> </table> ## Resource: Zaaktype
Aspect Beschrijving
Doel
  • Opvragen van een overzicht van alle beschikbare Catalogussen.
  • Opvragen van de gegevens van een specifieke Catalogus.
Gegevens

Objecttype Catalogus, inclusief relatie naar ZAAKTYPE, BESLUITTYPE, INFORMATIEOBJECTTYPE.
https://www.gemmaonline.nl/index.php/Imztc_2.2/doc/objecttype/catalogus</td> </tr>

OAS-specificaties https://ref.tst.vng.cloud/ztc/api/v1/schema/#tag/catalogussen
Bijzonderheden
  • Het aanmaken van Catalogussen wordt nog niet ondersteund.
  • Het verwijderen van Catalogussen wordt nog niet ondersteund.
  • Het aanpassen van Catalogussen wordt nog niet ondersteund.
Aspect Beschrijving
Doel
  • Opvragen van een overzicht van alle beschikbare Zaaktypen in een Catalogus.
  • Opvragen van de gegevens van een specifiek Zaaktype in een Catalogus.
Gegevens Objecttype ZAAKTYPE, inclusief relatie naar STAUSTYPE, EIGENSCHAP, ROLTYPE en BESLUITTYPE.
https://www.gemmaonline.nl/index.php/Imztc_2.2/doc/objecttype/zaaktype
OAS-specificaties https://ref.tst.vng.cloud/ztc/api/v1/schema/#operation/zaaktype_list
Bijzonderheden
  • Het aanmaken van Zaaktypen wordt nog niet ondersteund.
  • Het verwijderen van Zaaktypen wordt nog niet ondersteund.
  • Het aanpassen van Zaaktypen wordt nog niet ondersteund.
## Resource: Besluittype
Aspect Beschrijving
Doel
  • Opvragen van een overzicht van alle beschikbare Besluittypen.
  • Opvragen van de gegevens van een specifiek Besluittype.
Gegevens https://www.gemmaonline.nl/index.php/Imztc_2.2/doc/objecttype/besluittype
OAS-specificaties https://ref.tst.vng.cloud/ztc/api/v1/schema/#operation/besluittype_list
Bijzonderheden
  • Het aanmaken van Besluittypen wordt nog niet ondersteund.
  • Het verwijderen van Besluittypen wordt nog niet ondersteund.
  • Het aanpassen van Besluittypen wordt nog niet ondersteund.
## Resource: Informatieobjecttype
Aspect Beschrijving
Doel
  • Opvragen van een overzicht van alle beschikbare Informatieobjecttypen.
  • Opvragen van de gegevens van een specifiek Informatieobjecttype.
Gegevens Objecttype INFORMATIEOBJECTYPE. https://www.gemmaonline.nl/index.php/Imztc_2.2/doc/objecttype/informatieobjecttype
OAS-specificaties https://ref.tst.vng.cloud/ztc/api/v1/schema/#operation/informatieobjecttype_list
Bijzonderheden
  • Het aanmaken van Informatieobjectype wordt nog niet ondersteund.
  • Het verwijderen van Informatieobjectype wordt nog niet ondersteund.
  • Het aanpassen van Informatieobjectype wordt nog niet ondersteund.
### Resource: Eigenschappen
Aspect Beschrijving
Doel
  • Opvragen van een overzicht van alle beschikbare Eigenschappen zoals gedefinieerd bij een Zaaktype, met de gegevens per Eigenschap.
  • Opvragen van de gegevens van een specifieke Eigenschap.
Gegevens Objecttype EIGENSCHAP, inclusief relatie naar ZAAKTYPE. https://www.gemmaonline.nl/index.php/Imztc_2.2/doc/objecttype/eigenschap
OAS-specificaties https://ref.tst.vng.cloud/ztc/api/v1/schema/#operation/eigenschap_list
Bijzonderheden
  • Het aanmaken van Eigenschappen wordt nog niet ondersteund.
  • Het verwijderen van Eigenschappen wordt nog niet ondersteund.
  • Het aanpassen van Eigenschappen wordt nog niet ondersteund.
### Resource: Roltypen
Aspect Beschrijving
Doel
  • Opvragen van een overzicht van alle beschikbare Roltypen.
  • Opvragen van de gegevens van een specifiek Roltype.
Gegevens Objecttype ROLTYPE, inclusief relatie naar ZAAKTYPE en mogelijke BETROKKENEN. https://www.gemmaonline.nl/index.php/Imztc_2.2/doc/objecttype/roltype
OAS-specificaties
https://ref.tst.vng.cloud/ztc/api/v1/schema/#operation/roltype_list
Bijzonderheden
  • Het aanmaken van Roltypen wordt nog niet ondersteund.
  • Het verwijderen van Roltypen wordt nog niet ondersteund.
  • Het aanpassen van Roltypen wordt nog niet ondersteund.
### Resource: Statustypen
Aspect Beschrijving
Doel
  • Opvragen van een overzicht van alle beschikbare Statustypen.
  • Opvragen van de gegevens van een specifiek Statustype.
Gegevens Objecttype STATUSTYPE, inclusief relatie naar ZAAKTYPE. https://www.gemmaonline.nl/index.php/Imztc_2.2/doc/objecttype/statustype
OAS-specificaties
https://ref.tst.vng.cloud/ztc/api/v1/schema/#operation/statustype_list
Bijzonderheden
  • Het aanmaken van Statustypen wordt nog niet ondersteund.
  • Het verwijderen van Statustypen wordt nog niet ondersteund.
  • Het aanpassen van Statustypen wordt nog niet ondersteund.