Page Comparison

Inleiding

De OfferteService 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 offerteproces

Handleiding

Met deze methode kunnen gebruikers een offerte item aanmaken. De waarden in de response kunnen worden gebruikt om het offertebestand te uploaden

Het /offerte endpoint met de POST -methode biedt de functionaliteit om een offerte item aan te maken Beschrijving: Dit endpoint wordt gebruikt om een nieuwe offerte aan te maken. De offerte bevat een PDF-bestand en bijbehorende metadata.

Doel: Creëer een nieuwe offerte item voor een aantal aansluitingen bij een een aanvraag.

sequenceDiagram
    participant client
    participant auth
    participant gateway
    participant offerte service
    participant blob storage
    participant event broker

    client->>auth: authenticatie
    auth->>client: token

    client->>offerte service: payload + (token)
    offerte service ->> client: OK + response

Bij het aanmaken van een offerteitem met de POST /offerte methode, hoeven geen queryparameters worden meegegeven.

curl -X 'POST' \
  'https://[environment].mijnaansluiting.nl/services/offerte/offerte' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' 

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

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

sequenceDiagram
    participant client
    participant auth
    participant gateway
    participant aanvraag service
    participant event broker

    client->>auth: authenticatie
    auth->>client: token

    client->>aanvraag service: request + aanvraagid +  (token)
    aanvraag service ->> client: aanvraag

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

1. offerteId (string): De Id van de op te halen offerte.

codevoorbeeld (curl):

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

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

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

sequenceDiagram
    participant client
    participant auth
    participant gateway
    participant aanvraag service
    participant event broker

    client->>auth: authenticatie
    auth->>client: token

    client->>aanvraag service: patch + aanvraagid + jsonbody + (token)
    aanvraag service ->> client: ok

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

1. offerteId (string): De Id van de offerte.

codevoorbeeld (curl):

Headers

Request Body

codevoorbeeld (curl)

curl -X POST https://services-acc.mijnaansluiting.nl/services/offerte \
-H "Authorization: Bearer {JWT_Token}" \
-H "Content-Type: application/json" \
-d '{
  "aanvraagId": {aanvraagId},
  "offerteReferentie": "{offerteReferentie}",
  "organisatieCode": "{organisatieCode}",
  "disciplineIDs": [{disciplineID1}, {disciplineID2}],
  "omschrijving": "{omschrijving}",
  "automatischAanvraagAfronden": {true/false},
  "vervalDatum": "{vervalDatum}",
  "bestandsnaam": "{bestandsnaam}",
  "mimeType": "{mimeType}"
}'

Korte beschrijving: Dit endpoint wordt gebruikt om een lijst van offertes op te halen die voldoen aan de opgegeven zoekcriteria.

Doel: Het zoeken en filteren van offertes op basis van verschillende parameters, zoals aanvraag-ID, referentie, processtatus en datum.

sequenceDiagram
    participant client
    participant auth
    participant gateway
    participant offerte service
    participant blob storage
    participant event broker

    client->>auth: authenticatie
    auth->>client: token

    client->>offerte service: payload + (token)
    offerte service ->> client: OK + response

Query Parameters

Headers

Response

Succes (200 OK)

{
  "count": {aantal},
  "skip": {skip},
  "take": {take},
  "items": [
    {
      "offerteReferentie": "{offerteReferentie}",
      "organisatieCode": "{organisatieCode}",
      "aanvraagID": {aanvraagId},
      "disciplineIDs": [{disciplineID1}, {disciplineID2}],
      "url": "{url}",
      "omschrijving": "{omschrijving}",
      "inkoopNummer": "{inkoopNummer}",
      "automatischAanvraagAfronden": {true/false},
      "bestandsnaam": "{bestandsnaam}",
      "mimeType": "{mimeType}",
      "aanmaakDatum": "{aanmaakDatum}",
      "vervalDatum": "{vervalDatum}",
      "wijzigingsDatum": "{wijzigingsDatum}"
    }
  ]
}

codevoorbeeld (curl)

