Aanvraag Service API

De AanvraagService, een cruciaal onderdeel van het http://Mijnaansluiting.nl platform, is ontworpen met een sterke nadruk op gebruiksvriendelijkheid. Deze service stelt gebruikers in staat om hun aanvragen snel en efficiënt in te dienen en te beheren.

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.

Met deze methode kunnen gebruikers een lijst van aanvragen opvragen. De resultaten kunnen worden gefilterd op basis van status, ingediend vanaf en ingediend tot, en paginering kan worden toegepast.

Het /aanvraag endpoint met de GET-methode biedt de functionaliteit om een gefilterde lijst van aanvraag items op te halen.

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

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

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

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

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

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

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//aanvraag?status=&submittedFrom=&submittedTo=&skip=&take="

Deze methode stelt gebruikers in staat om een specifieke aanvraag bij te werken. Het aanvraag-ID moet in de URL worden gespecificeerd, en de wijzigingen worden doorgegeven in de body van het verzoek.

Het /aanvraag endpoint met {aanvraagId} met de GET-methode biedt de functionaliteit om een aanvraag op te halen.

Bij het opvragen van een lijst van aanvragen met de GET /aanvraag/{aanvraagid} methode, kunnen de volgende urlparameters worden gebruikt om de resultaten te filteren en te pagineren:

1. aanvraagId (string): De Id van de op te halen aanvraag.

codevoorbeeld (curl):

curl -X PATCH\ -H "Authorization: Bearer [[accessToken]]"\ 
-H "Accept: application/json"\ 
-H "Content-Type: application/json"\ 
"//aanvraag/{aanvraagId}"

Deze methode stelt gebruikers in staat om de statussen van een aansluiting in een specifieke aanvraag bij te werken. Het aanvraag-ID moet in de URL worden gespecificeerd, en de wijzigingen worden doorgegeven in de body van het verzoek.

Het /aanvraag endpoint met {aanvraagId} met de PATCH-methode biedt de functionaliteit om de status van een aansluiting in een een aanvraag te wijzigen.

Bij het aanpassen van een aanvraag met de PATCH /aanvraag/{aanvraagid} methode, kunnen de volgende url-parameters worden gebruikt om de resultaten te filteren en te pagineren:

1. aanvraagId (string): De Id van de aanvraag.

codevoorbeeld (curl):

curl -X PATCH\ -H "Authorization: Bearer [[accessToken]]"\ 
-H "Accept: application/json"\ 
-H "Content-Type: application/json"\ 
"//aanvraag/{aanvraagId}/bulk"

Deze methode stelt gebruikers in staat om de statussen vaan aansluitingen een specifieke aanvraag bij te werken. Het aanvraag-ID moet in de URL worden gespecificeerd, en de wijzigingen worden doorgegeven in de body van het verzoek.

Het /aanvraag endpoint met {aanvraagId} met de PATCH-methode biedt de functionaliteit om de status van aansluitingen in een een aanvraag te wijzigen.

Bij het aanpassen van een aanvraag met de PATCH /aanvraag/{aanvraagid} methode, kunnen de volgende url-parameters worden gebruikt om de resultaten te filteren en te pagineren:

1. aanvraagId (string): De Id van de aanvraag.

Uitleg over het bijwerken van aanvragen met PATCH /aanvraag/{aanvraagId}

Bij het bijwerken van een aanvraag met de PATCH /aanvraag/{aanvraagId} methode, kunnen verschillende niveaus van specificatie worden gebruikt om te bepalen welke onderdelen van de aanvraag worden bijgewerkt. Hieronder volgt een gedetailleerde uitleg van de mogelijke scenario's:

1. Specificeer disciplineId's in de body:

   • Als een of meerdere disciplineId's in de body van het verzoek worden gespecificeerd, worden alleen de betreffende disciplineId's bijgewerkt.

2. Specificeer objectId's maar geen disciplineId's in de body:

   • Als een of meerdere objectId's worden gespecificeerd, maar niet de onderliggende disciplineId's, worden alle onderliggende disciplineId's van die objectId's bijgewerkt.

3. Geen objectId's of disciplineId's gespecificeerd in de body:

   • Als er geen objectId's of disciplineId's in de body worden gespecificeerd, worden alle onderliggende disciplineId's van de gehele aanvraag bijgewerkt.

4. Het betreft ALTIJD alleen de disciplineId’s van de betreffende netbeheerder.

5. Combinaties van bovenstaande scenario's zijn mogelijk in 1 verzoek.

Deze flexibiliteit in specificatie maakt het mogelijk om gerichte updates uit te voeren op verschillende niveaus van de aanvraag, afhankelijk van de verstrekte parameters in de body van het verzoek.

codevoorbeeld (curl):

curl -X PATCH\ -H "Authorization: Bearer [[accessToken]]"\ 
-H "Accept: application/json"\ 
-H "Content-Type: application/json"\ "//aanvraag/{aanvraagId}/bulk"

HTTP return status codes