API-register: Overzicht

Een REST-API voor het beheren van de behandeldienst configuraties. Hierin kan een organisatie/activiteit combinatie gekoppeld worden aan een behandeldienst.

Een REST-API voor het opvragen van werkzaamheden. Een werkzaamheid is een verzameling van werkzaamheid versies en wordt geïdentificeerd d.m.v. de urn. Een specifieke versie van een werkzaamheid wordt geïdentificeerd met de urn van de werkzaamheid, en een datum waarop de versie geldig is.

Het ophalen van vragen en het beantwoorden van vragen (Toepasbare Regels) ten behoeve van

1. de vergunningcheck (het checken wat een initiatiefnemer moet doen, bijv. een vergunning aanvragen),
2. het opstellen van een aanvraag en/of melding of
3. het checken welke maatregelen nodig zijn

De uitkomst van het checken is een conclusie, de uitkomst van het opstellen is of deze indienbaar en compleet is. De uitkomst van maatregelen zijn verwijzingen naar de voorschriften met bijbehorende maatregelen. Voor het gebruik van de service is een x-api-key nodig. Deze versie van de api maakt gebruik van het dynamische vragen algoritme zoals beschreven in hoofdstuk 8.6 "Modelleren dynamische vragen" van versie 3 van de STTR-standaard.

Het ophalen van vragen en het beantwoorden van vragen (Toepasbare Regels) ten behoeve van

1. de vergunningcheck (het checken wat een initiatiefnemer moet doen, bijv. een vergunning aanvragen),
2. het opstellen van een aanvraag en/of melding of
3. het checken welke maatregelen nodig zijn

De uitkomst van het checken is een conclusie, de uitkomst van het opstellen is of deze indienbaar en compleet is. De uitkomst van maatregelen zijn verwijzingen naar de voorschriften met bijbehorende maatregelen. Voor het gebruik van de service is een x-api-key nodig. Deze versie van de api maakt gebruik van het dynamische vragen algoritme zoals beschreven in hoofdstuk 8.6 "Modelleren dynamische vragen" van versie 1 en 2 van de STTR-standaard.

Services voor het beheren van ideeverkenningconfiguraties en notificatieversieconfiguraties.

Services voor het opvragen van ideeverkenningconfiguraties en notificatieversieconfiguraties.

Tbv ophalen verzoek, zoeken naar verzoeken en wijzigen van het bevoegd gezag. Het ophalen van een ingediend verzoek (aanvraag/melding). Een verzoek kan worden opgehaald door het opgeven van het verzoeknummer. Het opgehaalde verzoek bevat referenties naar documenten (formulieren en bijlagen). Het zoeken naar ingediende verzoeken op basis van verschillende criteria. Het wijzigen van het bevoegd gezag (en eventueel behandeldienst) voor een ingediend verzoek (aanvraag/melding). Een verzoek kan worden verwijderd door het bevoegd gezag (of eventueel behandeldienst). Een overheidsinstantie die geïnformeerd moet worden en het verzoek ook kan ophalen, kan het verzoek markeren als gelezen (afmelden).

De v2 van deze API is deprecated, gebruik v3. De wijzigingen tov de 2.0.6 zijn:

• DoelVerzoek Vooroverleg is gewijzigd naar Conceptverzoek
• Swagger validatie wordt toegepast

Tbv ophalen verzoek, zoeken naar verzoeken en wijzigen van het bevoegd gezag. Het ophalen van een ingediend verzoek (aanvraag/melding). Een verzoek kan worden opgehaald door het opgeven van het verzoeknummer. Het opgehaalde verzoek bevat referenties naar documenten (formulieren en bijlagen). Het zoeken naar ingediende verzoeken op basis van verschillende criteria. Het wijzigen van het bevoegd gezag (en eventueel behandeldienst) voor een ingediend verzoek (aanvraag/melding). Een verzoek kan worden verwijderd door het bevoegd gezag (of eventueel behandeldienst). Een overheidsinstantie die geïnformeerd moet worden en het verzoek ook kan ophalen, kan het verzoek markeren als gelezen (afmelden).

Het indienen van een verzoek (aanvraag/melding/ideeverkenning). Met deze service kan er in een aantal stappen een verzoek ingediend worden als initiatiefnemer of gemachtigde. Deze service werkt volgens de HATEOAS standaard. Als eerste start men met het initiëren van een verzoek. Het resultaat hiervan bevat de locatie van het geïnitieerde verzoek en het verzoek met de link voor het toevoegen van documenten. Documenten dienen wat betreft bestandsnaam en content uniek te zijn.

• Ophalen Door het verzoek op te halen krijgt men het verzoek met de link voor het toevoegen van documenten.
• Verwijderen Hiermee verwijdert men het geïnitieerde (nog niet ingediende) verzoek.
• Indienen Het geïnitieerde verzoek en eventueel toegevoegde documenten worden ingediend.
• Intrekken Hiermee trekt men een eerder ingediend verzoek in.

Er zijn verschillende types verzoeken. Voor het type "Idee" zijn er voor de bovenstaande stappen de endpoints op de paden die beginnen met "/ideeverkenningen". Voor de overige types verzoeken moeten de paden die beginnen met "/verzoeken" gebruikt worden. Dit onderscheid is er omdat de request body voor ideeverkenning anders is dan die van de overige types verzoeken.

De v4 van deze API is deprecated, gebruik v5. In v5 wordt het machtiging element vervangen met het rolaanduding element. Ook zijn de /info en /health endpoint definitief verwijderd. Ook is bij de fout responses de content-type aangepast van 'application/json' naar 'application/problem+json'. Als laatste is bij het adres het niet langer toegestaan om lege elementen mee te geven voor de verschillende elementen. Het indienen van een verzoek (aanvraag/melding/ideeverkenning). Met deze service kan er in een aantal stappen een verzoek ingediend worden als initiatiefnemer of gemachtigde. Deze service werkt volgens de HATEOAS standaard. Als eerste start men met het initiëren van een verzoek. Het resultaat hiervan bevat de locatie van het geïnitieerde verzoek en het verzoek met de link voor het toevoegen van documenten. Documenten dienen wat betreft bestandsnaam en content uniek te zijn.

• Ophalen Door het verzoek op te halen krijgt men het verzoek met de link voor het toevoegen van documenten.
• Verwijderen Hiermee verwijdert men het geïnitieerde (nog niet ingediende) verzoek.
• Indienen Het geïnitieerde verzoek en eventueel toegevoegde documenten worden ingediend.
• Intrekken Hiermee trekt men een eerder ingediend verzoek in.

Er zijn verschillende types verzoeken. Voor het type "Idee" zijn er voor de bovenstaande stappen de endpoints op de paden die beginnen met "/ideeverkenningen". Voor de overige types verzoeken moeten de paden die beginnen met "/verzoeken" gebruikt worden. Dit onderscheid is er omdat de request body voor ideeverkenning anders is dan die van de overige types verzoeken.