curl -X GET https://services-acc.mijnaansluiting.nl/services/offerte \
-H "Authorization: Bearer {JWT_Token}" \
-G \
--data-urlencode "offerteReferentie={offerteReferentie}" \
--data-urlencode "aanvraagId={aanvraagId}" \
--data-urlencode "procesStatus={procesStatus}" \
--data-urlencode "beginAanmaakDatum={beginAanmaakDatum}" \
--data-urlencode "eindAanmaakDatum={eindAanmaakDatum}" \
--data-urlencode "beginWijzigingsDatum={beginWijzigingsDatum}" \
--data-urlencode "eindWijzigingsDatum={eindWijzigingsDatum}" \
--data-urlencode "beginVervalDatum={beginVervalDatum}" \
--data-urlencode "eindVervalDatum={eindVervalDatum}" \
--data-urlencode "skip={skip}" \
--data-urlencode "take={take}"

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

Het /offerte endpoint met {offerteId} met de PATCH-methode biedt de functionaliteit om de status van aansluitingen in een een offerte te wijzigen. Korte beschrijving Deze endpoint wordt gebruikt om een offertebestand te uploaden voor een specifieke aanvraag-ID en offertereferentie.

Doel Het uploaden van een offertebestand gekoppeld aan een bestaande aanvraag en referentie. Dit bestand kan bijvoorbeeld een PDF-document van de offerte zijn

sequenceDiagram
    participant client
    participant auth
    participant gateway
    participant aanvraagofferte service
    participant blob storage
    participant event broker

    client->>auth: authenticatie
    auth->>client: token

  

client->>aanvraag service: patch + aanvraagid + jsonbodyclient->>offerte service: payload + (token)
    aanvraagofferte service ->> client: ok

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

1. offerteId (string): De Id van de offerte.

Uitleg over het bijwerken van aanvragen met PATCH /offerte/{offerteId}

Bij het bijwerken van een offerte met de PATCH /offerte/{offerteId} methode, kunnen verschillende niveaus van specificatie worden gebruikt om te bepalen welke onderdelen van de offerte 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 offerte 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 offerte, afhankelijk van de verstrekte parameters in de body van het verzoek.

 OK + response

URL-Parameters

Headers

Request Parameters

Request Body

codevoorbeeld (curl)

curl -X PATCH\ 
-H "Authorization: Bearer [[accessToken]]"\ 
POST https://services-acc.mijnaansluiting.nl/services/offerte/{aanvraagId}/referentie/{offerteReferentie} \
-H "AcceptAuthorization: application/json"\  Bearer {JWT_Token}" \
-H "Content-Type: applicationmultipart/jsonform-data" \
-F "//offerte/{offerteId}/bulk"

file=@{pad_naar_bestand}" \
--form "netbeheerderCode={netbeheerderCode}" \
--form "id={documentId}" \
--form "collectionId={collectionId}"

Korte beschrijving Deze endpoint wordt gebruikt om de details van een specifieke offerte op te halen op basis van de aanvraag-ID en offertereferentie.

Doel: Het verkrijgen van gedetailleerde informatie over een offerte die gekoppeld is aan een specifieke aanvraag-ID en referentie.

sequenceDiagram
    participant client
    participant auth
    participant gateway
    participant aanvraag service
    participant event broker

    client->>auth: authenticatie
    auth->>client: token

    client->>aanvraag service: get + aanvraagid + (token)
   
aanvraag
service ->> client: jsondocument

Bij het opvragen van een intake met de GET /offerte/{offerteid}/intake methode, kunnen de volgende url-parameters worden gebruikt om de resultaten te filteren en te pagineren:

1. offerteId (string): De Id van de offerte.

codevoorbeeld (curl):

curl -X GET\ 
-H "Authorization: Bearer [[accessToken]]"\ 
-H "Accept: application/json"\ 
-H "Content-Type: application/json"\ "//offerte/{offerteId}/intake"

Met deze methode kunnen netbeheerders antwoorden op intakevragen indienen voor een specifieke offerte. Het offerte-ID moet in de URL worden gespecificeerd, en de antwoorden worden in de body van het verzoek doorgegeven.

