Verzoek afhandelen
Een REST API die het bevoegd gezag en een eventuele behandeldienst kunnen gebruiken om een ingediend verzoek af te handelen. Met deze service kan een verzoek en bijgevoegde bijlagen worden opgehaald. Ook kan een verzoek worden overgedragen aan een ander bevoegd gezag en/of behandeldienst. Tenslotte biedt de API de mogelijkheid om een verzoek te verwijderen, en te zoeken naar eerder ingediende verzoeken die bekeken moeten worden in verband met de gecoördineerde afhandeling van verzoeken.
Label: Vergunningaanvragen en meldingen
Endpoints
Pre-productieomgeving
https://pkio.service.pre.omgevingswet.overheid.nl/overheid/verzoeken/api/afhandelen/v2/
https://pkio.service.pre.omgevingswet.overheid.nl/overheid/verzoeken/api/afhandelen/v3/
Productieomgeving
https://pkio.service.omgevingswet.overheid.nl/overheid/verzoeken/api/afhandelen/v2/
https://pkio.service.omgevingswet.overheid.nl/overheid/verzoeken/api/afhandelen/v3/
Beveiligde REST-service
Hoe u toegang aanvraagt voor deze beveiligde REST-service leest u in de aansluitdocumentatie.
Omschrijving
Notificatie aan bevoegd gezag
De overheidsorganisaties (bevoegd gezag en de eventueel ingestelde behandeldienst) die het verzoek moeten afhandelen ontvangen een verzoeknotificatie. In deze verzoeknotificatie staan gegevens die het bevoegd gezag of behandeldienst nodig hebben om het verzoek op te halen uit de werkmap.
Verzoek ophalen
Op basis van het verzoeknummer dat is meegegeven in de verzoeknotificatie kan een verzoek met bijbehorende bijlagen worden opgehaald en in het eigen VTH- of zaaksysteem worden geplaatst. Dit verloopt via de service 'Verzoek ophalen'. Alleen het bevoegd gezag aan wie het verzoek is gericht, en de eventueel door het bevoegd gezag ingestelde behandeldienst, kunnen het verzoek ophalen.
Het ophalen van een verzoek vindt plaats in twee stappen:
- Verzoekreferenties ophalen. Op basis van het verzoeknummer dat is meegegeven in de verzoeknotificatie wordt verzoekreferenties (links) opgehaald die verwijzen naar:
- het verzoek in XML-formaat (voldoet aan de STAM-standaard);
- een publiceerbare1 versie van het verzoek in PDF-formaat; en
- documenten (bijlagen bij het verzoek).
- Verzoek en/of documenten ophalen. Als het verzoek bijlagen bevat dan kunnen de bijbehorende documenten worden gedownload op basis van de verzoekreferenties die via stap 1 zijn opgehaald. Deze verzoekreferenties bestaan uit twee onderdelen:
- Een sectie met metadata behorend bij het document.
- Een downloadlink voor het document.
[1] Het publiceerbare PDF-bestand bevat niet alle informatie in het verzoek; persoonsgegevens, en privacygevoelige en vertrouwelijke gegevens zijn daaruit weggelaten. Het bestand is bedoeld voor directe publicatie naar de buitenwereld. Om die reden wordt een publiceerbare PDF niet meegeleverd als het verzoek 'Verken uw idee' of 'SDG-verzoek' betreft. Het bestand is uitdrukkelijk ook niet bedoeld als basis voor de behandeling van een verzoek omdat niet alle daarvoor benodigde informatie in het bestand aanwezig is.
Ondersteuning van meerdere STAM-versies
Het verzoek in XML-formaat (verzoekbericht) kan in meerdere versies van STAM worden opgevraagd. Momenteel worden versies 3, 4 en 5 van STAM ondersteund. Een specifieke versie kan worden opgevraagd door het meegeven van een Accept-header. De afnemer geeft in de header bij het aanroepen van de service waarmee het verzoekbericht wordt gedownload het gewenste versienummer van STAM aan, bijvoorbeeld:
Accept: application/xml;stam=5
In dit voorbeeld wordt er een verzoekbericht geretourneerd volgens STAM versie 5. Er kan alleen een major versienummer worden opgegeven. De service levert de meest recente minor version en patch level binnen die versie. Wanneer geen gewenste STAM-versie wordt opgegeven dan zal het verzoekbericht worden opgemaakt volgens de oudst beschikbare major versie van STAM.
Mocht de gevraagde STAM-versie niet kunnen worden geleverd dan retourneert de service een foutmelding (406, not acceptable) met een response header ('acceptable') die aangeeft welke versies wél kunnen worden geleverd.
Wijzigen bevoegd gezag
Het bevoegd gezag dat het verzoek ontvangen heeft kan gewijzigd worden door het ontvangend bevoegd gezag, als deze van mening is niet het juiste bestuursorgaan te zijn om het verzoek te behandelen. Het verzoek wordt dan afgeleverd bij het correcte bevoegd gezag. Hiervoor moet het OIN van het nieuwe bevoegd gezag opgegeven worden.
Het bevoegd gezag kan alleen gewijzigd worden door het bevoegd gezag aan wie het verzoek is gericht, of door de behandeldienst die door het bevoegd gezag is ingesteld. Het is niet mogelijk de behandeldienst behorend bij een verzoek te wijzigen. Wel bepaalt de service of het nieuwe bevoegd gezag een behandeldienst heeft ingesteld (met uitzondering van de situatie dat het verzoek 'Verken uw idee' betreft, omdat behandeldiensten daar geen rol spelen). Als dit het geval is, dan wordt de verzoeknotificatie ook bij de nieuwe behandeldienst afgeleverd. Na het wijzigen van het bevoegd gezag heeft het oude bevoegde gezag en haar eventuele behandeldienst geen toegang meer tot het verzoek.
Instellen bevoegd gezag en behandeldienst voor een ontvangen verzoek
Deze service maakt het mogelijk om bevoegd gezag en behandeldienst in te stellen, waarbij er geen automatische afleiding van de behandeldienst plaats vindt. Het verzoek wordt dan afgeleverd bij het opgegeven bevoegd gezag (verplicht op te geven) en bij de opgegeven behandeldienst (niet verplicht op te geven). Als er geen behandeldienst wordt opgegeven dan is er dus voor het vervolg van de behandeling van het verzoek géén behandeldienst. De service kan alleen worden gebruikt door het bevoegd gezag, of door de behandeldienst die eerder de verzoeknotificatie hebben ontvangen. In geval het 'Verken uw idee' betreft dan is het alleen mogelijk het bevoegd gezag te wijzigen in een bevoegd gezag dat 'Verken uw idee' ondersteunt. Ook kan er dan een behandeldienst worden ingesteld, met als randvoorwaarde dat de ingestelde behandeldienst versie 5 of hoger van de verzoeknotificatie ondersteunt.
Verwijderen verzoek
Nadat een bevoegd gezag een verzoek met bijbehorende bijlagen succesvol heeft opgehaald, en eventueel een samenwerking is gestart op basis van dit verzoek, is het de bedoeling dat deze het verzoek verwijdert uit de DSO-LV opslagvoorziening. Dan kan met behulp van de service 'Verwijderen verzoek'. De service wordt aangeroepen met het verzoeknummer als parameter.
Een verzoek kan alleen verwijderd worden door het bevoegd gezag aan wie het verzoek is gericht, of door de behandeldienst die door het bevoegd gezag is ingesteld. Nadat een verzoek is verwijderd is herstel ervan niet meer mogelijk. Aanvullen blijft wel mogelijk omdat bij een aanvulling altijd het gehele verzoek wordt ingediend. Als een aanvulling wordt ingediend wordt de werkmap opnieuw aangemaakt.
Als een verzoek een jaar na de indieningsdatum, of een jaar na de laatste aanvulling op het verzoek, nog niet door bevoegd gezag of behandeldienst is verwijderd dan wordt het verzoek automatisch verwijderd. Bevoegd gezag/behandeldienst ontvangt hierover geen bericht.
Zoeken ingediende verzoeken
Voor de behandeling van een verzoek kan het relevant zijn om te weten welke verzoeken eerder zijn ingediend op dezelfde locatie. Informatie over verzoeken kan worden opgevraagd met de service 'Zoeken ingediende verzoeken'. De service toont ingediende verzoeken op basis van een locatie. De locatie kan direct als geometrie worden opgegeven of via een verzoeknummer. Het systeem gebruikt dan de locatie die hoort bij dat verzoeknummer.
Aanvullende selectiecriteria (optioneel) zijn:
- (sub)activiteit die benoemd wordt in het gevonden verzoek; en/of
- de tijdsperiode waarbinnen de indiendatum van het gevonden verzoek valt.
De service levert als resultaat een lijst met beknopte gegevens van de gevonden verzoeken, zoals:
- het verzoeknummer;
- type verzoek;
- doel verzoek;
- indiendatum;
- projectlocatie en activiteit(en);
- het behandelende bevoegd gezag; en eventueel
- de behandeldienst
Als aanvullende informatie uit een bepaald verzoek nodig is, dan moet contact worden opgenomen met het bevoegd gezag of de behandeldienst dat het betreffende verzoek in behandeling heeft.
De service levert geen informatie over verzoeken die 'Verken uw idee' betreffen omdat deze informatie mogelijk gevoelig is, en bovendien niet van invloed zijn op de behandeling van eerder ingediende verzoeken op dezelfde locatie.
N.B. Merk op dat deze service op termijn zal worden verplaatst naar een andere API!
Documentatie
Standaard en informatiemodel
Op deze pagina zijn ook de bij deze standaard horende XSD-bestanden te vinden.
Delen
Status
Versie 2 en 3 zijn beschikbaar in de pre-productieomgeving en productieomgeving.
Versie 2 is beschikbaar tot december 2024.
API specificaties
Meer informatie
Deze service is van belang in het proces vergunningaanvragen en meldingen ontvangen.
PKIoverheid-certificaat
Deze service kan alleen worden gebruikt met een PKIoverheid-certificaat.
Feedback
Ga naar het forum om je bevindingen te delen.