Beschrijving
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.