sequenceDiagram
    participant client
    participant auth
    participant gateway
    participant aanvraag service
    participant event broker

    client->>auth: authenticatie
    auth->>client: token

    client->>aanvraag service: POST + aanvraagid + jsondocument + (token)
    aanvraag service ->> client: ok

Bij het opvragen van een intake met de POST /offerte/{offerteid}/intake methode, kunnen de volgende url-parameters worden gebruikt om de resultaten te filteren en te pagineren:

1. offerteId (string): De Id van de offerte.

codevoorbeeld (curl):

curl -X POST\  client->>aanvraag service: patch + aanvraagid + jsonbody + (token)
    aanvraag service ->> client: ok

URL-Parameters

Headers

response:

Succes (200 OK):

{
  "offerteReferentie": "{offerteReferentie}",
  "organisatieCode": "{organisatieCode}",
  "aanvraagID": {aanvraagId},
  "disciplineIDs": [{disciplineID1}, {disciplineID2}],
  "url": "{url}",
  "omschrijving": "{omschrijving}",
  "inkoopNummer": "{inkoopNummer}",
  "automatischAanvraagAfronden": {true/false},
  "bestandsnaam": "{bestandsnaam}",
  "mimeType": "{mimeType}",
  "aanmaakDatum": "{aanmaakDatum}",
  "vervalDatum": "{vervalDatum}",
  "wijzigingsDatum": "{wijzigingsDatum}"
}

codevoorbeeld (curl):

curl -X GET https://services-acc.mijnaansluiting.nl/services/offerte/{aanvraagId}/referentie/{offerteReferentie} \
-H "Authorization: Bearer [[accessToken]]"\ 
-H "Accept: application/json"\ 
-H "Content-Type: application/json"\ "//offerte/{offerteId}/intake"

Deze methode stelt gebruikers in staat om de aansluit-gereed data voor een specifieke offerte op te halen. Het offerte-ID moet in de URL worden gespecificeerd om de juiste gegevens te retourneren.

sequenceDiagram
    participant client
    participant auth
    participant gateway
    participant aanvraag service
    participant event broker

    client->>auth: authenticatie
    auth->>client: token

    client->>aanvraag service: GET+ aanvraagid + (token)
    aanvraag service ->> client: jsondocument 

Bij het opvragen van een intake met de GET /offerte/{offerteId}/aansluit-gereed-datum methode, kunnen de volgende url-parameters worden gebruikt om de resultaten te filteren en te pagineren:

1. offerteId (string): De Id van de offerte.

codevoorbeeld (curl):

curl -X GET\ 
-H "Authorization: Bearer [[accessToken]]"\ 
-H "Accept: application/json"\ 
-H "Content-Type: application/json"\ "//offerte/{offerteId}/aansluit-gereed-datum{JWT_Token}"

Korte beschrijving Deze endpoint wordt gebruikt om de details van een specifieke offerte op te halen op basis van de aanvraag-ID.

Doel Het verkrijgen van gedetailleerde informatie over een offerte die gekoppeld is aan een specifieke aanvraag-ID.

Parameters

URL-Parameters

Headers

Respons:

{
  "offerteReferentie": "{offerteReferentie}",
  "organisatieCode": "{organisatieCode}",
  "aanvraagID": {aanvraagId},
  "disciplineIDs": [{disciplineID1}, {disciplineID2}],
  "url": "{url}",
  "omschrijving": "{omschrijving}",
  "inkoopNummer": "{inkoopNummer}",
  "automatischAanvraagAfronden": {true/false},
  "bestandsnaam": "{bestandsnaam}",
  "mimeType": "{mimeType}",
  "aanmaakDatum": "{aanmaakDatum}",
  "vervalDatum": "{vervalDatum}",
  "wijzigingsDatum": "{wijzigingsDatum}"
}

Voorbeeld cURL-aanvraag

curl -X GET https://services-acc.mijnaansluiting.nl/services/offerte/{aanvraagId} \
-H "Authorization: Bearer {JWT_Token}"