Prioriteitsverzoek Service API

Inleiding

De Prioriteitsverzoek Service is een cruciaal onderdeel van het http://Mijnaansluiting.nl platform, is ontworpen met een sterke nadruk op gebruiksvriendelijkheid. Deze service stelt gebruikers in staat om prioriteitsverzoeken snel en efficiënt op te vragen.

Transformatie naar REST-gebaseerde Service

De overgang naar een REST-gebaseerde service heeft aanzienlijke verbeteringen met zich meegebracht:

• Meer flexibiliteit en schaalbaarheid

• Betere compatibiliteit met moderne architecturen, middleware en netwerken

Deze verbeteringen hebben een directe positieve impact op de gebruikerservaring, verkorten de doorlooptijd van aanvragen en verhogen de algehele efficiëntie van netwerkbeheer. Door deze transitie kunnen gebruikers nu profiteren van een robuustere en toekomstbestendige infrastructuur, wat resulteert in een meer gestroomlijnd en betrouwbaar aanvraagproces.

Handleiding

Beschrijving: Dit endpoint wordt gebruikt om een bijlage op te halen die bij een prioriteitsverzoek hoort.

Headers

Request

Bij het opvragen van een bijlage met de GET /v1/prioriteitsverzoeken/{prioriteitsverzoekID}/bijlagen/{bijlageID} methode, moeten de volgende urlparameters worden gebruikt.

1. prioriteitsverzoekID (string): De Id van de prioriteitsverzoek.

2. bijlageID (string): De Id van de op te halen bijlage

codevoorbeeld (curl):

Additionele informatie

De hier beschreven functionaliteit biedt een endpoint om informatie over een specifieke bijlage van een prioriteitsverzoek op te halen.

Wanneer de bijlage met het opgegeven identificatienummer in de achterliggende database of service bekend is, ontvangt de gebruiker een response met de statuscode 200 (OK). Deze succesvolle response bevat een JSON-object van het type Bijlage. Dit bevat wat metadata van de bijlage en de url wat gebruikt kan worden om de bijlage te downloaden. Dit url bevat een SAS-token die 1 minuut geldig is.

Indien de betreffende bijlage niet bestaat of niet gevonden kan worden, retourneert de service een 404 (Not Found). Dit is een belangrijk signaal voor de aanroepende partij: ofwel het opgegeven combinatie van prioriteitsverzoekID en bijlageID is onjuist, ofwel de gevraagde informatie is niet langer beschikbaar in het systeem.

Korte beschrijving: Dit endpoint wordt gebruikt om een lijst van prioriteitsverzoeken op te halen. Het /v1/prioriteitsverzoeken endpoint met de GET-methode biedt de functionaliteit om een gefilterde lijst van prioriteitsverzoek items op te halen.

Bij het opvragen van een lijst van prioriteitsverzoeken met de GET /v1/prioriteitsverzoek methode, kunnen de volgende queryparameters worden gebruikt om de resultaten te filteren en te pagineren:

1. status (string): Filter de prioriteitsverzoeken op basis van hun status.

2. submittedFrom (string, date-time) (verplicht): Filter prioriteitsverzoeken die zijn ingediend vanaf een specifieke datum en tijd.

3. submittedTo (string, date-time) (verplicht): Filter prioriteitsverzoeken die zijn ingediend tot een specifieke datum en tijd.

4. _offset (integer, int32) (default: 100): Het aantal resultaten om over te slaan (voor paginering).

5. _limit (integer, int32) (default: 0): Het aantal resultaten om terug te geven (voor paginering).

Headers

codevoorbeeld (curl)

Additionele informatie

De hier beschreven functionaliteit biedt een endpoint om een lijst van prioriteitsverzoeken op te halen op basis van een filter waarbij de submittedFrom en submittedTo query parameters verplicht zijn.

De mogelijke statussen die gebruikt kunnen worden voor prioriteitsverzoeken zijn:

• Verzonden

• InBehandeling

• Afgewezen

• Toegekend

Indien er prioriteitsverzoeken gevonden kunnen worden op basis van de filters, ontvangt de gebruiker een response met statuscode 200 (OK). Deze succesvolle response bevat een JSON-object van het type PrioriteitsVerzoekIDPaginResponse. Hierbij geeft de total het aantal items aan die gevonden zijn op basis van de filters. data is een lijst van het type object PrioriteitsVerzoekID waarbij de maximale lengte gelijk is aan de opgegeven _limit parameter.

