/
User Service API

User Service API

 

 

De Swagger van de User Service API vind u hier:

acceptatie omgeving: https://services-acc.mijnaansluiting.nl/services/user/swagger/index.html

productie omgeving: https://services.mijnaansluiting.nl/services/user/swagger/index.html

Inleiding

De UserService 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 klantgegevens 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.

Via de REST-services wordt het user-proces voor de deelnemer in 2 stappen gedaan. Eerst wordt de betreffende aanvraag opgezocht via de aanvraagservice. Op basis van het aanvraagId in de betreffende aanvraag kan de user informatie worden opgevraagd.

Handleiding

1. GET /aanvraag/{aanvraagId}/aanvrager

Beschrijving: Dit endpoint wordt gebruikt om de aanvrager van een aanvraag op te halen.

Doel: Verkrijgen van gegevens van de aanvrager.

 

Headers

Header Name

Verplicht

Type

Beschrijving

Authorization

Ja

String

JWT Bearer token voor authenticatie

Content-Type

Ja

String

application/json

Request

Bij het opvragen van een lijst van aanvragen met de GET /aanvraag/{aanvraagid}/aanvrager 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 GET\ -H "Authorization: Bearer [[accessToken]]"\ -H "Accept: application/json"\ -H "Content-Type: application/json"\ "//aanvraag/{aanvraagId}/aanvrager"

 Response

Succes (200 OK)

{ "isProfessioneel": true, "relatieGegevens": { "isBedrijf": true, "bedrijfsgegevens": { "bedrijfsnaam": "string", "contactPersoon": { "aanhef": "string", "achternaam": "string", "tussenvoegsels": "string", "voorletters": "string" } }, "persoonsgegevens": { "aanhef": "string", "achternaam": "string", "tussenvoegsels": "string", "voorletters": "string" }, "emailadres": "string", "faxnummer": "string", "telefoonnummer": "string", "telefoonnummerMobiel": "string" } }

Additionele informatie

De hier beschreven functionaliteit biedt een endpoint om informatie over een specifieke aanvrager in een aanvraagtraject op te halen. Met de aanroep GET /aanvraag/{aanvraagId}/aanvrager kan men de bijbehorende aanvragergegevens opvragen, mits de juiste aanvraagId beschikbaar is. Hierbij fungeert de padparameter aanvraagId als een essentieel en verplicht attribuut. Zonder deze parameter is het niet mogelijk om de gevraagde aanvrager te identificeren, aangezien het systeem aan de hand van deze numerieke sleutel bepaalt welke gegevens moeten worden geretourneerd.

Wanneer de aanvraag met het opgegeven identificatienummer in de achterliggende database of service bekend is, ontvangt de gebruiker een response met de statuscode 200 (OK). Deze succesvolle respons bevat een JSON-object van het type Aanvrager, waarin onder meer inzicht kan worden verkregen in de aard van de aanvrager (professioneel dan wel particulier) en diens relatiegegevens. De JSON-structuur is zo ontworpen dat de aanvragerinformatie gestructureerd en overzichtelijk wordt getoond, wat de consistentie en eenduidigheid in gegevensverwerking bevordert.

Indien de betreffende aanvraag 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 aanvraagnummer is onjuist, ofwel de gevraagde informatie is niet langer beschikbaar in het systeem.

 

2. GET /aanvraag/{aanvraagId}/contactpersoon-uitvoering

Korte beschrijving: Dit endpoint wordt gebruikt om de contactpersoon in uitvoering van een aanvraag op te halen.

Doel: Het verkrijgen van de gegevens van de contactpersoon van de uitvoering.

 

Query Parameters

Headers

Header Name

Verplicht

Type

Beschrijving

Authorization

Ja

String

JWT Bearer token voor authenticatie

Content-Type

Nee

String

application/json

Response

Succes (200 OK)

{ "naam": "string", "emailAdres": "string", "telefoonnummerMobiel": "string", "contactKenmerk": "ContactpersoonUitvoering" }

codevoorbeeld (curl)

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

 

3. HTTP return status codes

Statuscode

Betekenis

Beschrijving

200

OK

Het verzoek is geslaagd.

201

Created

Het verzoek is geslaagd en er is een nieuwe resource aangemaakt.

204

No Content

Het verzoek is geslaagd, maar er is geen inhoud om terug te sturen.

400

Bad Request

De server kon het verzoek niet begrijpen vanwege een onjuiste syntax.

401

Unauthorized

Authenticatie is vereist en is mislukt of nog niet verstrekt.

403

Forbidden

De server begrijpt het verzoek, maar weigert het uit te voeren.

404

Not Found

De gevraagde resource kon niet worden gevonden op de server.

500

Internal Server Error

De server heeft een fout gemaakt en kon het verzoek niet voltooien.

502

Bad Gateway

De server ontving een ongeldige reactie van de upstream-server.

503

Service Unavailable

De server is momenteel niet beschikbaar (door overbelasting of onderhoud).

 

Inhoudsopgave