Beschrijving:

Dit endpoint wordt gebruikt om een lijst van prioriteitsverzoeken op te halen van een specifieke aanvraag.

Bij het opvragen van een lijst van aanvragen met de GET /v1/aanvragen/{id}/prioriteitsverzoek methode, moet de volgende urlparameters worden gebruikt:

1. id (string): De id van de aanvraag.

Headers

codevoorbeeld (curl)

Additionele informatie

De hier beschreven functionaliteit biedt een endpoint om een lijst van prioriteitsverzoeken op te halen van een de opgegeven aanvraag.

Indien er prioriteitsverzoeken gevonden kunnen worden ontvangt de gebruiker een response met statuscode 200 (OK). Deze succesvolle response bevat een JSON-object van het type PrioriteitsVerzoekIDPaginResponse. Hierbij geeft de total het aantal items aan die gevonden zijn. data is een lijst van het type object PrioriteitsVerzoekID waarbij de maximale lengte gelijk is aan de opgegeven _limit parameter.

Beschrijving: Dit endpoint wordt gebruikt om een prioriteitsverzoek op te halen.

Headers

Request

Bij het opvragen van een prioriteitsverzoek met de GET /v1/prioriteitsverzoeken/{id} methode, moeten de volgende urlparameters worden gebruikt.

1. id (string): De Id van de prioriteitsverzoek.

codevoorbeeld (curl):

Additionele informatie

De hier beschreven functionaliteit biedt een endpoint om informatie over een specifieke prioriteitsverzoek op te halen.

Wanneer de prioriteitsverzoek met het opgegeven identificatienummer in de achterliggende database of service bekend is, ontvangt de gebruiker een response met de statuscode 200 (OK). Deze succesvolle response bevat een JSON-object van het type PrioriteitsVerzoek.

Indien de betreffende prioriteitsverzoek niet bestaat of niet gevonden kan worden, retourneert de service een 404 (Not Found). Dit is een belangrijk signaal voor de aanroepende partij: ofwel het opgegeven prioriteitsverzoekID is onjuist, ofwel de gevraagde informatie is niet langer beschikbaar in het systeem.

Beschrijving: Dit endpoint wordt gebruikt om de status van een prioriteitsverzoek te wijzigen.

Headers

Request Body

Request

Bij het aanpassen van de status van een prioriteitverzoek met de PATCH /prioriteitsverzoek/{id} methode, moeten de volgende url-parameters worden gebruikt:

1. id (string): De Id van de prioriteitsverzoek.

codevoorbeeld (curl):

Additionele informatie

De hier beschreven functionaliteit biedt een endpoint om de status van een prioriteitsverzoek aan te passen.

Wanneer de status van de prioriteitsverzoek succesvol is gewijzigd krijgt de gebruiken een response met statuscode 204 (No Content).

Indien de betreffende prioriteitsverzoek niet bestaat of niet gevonden kan worden, retourneert de service een 404 (Not Found). Dit is een belangrijk signaal voor de aanroepende partij: ofwel het opgegeven prioriteitsverzoekID is onjuist, ofwel de gevraagde informatie is niet langer beschikbaar in het systeem.

De mogelijke statussen die gebruikt kunnen worden voor prioriteitsverzoeken zijn:

• InBehandeling

• Afgewezen

• Toegekend

Een status wijziging moet voldoen aan bepaalde criterias. Zo niet, dan krijgt de gebruiker een response met statuscode 422 (Unprocessible Entity). De criterias zijn als volgt:

1. Als de status wordt gewijzigd naar InBehandling, dan moeten de volgende properties leeg blijven:

• categorieToegekend

• redenCodeAfwijzingen

• redenAfwijzing

2. Als de status wordt gewijzigd naar Afgewezen, dan moeten de volgende properties leeg blijven

• categorieToegekend

• redenCodeAfwijzingen

• redenAfwijzing

3. Als de status wordt gewijzigd naar Toegekend, dan moeten de volgende properties leeg blijven

• redenCodeAfwijzingen

• redenAfwijzing

• categorieToegekend

Inhoudsopgave