Overslaan en naar de inhoud gaan
Naslagwerk

Toelichting en voorbeelden wsdl stuurGBAbericht

Vragen?

088 900 1000
Maandag - Vrijdag 08:30 - 17:00 uur
Zoeken in

Toelichting en voorbeelden wsdl stuurGBAbericht

 

    MEMO Toelichting en voorbeelden wsdl stuurGBAbericht


1.    Algemene beschrijving van de stuurGBABericht webserivce

De webservice verleent drie diensten: Controleren PL, Uitwisselen van LO berichten (sPoed) en test webservice (Echo),
Omdat verschillende diensten via een webservice (met 1 wsdl) worden geleverd, vertonen deze diensten op punten gelijk gedrag. Hieronder worden de belangrijkste overeenkomsten en verschillen beschreven.

Figuur 1 Algemene beschrijving

Image
figuur 1 algemene beschrijving


Functionele overeenkomsten zijn:

  • Alle diensten in stuurGBABericht draaien om de uitwisseling van 'GBA-berichten'.
  • Elke dienst voert een actie uit op een ontvangen bericht (verwerken, controleren etctera);
  • Elke dienst bestaat uit een of meer acties;
  • Elke actie heeft een vraag- en een antwoordbericht (request resp. response);
  • De gewenste actie wordt aangegeven in het vraagbericht in de body van het bericht.
  • Het resultaat van de gewenste actie wordt teruggegeven in een antwoordbericht in de body van het bericht

Overeenkomsten in de implementatie zijn:

  • StuurGBABericht maakt gebruik van TLS en HTTP basic authentication;
  • StuurGBABericht is een SOAP 1.1 webservice over HTTP;
  • De SOAP body van een vraagbericht bevat een <stuurGBABerichtRequest> als 'root';
  • Een vraagbericht bevat altijd het element <actie> met daarin de naam van de actie;
  • Een vraagbericht bevat afhankelijk van de gevraagde actie de elementen <gbabericht> <aanleiding> en <berichtnummer>;
  • Een antwoordbericht bevat in de body <stuurGBABerichtResponse> als root;
  • Een antwoordbericht bevat altijd het verplichte element <resultaatcode>. De invulling daarvan verschilt per actie;
  • Een antwoordbericht bevat altijd het element <referentie> met daarin de activiteit ID van de webservice actie;
  • Een activiteit ID is een getal van maximaal 12 posities.
  • Voor alle berichten geldt UTF-8 encodering;
  • Regelovergangen volgen de XML standaard (LF), zie http://www.w3.org/TR/REC- xml/#sec-line-ends;
  • Het GBA-bericht dat meegestuurd wordt, is geencodeerd in Teletex maar wel ingebed in Unicode. Zie ook de uitleg bij Voorbeeld Appendix A;
  • Gebruik van character entities in de berichtinhoud en uitsluiting van het gebruik van Form Feed;
  • Alle parameters (elementen en element-inhoud) zijn case sensitive;
  • De wsdl en xsd zijn opgenomen in Appendix B.

Gebruik van het SOAPAction HTTP request header veld

De WSDL voor stuurGBABericht specificeert geen SOAPAction HTTP header waarde. De SOAPAction header zelf is volgens de SOAP-specificatie echter wel verplicht. In een vraagbericht moet een SOAPAction zonder waarde mee worden geven. Wanneer een gevulde SOAPAction wordt aangeboden in de HTTP volgt een fout(bericht).

Verschillen tussen de diensten zijn:

•    Elk van de diensten vereist een andere autorisatie.
•    sPoed maakt gebruik van WS-Addressing, de overige diensten niet.
•    StuurGBABericht kan in de proefomgeving getest worden. Voor sPoed zal een aparte testomgeving worden ingericht. sPoed werkt immers de database van GBA-V bij.

De dienst sPoed volgt in grote lijnen de sPd operaties: zie LO GBA IV.5.2. In het overzicht hieronder zijn sPd-operaties afgezet tegen de acties in sPoed. Als geen actie aanwezig is nvt opgenomen of wordt een korte toelichting gegeven.

Tabel 1 sPd protocol invulling in de sPoed dienst

sPd-commando sPoed-webservice commando
LogonRequest Webservice authenticatie
LogonConfirmation Webservice authenticatie foutafhandeling
LogoffRequest nvt, impliciet na ontvangen webservice response-bericht
LogoffConfirmation nvt
PutMessage PutMessage
PutMessageConfirmation PutMessageConfirmation
GetMessage GetMessage
GetMessageResult GetMessageResult
GetMessageConfirmation GetMessageConfirmation
DeleteMessages nvt
DeleteMessagesConfirmation nvt
ListMessages ListMessages
ListMessagesResult ListMessagesResult
ListMessagesConfirmation ListMessagesConfirmation
SummarizeConfirmation nvt: fouten bij het retourneren van een geldig antwoord zijn altijd een 'technische fout'.
ChangePasswordRequest webservice change password
ChangePasswordConfirmation webservice change password
NoOperationConfirmation nvt

 

Figuur 2 Structuur van een stuurGBAbericht (vraag)

Image
Figuur 2 Structuur van een stuurGBAbericht (vraag)


Figuur 3 Structuur van een stuurGBAbericht (antwoord)
 


 

2.    Voorbeelden van de stuurGBABericht webserivce

1.    valideer_pl vraagbericht met Lg01 in CDATA sectie
 
Datum
14 juni 2019
 

 

① Het gbabericht bevat in dit geval een CDATA sectie met daarin het complete Lg01 bericht. De encodering van dit bericht is in Teletex ingebed in Unicode. Het gbabericht is een verplicht veld.
② De actie is valideer_pl (let op: kleine letters en _ (underscore)) en is verplicht.
③ De aanleiding is facultatief. In dit geval is 'kwaliteitscontrole' opgenomen.
④ berichtnummer is Lg01. Dit is het berichtnummer zoals vermeld in het Logisch Ontwerp GBA. Let hier ook weer op hoofd- en kleine letters. berichtnummer is verplicht.
 


 

2.    valideer_pl antwoord: BCM controle geslaagd: 1 of meer fouten gevonden
 
Datum
14 juni 2019
 

 

① Het antwoord op de vraag bevat een algemene resultaatcode voor de actie valideer_pl: pl_ok wanneer de validatie is doorlopen en er geen fouten/issues in de PL zijn ontdekt; pl_nok wanneer de validatie is doorlopen en er fouten/issues (1 of meer) zijn ontdekt of als de validatie niet succesvol is doorlopen. Als er fouten zijn ontdekt is er een sectie details met hierin voor elk van de issues een detail. Als de validatie niet succesvol is doorlopen is er een sectie details waarin een van de foutcodes is opgenomen (Zie LO GBA tabel C1 par C7.3.5).
② De toelichting bevat bij pl_ok en pl_nok een vermelding van de naam en de versie van het systeem dat is gebruikt om de PL te valideren. In dit voorbeeld: BCM v4.3. Wanneer de resultaatcode een andere (fout)code bevat, dan bevat toelichting een tekstuele toelichting op deze code.
 


 

③ Wanneer de validatie is doorlopen en er fouten/issues in de PL zijn geconstateerd, dan bevat details 1 of meer detail elementen met elk een code en omschrijving. Het element details is facultatief en kan wanneer geen details gevonden zijn afwezig zijn (bij pl_ok, of bij fouten waardoor geen validatie van de PL heeft plaats kunnen vinden).
④ De code komt overeen met de code uit de BCM sheet. De code is altijd aanwezig binnen detail.
⑤ De omschrijving komt overeen met de code uit de BCM sheet. Het meegeven van een omschrijving is niet verplicht.
⑥ De referentie bevat de activiteit ID en is primair bedoeld om bij vragen aan RvIG het verzonden bericht terug te vinden.
 
Datum
14 juni 2019
 


 

3.    valideer_pl antwoord: BCM controle geslaagd: geen fouten gevonden
 
Datum
14 juni 2019
 

 
 


 

4.    sPoed vraag: SummarizeMessages
 
Datum
14 juni 2019
 

 

① MessageID is aanwezig als leeg element. RelatesTo is niet van toepassing en niet verplicht volgens de WSDL, dus niet aanwezig (bij aanwezigheid wordt deze genegeerd).
② Vanwege de synchrone communicatie is de binding anoniem en is dit de standaard waarde.
③ Action is gevuld met de standaardwaarde "sPoed".
④ De actie is SummarizeMessages.
 


 

5.    sPoed antwoord: SummarizeResult (0 of meerdere GBA-berichten gevonden)
 
Datum
14 juni 2019
 

 

① De MessageID is aanwezig (verplicht element), maar bevat geen waarde.
② Vanwege de synchrone communicatie is de binding anoniem en is dit de standaard waarde.
③ Action is gevuld met de standaardwaarde "sPoed".
④ De resultaatcode is SummarizeResult bij het succesvol ophalen van een bericht (zoals beschreven in sPd protocol) en is case-sensitive.
⑤ code is het aantal GBA-berichten die klaar staan ter verzending. omschrijving is niet aanwezig.
⑥ referentie is gevuld met het GBA-V activiteit ID dat hoort bij de SummarizeMessages bevraging.
 


 

6.    sPoed vraag: ListMessages
 
Datum
14 juni 2019
 

 

① MessageID is aanwezig als leeg element. RelatesTo is niet van toepassing en niet verplicht volgens de WSDL, dus niet aanwezig (bij aanwezigheid wordt deze genegeerd).
② Vanwege de synchrone communicatie is de binding anoniem en is dit de standaard waarde.
③ Action is gevuld met de standaardwaarde "sPoed".
④ De actie is ListMessages voor het bevragen welke GBA-berichten opgehaald kunnen worden (zoals beschreven in sPd protocol en is case-sensitive).
 


 

7.    sPoed antwoord: ListMessagesResult (bij gevonden berichten)
 
Datum
14 juni 2019
 

 

① MessageID is aanwezig als leeg element. RelatesTo is niet van toepassing en niet verplicht volgens de WSDL, dus niet aanwezig (bij aanwezigheid wordt deze genegeerd).
② Vanwege de synchrone communicatie is de binding anoniem en is dit de standaard waarde.
③ Action is gevuld met de standaardwaarde "sPoed".
④ De resultaatcode is ListMessagesResult bij het succesvol ophalen van een bericht (zoals beschreven in sPd protocol en is case-sensitive).
⑤ code is het GBA-berichtID van het op te vragen GBA-bericht. Voor elk gevonden bericht wordt een detail opgenomen met in code het GBA-berichtID van het GBA-bericht.
⑥ referentie is gevuld met het activiteit ID dat hoort bij de ListMessages bevraging.
 


 

8.    sPoed antwoord: ListMessagesConfirmation (GEEN gevonden GBA-berichten)
 
Datum
14 juni 2019
 

 

① MessageID is aanwezig als leeg element. RelatesTo is niet van toepassing en niet verplicht volgens de WSDL, dus niet aanwezig (bij aanwezigheid wordt deze genegeerd).
② Vanwege de synchrone communicatie is de binding anoniem en is dit de standaard waarde.
③ Action is gevuld met de standaardwaarde "sPoed".
④ De resultaatcode is ListMessagesConfirmation (zoals beschreven in sPd protocol en is case- sensitive) bij geen gevonden bericht(en) ter verzending.
⑤ referentie is gevuld met het activiteit ID dat hoort bij de ListMessages bevraging.
 


 

9.    sPoed vraag: GetMessage
 
Datum
14 juni 2019
 

 

① MessageID is aanwezig als leeg element. RelatesTo is niet van toepassing en niet verplicht volgens de WSDL, dus niet aanwezig (bij aanwezigheid wordt deze genegeerd).
② Vanwege de synchrone communicatie is de binding anoniem en is dit de standaard- waarde.
③ Action is gevuld met de standaardwaarde sPoed.
④ De actie is GetMessage (zoals beschreven in sPd protocol en is case-sensitive) voor het ophalen van een bericht.
⑤ Het GBA-berichtID wordt in berichtnummer geplaatst.
 


 

10.    sPoed antwoord: GetMessageResult met daarin een GBA-bericht als dat bericht geen reactie is op een eerder bericht (eerste bericht in een GBA-berichtencyclus)
 
Datum
14 juni 2019
 

 

① MessageID is het GBA-berichtID, toegekend door het GBA-V systeem. RelatesTo is niet aanwezig omdat dit het eerste bericht is in de berichtencyclus.
② Vanwege de synchrone communicatie is de binding anoniem en is dit de standaard- waarde.
③ Action is gevuld met de standaardwaarde sPoed.
④ De resultaatcode is GetMessageResult (zoals beschreven in sPd protocol en is case- sensitive) bij het succesvol ophalen van een bericht.
⑤ gbabericht bevat het complete Lq01 bericht.
⑥ berichtnummer is in dit voorbeeld Lq01. Het is een berichtnummer zoals vermeld in het Logisch Ontwerp. Het berichtnummer is gelijk aan het berichtnummer genoemd in het werkelijke bericht in gbabericht.
⑦ referentie is gevuld met het activiteit ID dat hoort bij de GetMessage bevraging.
 


 

11.    sPoed antwoord: GetMessageResult met daarin een GBA-bericht als dat bericht een reactie is op een eerder bericht (vervolgbericht in een GBA-berichtencyclus)
 
Datum
14 juni 2019
 

 

① MessageID is het GBA-berichtID, toegekend door het GBA-V systeem.
② Vanwege de synchrone communicatie is de binding anoniem en is dit de standaard- waarde.
③ RelatesTo is gevuld met het MessageID van het bericht waar, in dit voorbeeld, de Pf01 in dit bericht het antwoord op is. De MessageID komt uit MessageID van bijvoorbeeld een PutMessage met een Lg01. De MessageID van dat bericht was in dit voorbeeld 23456.
④ Action is gevuld met de standaardwaarde sPoed.
⑤ De resultaatcode is GetMessageResult (zoals beschreven in sPd protocol en is case- sensitive) bij het
succesvol ophalen van een bericht.
⑥ gbabericht bevat het complete Pf01 bericht.
⑦ berichtnummer is Pf01. Dit is het berichtnummer zoals vermeld in het Logisch Ontwerp GBA-V. Let hier ook weer op hoofd- en kleine letters.
⑧ referentie is gevuld met het activiteit ID dat hoort bij de GetMessage bevraging.
 


 

12.    sPoed antwoord: GetMessageConfirmation (GBA-bericht niet gevonden)
 
Datum
14 juni 2019
 

 

① MessageID en RelatesTo zijn niet van toepassing: de GetMessageConfirmation bevat geen bericht.
② Vanwege de synchrone communicatie is de binding anoniem en is dit de standaard- waarde.
③ Action is gevuld met de standaardwaarde sPoed.
④ De resultaatcode is GetMessageConfirmation (zoals beschreven in sPd protocol en is case- sensitive) bij niet kunnen ophalen van een bericht.
⑤ referentie is gevuld met het activiteit ID dat hoort bij de GetMessage bevraging.
 


 

13.    sPoed vraag: PutMessage met La01 in CDATA sectie

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa= "http://www.w3.org/2005/08/addressing">
<soap:Header>
<wsa:MessageID>urn:brp:spd:messageid:394857345</wsa:MessageID> ①
<wsa:ReplyTo>http://www.w3.org/2005/08/addressing/anonymous</wsa:ReplyTo> ②
<wsa:To>http://www.w3.org/2005/08/addressing/anonymous</wsa:To> ②
<wsa:RelatesTo>urn:brp:spd:messageid:199886546579</wsa:RelatesTo> ③
<wsa:Action>sPoed</wsa:Action> ④
</soap:Header>
<soap:Body>
<stuurGBABerichtRequest  xmlns="http://www.rvig.nl/GBA/GBA-V/stuurGBABericht-v1.0">
<gbabericht>
<![CDATA[00000000La0120050518143000000808638040700000000000036101129011001080863804070 1200093016719280210008MAaÄika0240009VIulðovAa03100080000000003200040000033000400008310
006010300832000819941001040098230002PK04020051000400388230002PK040098230002PK04048051
000400018230002PK831000604000083200081994031004020051000400278230002PK070087010001008
078091000405181010001W1030008199005011110007V&Dweg11200025111600062712HW7210001A]]>
</gbabericht>⑤
<actie>PutMessage</actie>⑥
<berichtnummer>La01</berichtnummer>⑦
</stuurGBABerichtRequest>
</soap:Body>
</soap:Envelope>
 
Datum
14 juni 2019
 

① MessageID is gevuld met het ID van het, in dit voorbeeld La01, bericht.
② Vanwege de synchrone communicatie is de binding anoniem en is dit de standaard- waarde.
③ RelatesTo is in dit voorbeeld gevuld met het GBA-berichtID. Deze komt uit MessageID van het webservice bericht waarin het GBA vraagbericht (in dit geval Lq01) was opgenomen. In dit voorbeeld had dit sPoed antwoord: GetMessageResult met daarin het GBA-bericht (eerste bericht in de cyclus)
kunnen zijn.
④ Action is gevuld met de standaardwaarde sPoed.
⑤ gbabericht bevat in dit geval een CDATA sectie met daarin het complete La01 bericht. De encodering van het bericht in dit voorbeeld is Teletex ingebed in Unicode.
⑥ De actie is PutMessage (zoals beschreven in sPd protocol en is case-sensitive) voor het versturen van
een bericht.
 


 

⑦ berichtnummer is La01. Dit is het berichtnummer zoals vermeld in het Logisch Ontwerp GBA-V. Let hier ook weer op hoofd- en kleine letters. berichtnummer is verplicht bij de actie PutMessage en is overeenkomstig met het berichtnummer in het GBA-bericht.
 
Datum
14 juni 2019
 


 

14.    sPoed antwoord: PutMessageConfirmation (Bevestiging bericht is ontvangen).
 
Datum
14 juni 2019
 

 

① MessageID en RelatesTo zijn niet van toepassing: de PutMessageConfirmation bevat geen bericht.
② Vanwege de synchrone communicatie is de binding anoniem en is dit de standaard- waarde.
③ Action is gevuld met de standaardwaarde sPoed.
④ De resultaatcode is PutMessageConfirmation (zoals beschreven in sPd protocol en is case- sensitive) bij het succesvol plaatsen van een bericht.
⑤ referentie is gevuld met het activiteit ID dat hoort bij de PutMessage bevraging.
 


 

15.    actie ECHO: stuurGBABerichtRequest
 
Datum
14 juni 2019
 

 

① De vaste tekst GBA-BERICHT.
② De actie ECHO (let op: hoofdletters).
③ De aanleiding is een vrij in te vullen tekst in stuurGBABerichtRequest. De aanleiding wordt zonder verandering teruggestuurd in het antwoordbericht.
④ Het berichtnummer is een vrij in te vullen berichtnummer. Ook dit berichtnummer wordt onveranderd in het antwoord teruggestuurd.
 


 

16.    actie ECHO: Antwoord op bovenstaand bericht
 
Datum
14 juni 2019
 

 

① De resultaatcode van een valide ECHO stuurGBABerichtRequest is altijd OK (voorwaarde: er treedt geen technische fout op).
② De toelichting bij de resultaatcode is Echo Response.
③ In details worden de aanleiding, actie, het berichtnummer en het in de vraag meegestuurde bericht zoals gegeven in de vraag mee terug teruggestuurd.
④ <referentie> wordt standaard gevuld met de Activiteit-ID (ter referentie RvIG).
 


 

17.    Technische fout
 
Datum
14 juni 2019
 

 

De request kan om verschillende redenen worden afgekeurd. In bovenstaand voorbeeld gaat het om een technische fout. Andere mogelijkheden zijn:
•    Ongeldige combinatie gebruikersnaam / wachtwoord
•    Server is niet geactiveerd voor dit account
•    Wachtwoord verlopen
•    Geen actuele autorisatietabelregel
•    Ongeldige waarde voor parameter
Zie voor een opsomming van de foutcodes LO GBA tabel C1 par C7.3.5).
 


 


18.    SOAP fout opbouw
 
Datum
14 juni 2019
 

 
 


 

Appendix A: opbouw en tekst-encodering van <gbabericht>
Er zijn twee varianten van de inhoud van <gbabericht>: een met het bericht in een CDATA sectie en een met het GBA-bericht opgenomen als tekst in de XML. Van beide varianten volgt hieronder een voorbeeld.

element gbabericht met Lg01 in CDATA sectie
 
Datum
14 juni 2019
 

 

① Het gbabericht bevat in dit geval een CDATA sectie met daarin het complete Lg01 bericht. De encodering van dit bericht is in Teletex ingebed in Unicode. Het bericht is een verplicht veld.

Elk bericht dat wordt meegegeven in de XML is in Teletex gerepresenteerd door UTF-8 unicode. Om van het Teletex bericht te komen tot het juiste bericht in de XML worden de volgende stappen doorlopen:
1.    Teletex tekens worden geëncodeerd met Teletex bytes.
2.    Elke Teletex byte wordt gepresenteerd met (c.q. vervangen door) een Unicode teken op basis van de numerieke waarde.
3.    De resulterende Unicode tekens worden geëncodeerd en getransporteerd als UTF-8. Stap 3 is standaard voor webservices. Van belang zijn stap 1 en 2.

 


Datum
14 juni 2019

Je ziet dit terug in het eerder gegeven XML bericht hierboven.

Het is mogelijk de Lg01 als tekst met gewone markup mee te sturen in plaats van in een CDATA sectie. Let er hierbij op dat de volgende karakters vervangen worden door XML escape karakters (character/entities):

XML character entities


Strikt genomen hoeven alleen & en < vervangen te worden, maar het is goed gebruik al deze karakters te vervangen. Een Carriage Return komt in GBA-berichten zelden voor en is een speciaal geval. Een CR moet altijd worden opgenomen als &#13; en kan niet worden gebruikt in een CDATA sectie. De meest veelzijdige vorm van het versturen van een bericht, waarbij ook rekening wordt gehouden met Carriage Returns, is hiermee het meesturen van de PL als elementinhoud (zonder CDATA) en het escapen van alle hierboven genoemde karakters. Wanneer geen carriage return in het bericht staat is de eenvoudigste vorm die met de CDATA sectie (zonder character references).

Het Teletex karakter voor Form Feed (FF) kan niet worden gebruikt in deze webservice. Ook de character reference &#12; is niet toegestaan. Dit Teletex karakter wordt in de praktijk niet gebruikt en vormt dus geen praktische belemmering.

het element gbabericht met de Lg01 als tekst


In dit voorbeeld is de ampersand in de straatnaam V&D weg vervangen door &amp;.
 


 

Appendix B: WSDL en XSD

stuurGBABericht-v1.0.wsdl
 
Datum
14 juni 2019
 

 
 


Datum
14 juni 2019


Het element <wsaw:UsingAddressing wsdl:required="true" /> betekent dat WS-Addressing verplicht is. Het systeem bepaalt echter aan de hand van welke dienst gebruikt wordt of de WS-Addressing van toepassing is. Voor de Controleren PL en de ECHO
diensten is WS-Addressing NIET verplicht.
 


 


De inhoud van de berichten voldoet aan het volgende schema:
XSD voor stuurGBABerichtRequest en stuurGBABerichtResponse
 
Datum
14 juni 2019
 

 
 


 

type="xsd:string" minOccurs="0" maxOccurs="1" />
<xsd:element ref="details"
minOccurs="0" maxOccurs="1" />
<xsd:element name="gbabericht" type="gbaberichtType" minOccurs="0" maxOccurs="1" />
<xsd:element name="berichtnummer" type="xsd:string"
minOccurs="0" maxOccurs="1" />
<xsd:element name="referentie" type="xsd:string" minOccurs="0" maxOccurs="1" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="details" nillable="true">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="detail"
minOccurs="0" maxOccurs="unbounded" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="detail">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="code" type="xsd:string" minOccurs="1" maxOccurs="1" />
 
Datum
14 juni 2019
 


Datum
14 juni 2019
 

Delen

Naslagwerk

UC39 Doorvoeren correctie nummerregister

UC39 Doorvoeren correctie nummerregister

Inleiding


De use case “Doorvoeren correctie nummerregister” beschrijft de stappen voor het corrigeren van een record in het nummerregister. De beheerorganisatie BV BSN kan een correctie doorvoeren.

1    Hoofdscenario

1.1    Initiatie

1.1.1    Ontvang bericht “Doorvoeren correctie nummerregister”

De use case start met de ontvangst van het bericht “Doorvoeren correctie nummerregister”. In dit bericht staan de volgende gegevens:

Vraagbericht
Identificatie afzender
Berichtnummer afzender
Indicatie eindgebruiker
Nummer
Status
Instantie
Datum/tijd toekennen
Instantie opwaarderen
Datum/tijd opwaarderen
Instantie omhangen
Datum/tijd omhangen
Instantie uit verkeer halen
Datum/tijd uit verkeer halen
Registratie

1.1.2    Leg bericht “Doorvoeren correctie nummerregister” vast

Het BV BSN-berichtnummer wordt toegekend en het vraagbericht wordt vastgelegd in het berichtenlogboek. Zie use case “Leg bericht vast”.

1.1.3    Autoriseer verzoek

De autorisatie wordt aangevraagd en verleend. Zie use case “Autoriseer verzoek” (zie Alternatieve scenario 1).

1.2    Verwerking

1.2.1    Controleer bericht “Doorvoeren correctie nummerregister”

Het bericht moet voldoen aan de volgende eisen:

  •  De afzender moet gevuld zijn (zie Alternatieve scenario’s 2)
  •  Het berichtnummer van de afzender moet gevuld zijn (zie Alternatieve scenario’s 3)
  •  De indicatie eindgebruiker moet gevuld zijn (zie Alternatieve scenario’s 4)
  •  Het nummer moet gevuld zijn (zie Alternatieve scenario’s 5)
  •  De instantie moet gevuld zijn, indien de status ongelijk is aan “aangemaakt” (zie Alternatieve scenario’s 6)
  •  De status moet gevuld zijn (zie Alternatieve scenario’s 7)
  •  De registratie moet gevuld zijn (zie Alternatieve scenario’s 8)

1.2.2    Selecteer actuele gegevens uit het nummerregister

Het systeem selecteert op basis van het nummer de actuele nummergegevens uit het nummerregister (zie Alternatieve scenario’s 9).

1.2.3    Maak actuele nummergegevens historisch

De gevonden actuele nummergegevens worden historisch gemaakt (zie Alternatieve scenario’s 10).

1.2.4    Voer correctie nummergegevens door

De gegevens, zoals in het vraagbericht opgenomen, worden als nieuw voorkomen opgenomen in het nummerregister. Daarbij wordt de datum tijd van wijziging (met de systeemdatum-tijd) en het BV BSN berichtnummer van wijziging (zoals toegekend aan het vraagbericht) opgenomen. (Zie Alternatieve scenario’s 11).

1.3    Afronding

1.3.1    Stel antwoordbericht “Doorvoeren correctie nummerregister” samen

In onderstaande tabel wordt beschreven welke gegevens in het antwoordbericht zijn opgenomen.

Antwoordbericht
Berichtnummer afzender
BV BSN Berichtnummer
Berichtresultaatcode (39000)
Omschrijving berichtresultaat (“Verwerking bericht succesvol”)

1.3.2    Leg antwoordbericht “Doorvoeren correctie nummerregister” vast

Het antwoordbericht wordt vastgelegd in het berichtenlogboek. Zie use case “Leg bericht vast”.

1.3.3    Bied antwoordbericht “Doorvoeren correctie nummerregister” aan

Het antwoordbericht wordt aangeboden aan de afzender.

1.3.4    Vul het auditlog

Het systeem registreert in de auditlog het resultaat van alle bovenstaande stappen. De volgende gegevens worden hierbij vastgelegd (zie ook Alternatieve scenario´s 12):

Gegevens auditlog Toelichting
Huidige datum en tijd Systeemdatum-tijd
Identificatie afzender DN uit het certificaat
BV BSN-berichtnummer Het toegekende BV BSN berichtnummer
Berichtnummer afzender Overnemen uit vraagbericht
Indicatie eindgebruiker/instantie Overnemen uit vraagbericht
Uitgevoerde actie de stap die uitgevoerd is
Resultaat van de uitgevoerde actie Resultaat van de uitgevoerde stap
Resultaatcode Berichtresultaatcode uit het antwoordbericht

Wanneer alle stappen met succes zijn doorlopen, worden de voorkomens van de betreffende stappen in het auditlog verwijderd. Van het verwerkte bericht wordt één nieuw voorkomen aangemaakt met de volgende gegevens:

Gegevens auditlog Toelichting
Huidige datum en tijd Datum-tijd van de eerste stap van het auditlog van betreffende bericht
Identificatie afzender DN uit het certificaat
BV BSN-berichtnummer Het toegekende BV BSN berichtnummer
Berichtnummer afzender Overnemen uit vraagbericht
Indicatie eindgebruiker/instantie Overnemen uit vraagbericht
Uitgevoerde actie “Bericht verwerkt”
Resultaat van de uitgevoerde actie “Succesvol
Resultaatcode Berichtresultaatcode uit het antwoordbericht

2    Alternatieve Scenario’s

2.1    Alternatief 1: Autorisatie mislukt

Indien de autorisatie wordt geweigerd, wordt er een antwoordbericht aangemaakt en verstuurd naar de afzender van het bericht met daarin de melding “Afzender niet geautoriseerd” (berichtresultaat code 4).
Daarnaast wordt een melding in het systeemfoutenlogboek opgenomen. Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.2    Alternatief 2: Identificatie afzender in vraagbericht is niet gevuld

Indien het veld Identificatie afzender van het vraagbericht niet gevuld is, wordt de volgende foutmelding naar de afzender verstuurd ”De afzender van het bericht moet gevuld zijn” (berichtresultaat code 8). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.3    Alternatief 3: Berichtnummer afzender in vraagbericht is niet gevuld

Indien het veld berichtnummer afzender van het vraagbericht niet gevuld is, wordt de volgende foutmelding naar de afzender verstuurd ”Het berichtnummer van de afzender moet gevuld zijn” (berichtresultaat code 9). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.4    Alternatief 4: Indicatie eindgebruiker in vraagbericht is niet gevuld

Indien het veld indicatie eindgebruiker van het vraagbericht niet gevuld is, wordt de volgende foutmelding naar de afzender verstuurd ”De indicatie eindgebruiker van het bericht moet gevuld zijn” (berichtresultaat code 10). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.5    Alternatief 5: Vraagbericht bevat geen nummer

Indien er geen BSN is gevuld in het vraagbericht, wordt de volgende foutmelding naar de afzender verstuurd “BSN moet gevuld zijn” (berichtresultaatcode 39001). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.6    Alternatief 6: Instantie is niet gevuld en status ongelijk aan aangemaakt

Indien de instantie niet is gevuld en de status is ongelijk is aan “aangemaakt”, wordt de volgende foutmelding naar de afzender verstuurd “Instantie moet gevuld zijn” (berichtresultaatcode 39002). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.7    Alternatief 7: Status is niet gevuld

Indien de status niet is gevuld, wordt de volgende foutmelding naar de afzender verstuurd “De status moet gevuld zijn” (berichtresultaatcode 39003). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.8    Alternatief 8: Registratie is niet gevuld

Indien de registratie niet is gevuld, wordt de volgende foutmelding naar de afzender verstuurd “De registratie moet gevuld zijn” (berichtresultaatcode 39004). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.9    Alternatief 9: Nummergegevens niet gevonden

Indien er geen gegevens worden gevonden bij het opgegeven nummer, wordt de volgende foutmelding naar de afzender verstuurd “Nummergegevens niet gevonden” (berichtresultaatcode 39005). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.10    Alternatief 10: Fout bij het historisch maken van de nummergegevens

Indien er een fout optreedt bij het historisch maken van de nummergegevens, wordt de volgende foutmelding naar de afzender verstuurd “Er is een fout opgetreden” (berichtresultaatcode 2). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.
Daarnaast wordt er een melding in het systeemfoutenlogboek opgenomen.

2.11    Alternatief 11: Fout bij doorvoeren van de correctie in het nummerregister

Indien er een fout optreedt bij het doorvoeren van de correcte nummergegevens, wordt de volgende foutmelding naar de afzender verstuurd “Er is een fout opgetreden” (berichtresultaatcode 2). Alle mutaties, die als gevolg van het bericht reeds zijn doorgevoerd in het nummerregister worden ongedaan gemaakt.
Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen. Daarnaast wordt er een melding in het systeemfoutenlogboek opgenomen.

2.12    Alternatief 12: Fout bij vullen auditlog

Indien het auditlog niet gevuld kan worden, wordt een melding in het systeemfoutenlogboek opgenomen.
Aan de afzender van het bericht wordt de melding “Er is een fout opgetreden” (berichtresultaatcode 2) verstuurd.
Indien het tussenstappen betreft wordt direct verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.
Indien het de laatste stap betreft, zal wel de beheerorganisatie, maar niet de afzender hierover geïnformeerd worden.

3    Subprocessen

Niet van toepassing.

4    Belangrijke Scenario’s

Niet van toepassing.

5    Precondities

Niet van toepassing.

6    Postcondities

Niet van toepassing.

7    Extensies

Niet van toepassing.

8    Speciale eisen

Niet van toepassing.

9    Aanvullende Informatie

9.1    Activiteitendiagram
 

Delen

Naslagwerk

UC37 Verwerken Bulkvraag

UC37 Verwerken Bulkvraag

 

Inleiding

De use case “Verwerken bulkvraag” verwerkt de gestelde bulkvraag (zie BV BSN UC33) op een door het systeem bepaald moment. Hierna wordt het antwoord op de bulkvraag klaargezet, zodat dit kan worden opgehaald (zie BV BSN UC34).

1    Hoofdscenario

1.1    Initiatie

1.1.1    Start proces “verwerken bulkvraag”

De use case start met het verwerken van de bulkvraag, als het systeem heeft bepaald dat hiervoor ruimte is. Hierbij wordt de bulkvraag met de oudste datum het eerst verwerkt.

1.2    Verwerking

De volgende stappen worden voor iedere vraag in het bericht herhaald.

1.2.1    Controleer validiteit van de set van identificerende gegevens

Bij deze stap wordt gecontroleerd of de set van identificerende gegevens voldoet aan één van de volgende zoekpaden (Zie ook Alternatieve scenario´s 1):

Zoekpad 1 2
Voornamen O O
Voorvoegsels geslachtsnaam O O
Geslachtsnaam O V
Geboortedatum V V
Geboorteplaats O O
Geboorteland O O
Geslachtsaanduiding V V
Gemeente van inschrijving O O
Straatnaam O O
Huisnummer V O
Huisletter O O
Huisnummertoevoeging O O
Aanduiding bij huisnummer O O
Postcode V O
Locatiebeschrijving O O
Land vanwaar ingeschreven O O

“V” = verplichte velden

“O” = optioneel
Andere velden dan genoemd in de tabel mogen niet aanwezig zijn.

1.2.2    Bepaal meeneemlijst

Het zoekpad wordt als volgt gekozen:
•    Als de zoekvraag voldoet aan één van beide zoekpaden, dan wordt op basis van dit zoekpad gezocht.
•    Als de zoekvraag voldoet aan allebei de verplichte zoekpaden, dan wordt op basis van zoekpad 2 gezocht.

1.2.3    Haal gegevens op uit registraties

Er wordt in de betreffende registraties (GBA en RNI) gezocht met de identificerende gegevens uit de meeneemlijst. Eerst wordt gezocht met de meeneemlijst (het verplichte zoekpad) met per veld alle voor dat veld vastgestelde zoekmethoden (zie ook Alternatieve scenario’s 2).
De methode van zoeken is beschreven in het Functioneel Ontwerp van de beheercomponent van de betreffende registratie.

De volgende gegevens dienen opgehaald te worden:

Op te halen gegevens
BSN
Voornamen
Adellijke titel/predikaat
Voorvoegsels geslachtsnaam
Geslachtsnaam
Geboortedatum
Geboorteplaats
Geboorteland
Geslachtsaanduiding
Aanduiding gegevens in onderzoek persoon
Datum ingang onderzoek persoon
Datum einde onderzoek persoon
Datum overlijden
Aanduiding gegevens in onderzoek overlijden
Datum ingang onderzoek overlijden
Datum einde onderzoek overlijden
Omschrijving reden opschorting
Indicatie geheim
Gemeente van inschrijving
Functie adres
Gemeentedeel
Straatnaam
Huisnummer
Huisletter
Huisnummertoevoeging
Aanduiding bij huisnummer
Postcode
Op te halen gegevens
Woonplaatsnaam
Locatiebeschrijving
LandAdresBuitenland
DatumAanvangAdresBuitenland
Regel1AdresBuitenland
Regel2AdresBuitenland
Regel3AdresBuitenland
Land vanwaar ingeschreven
Aanduiding gegevens in onderzoek adres
Datum ingang onderzoek adres
Datum einde onderzoek adres

1.2.4    Controleer zoekresultaat

Het aantal resultaten wordt gecontroleerd:
•    Als er geen resultaten gevonden zijn, wordt dit teruggemeld aan de afzender (zie Alternatieve scenario’s 3).
•    Als er in totaal (GBA én RNI) meer dan één resultaat gevonden is, wordt de volgende zoekstap uitgevoerd. Hiervoor wordt het optionele veld met de hoogste wegingsfactor* toegevoegd aan de meeneemlijst en wordt er gezocht in de resultaten die in de vorige stap uit de registraties zijn opgehaald. Er wordt hierbij gezocht met alle voor dat veld vastgestelde zoekmethoden (Zie ook de aanvullende specificaties).

Deze stap wordt herhaald totdat er in totaal maximaal één resultaat gevonden is of totdat er geen velden meer aan de meeneemlijst toegevoegd kunnen worden.

*Alle gegevens die in een identificerende gegevensset in een vraag opgenomen kunnen worden, zijn binnen de BV BSN in een instelbare prioriteitsvolgorde gezet. De relatieve positie van ieder gegeven in deze prioriteitsvolgorde heet “wegingsfactor”. Een lage wegingsfactor betekent dat het gegeven relatief onbelangrijk is, terwijl een hoge wegingsfactor betekent dat het gegeven relatief belangrijk is. Een wegingsfactor is uniek per gegeven.

1.2.5    Controleer gevonden BSN

Indien er meerdere gelijke Burgerservicenummers zijn gevonden, wordt een melding aan de afzender en het nummerfoutenlogboek gestuurd (zie Alternatieve scenario’s 4).

De volgende resultaten worden uit het zoekresultaat verwijderd:
•    Het BSN heeft niet de status “in verkeer” (zie Alternatieve scenario’s 5)
•    Het BSN is niet afkomstig uit de registratie, die in het nummerregister bij het BSN geregistreerd staat. (zie Alternatieve scenario’s 6)
Voor deze gevallen wordt een melding aan het nummerfoutenlogboek
toegevoegd.

Hierna wordt het aantal zoekresultaten gecontroleerd:
•    Als er meer dan één resultaat is, wordt dit in het antwoord aan de afzender gemeld (zie Alternatieve scenario’s 7).
•    Als er geen resultaten zijn, wordt dit in het antwoord aan de afzender gemeld (zie Alternatieve scenario’s 3).
•    Als er één resultaat is, wordt dit in het antwoordbericht opgenomen.

1.3    Afronding

1.3.1    Stel antwoordbericht “Bulkvraag” samen

Het bericht wordt als volgt samengesteld, namelijk:

Antwoordbericht
Algemeen deel
Berichtnummer afzender
BV BSN Berichtnummer
Berichtresultaatcode (37000)
Omschrijving berichtresultaat (“Verwerking bericht succesvol”)
1 of meerdere antwoorden
Vraagnummer
Resultaatcode (37002)
Omschrijving resultaat (”Resultaat gevonden”)
BSN
Voornamen
Adellijke titel/predikaat
Voorvoegsels geslachtsnaam
Geslachtsnaam
Geboortedatum
Geboorteplaats
Geboorteland
Geslachtsaanduiding
Aanduiding gegevens in onderzoek persoon
Datum ingang onderzoek persoon
Datum overlijden
Aanduiding gegevens in onderzoek overlijden
Datum ingang onderzoek overlijden
Omschrijving reden opschorting
Indicatie geheim
Gemeente van inschrijving1
Functie adres1
Gemeentedeel1
Straatnaam1
Huisnummer1
Huisletter1
Huisnummertoevoeging1
Aanduiding bij huisnummer1
Postcode1
Woonplaatsnaam1
Locatiebeschrijving1
LandAdresBuitenland2

 

Antwoordbericht
DatumAanvangAdresBuitenland2
Regel1AdresBuitenland2
Regel2AdresBuitenland2
Regel3AdresBuitenland2
Land vanwaar ingeschreven1
Aanduiding gegevens in onderzoek adres1
Datum ingang onderzoek adres1

•    Gegevens in onderzoek
Als in de registratie de datum ingang onderzoek is gevuld en de datum einde onderzoek niet is gevuld, dan betekent dit dat de betreffende gegevens in onderzoek zijn. De aanduiding gegevens in onderzoek is dan gevuld. In alle andere gevallen betekent het dat de betreffende gegevens niet in onderzoek zijn. De datum ingang onderzoek en de aanduiding gegevens in onderzoek worden dan niet in het antwoordbericht opgenomen. Datum einde onderzoek wordt niet in het antwoordbericht opgenomen.


•    Indicatie geheim
Het veld indicatie geheim wordt in het antwoordbericht als volgt opgenomen:
•    Indien indicatie geheim = 0, dan wordt “Nee” opgenomen in het antwoordbericht.
•    Indien indicatie geheim <> 0, dan wordt “Ja” opgenomen in het antwoordbericht. Dit betekent dat er een beperking op de gegevensverstrekking van toepassing is en worden de verblijfplaatsgegevens (aangeduid met een 1 en 2 niet in het antwoordbericht opgenomen.


•    Reden opschorting
Als in de registratie de omschrijving reden opschorting gelijk is aan “O” (overlijden), “E” (emigratie) , “M” (ministerieel besluit) of gemeente van inschrijving = “Registratie Niet Ingezetenen (RNI)
“, worden de binnenlandse verblijfplaatsgegevens (aangeduid met een
1) niet in het antwoordbericht opgenomen.


•    Als in de registratie de gemeente van inschrijving is ongelijk aan “Registratie Niet Ingezetenen (RNI) “, worden de buitenlandse verblijfplaatsgegevens (aangeduid met “2”) niet in het antwoordbericht opgenomen.

1.3.2    Leg antwoord bulkvraag vast

Het antwoord op de bulkvraag wordt vastgelegd bij het behandelnummer, zodat deze later opgehaald kan worden.

1.3.3    Vul het auditlog

Het systeem registreert in het auditlog het resultaat van alle bovenstaande stappen. De volgende gegevens worden hierbij vastgelegd (zie ook Alternatieve scenario´s 8):

Gegevens auditlog Toelichting
Huidige datum en tijd Systeemdatum-tijd
Identificatie afzender DN uit het certificaat
BV BSN-berichtnummer Het toegekende BV BSN berichtnummer
Berichtnummer afzender Overnemen uit vraagbericht
Gegevens auditlog Toelichting
Indicatie eindgebruiker/instantie Overnemen uit vraagbericht
Uitgevoerde actie de stap die uitgevoerd is
Resultaat van de uitgevoerde actie Resultaat van de uitgevoerde stap
Resultaatcode Berichtresultaatcode uit het antwoordbericht

Wanneer alle stappen met succes zijn doorlopen, worden de voorkomens van de betreffende stappen in het auditlog verwijderd. Van het verwerkte bericht wordt één nieuw voorkomen aangemaakt met de volgende gegevens:
 

Gegevens auditlog Toelichting
Huidige datum en tijd Datum-tijd van de eerste stap van het auditlog van betreffende bericht
Identificatie afzender DN uit het certificaat
BV BSN-berichtnummer Het toegekende BV BSN berichtnummer
Berichtnummer afzender Overnemen uit vraagbericht
Indicatie eindgebruiker/instantie Overnemen uit vraagbericht
Uitgevoerde actie “Bericht verwerkt”
Resultaat van de uitgevoerde actie “Succesvol
Resultaatcode Berichtresultaatcode uit het antwoordbericht


2    Alternatieve scenario’s

2.1    Alternatief 1: Set van identificerende gegevens niet valide

Indien de set van identificerende gegevens niet voldoet aan één van de zoekpaden, wordt voor deze set “Vraag voldoet niet aan een toegestaan zoekpad” (resultaatcode 37004) in het antwoordbericht opgenomen.
Hierna wordt verdergegaan met de volgende vraag, indien deze aanwezig is.


2.2    Alternatief 2: Fout bij ophalen gegevens

Indien er een fout optreedt bij het ophalen van de gegevens uit de registratie, wordt de melding ”Er is een fout opgetreden” (berichtresultaatcode 2) in het antwoordbericht verstuurd naar de afzender.. Daarnaast wordt een melding in het systeemfoutenlogboek opgenomen. Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.


2.3    Alternatief 3: Geen resultaten gevonden

Indien er geen resultaten zijn gevonden, wordt de melding “Geen resultaat gevonden” (resultaatcode 37001) in het antwoordbericht opgenomen. Hierna wordt verdergegaan met de volgende vraag, indien deze aanwezig is.
 

2.4    Alternatief 4: Meerdere resultaten met hetzelfde BSN gevonden

Indien er meerderde resultaten zijn gevonden met hetzelfde BSN wordt de melding “Vraag heeft niet tot één persoon geleid” (37006) in het antwoordbericht opgenomen.

Er wordt een melding aan het nummerfoutenlogboek toegevoegd.
In het nummerfoutenlogboek worden de volgende gegevens opgenomen:

Gegevens nummerfoutenlogboek Toelichting
Foutnummer Uniek volgnummer
BV BSN-Berichtnummer Nummer van het bericht waarbij de fout optrad
BSN BSN waar de fout betrekking op heeft
Indicatie van de fout “Meerdere resultaten met hetzelfde BSN gevonden”
Datum/tijd Datum tijd van constatering van de fout
Status van de verwerking van de fout Open

Indien het nummerfoutenlogboek niet gevuld kan worden, wordt een melding in het systeemfoutenlogboek opgenomen. Dit heeft verder geen invloed op de verwerking van het bericht.

Hierna wordt verdergegaan met de volgende vraag, indien deze aanwezig is.


2.5    Alternatief 5: In registratie gevonden BSN heeft niet de status “in verkeer”

Indien het in de registratie gevonden nummer in het nummerregister niet de status “in verkeer’” heeft, wordt een melding aan het nummerfoutenlogboek toegevoegd.
In het nummerfoutenlogboek worden de volgende gegevens opgenomen:

Gegevens nummerfoutenlogboek Toelichting
Foutnummer Uniek volgnummer
BV BSN-Berichtnummer Nummer van het bericht waarbij de fout optrad
BSN BSN waar de fout betrekking op heeft
Indicatie van de fout “In registratie gevonden BSN heeft niet de status “in verkeer”
Datum/tijd Datum tijd van constatering van de fout
Status van de verwerking van de fout Open

Indien het nummerfoutenlogboek niet gevuld kan worden, wordt een melding in het systeemfoutenlogboek opgenomen. Dit heeft verder geen invloed op de verwerking van het bericht.

Hierna wordt met de beschreven flow verder gegaan.
 

2.6    Alternatief 6: Gevonden BSN is niet afkomstig uit de registratie, die in het nummerregister geregistreerd staat.

Indien het BSN is niet afkomstig uit de registratie, die in het nummerregister bij het BSN geregistreerd staat, wordt een melding aan het nummerfoutenlogboek toegevoegd.
In het nummerfoutenlogboek worden de volgende gegevens opgenomen:

Gegevens nummerfoutenlogboek Toelichting
Foutnummer Uniek volgnummer
BV BSN-Berichtnummer Nummer van het bericht waarbij de fout optrad
BSN BSN waar de fout betrekking op heeft
Indicatie van de fout “BSN is in register [GBA of RNI] gevonden, maar staat volgens nummerregister in [RNI of GBA]”
Datum/tijd Datum tijd van constatering van de fout
Status van de verwerking van de fout Open

Indien het nummerfoutenlogboek niet gevuld kan worden, wordt een melding in het systeemfoutenlogboek opgenomen. Dit heeft verder geen invloed op de verwerking van het bericht.

Hierna wordt met de beschreven flow verder gegaan.


2.7    Alternatief 7: Meerdere resultaten met verschillende BSN’s gevonden

Indien er meerderde resultaten zijn gevonden met verschillende BSN’s, wordt de melding “Vraag heeft niet tot één persoon geleid” (37006) in het antwoordbericht opgenomen.
Hierna wordt verdergegaan met de volgende vraag, indien deze aanwezig is.


2.8    Alternatief 8: Fout bij vullen auditlog

Indien het auditlog niet gevuld kan worden, wordt een melding in het systeemfoutenlogboek opgenomen en moet de verwerking van het bericht stoppen. Aan de afzender van het bericht wordt de melding "Er is een fout opgetreden" (berichtresultaatcode 2) verstuurd.
Indien het tussenstappen betreft wordt direct verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.
Indien het de laatste stap betreft, zal wel de beheerorganisatie, maar niet de afzender hierover geïnformeerd worden.

3    Subprocessen

Niet van toepassing.
 

4    Belangrijke scenario’s

Niet van toepassing.

5    Precondities

•    Er is een bulkvraag aanwezig

6    Postcondities

•    Alle ondernomen acties zijn vastgelegd in het auditlog;
•    Er is een antwoordbericht samengesteld.

7    Extensies

Niet van toepassing.

8    Speciale eisen

Niet van toepassing

9    Aanvullende informatie

9.1    Activiteitendiagram
 

Delen

Naslagwerk

UC34 Ophalen antwoord bulkvraag

UC34 Ophalen antwoord bulkvraag

Inleiding

De use case “Ophalen antwoord bulkvraag” stelt gebruikers in staat om antwoord te krijgen op de eerder gestuurde bulkvraag om bij de opgegeven identificerende gegevens het BSN te zoeken (zie UC33) middels het behandelnummer.
Het betreft hier een tijdelijke dienst van de BV BSN.

1    Hoofdscenario

1.1    Initiatie

1.1.1    Ontvang bericht “Ophalen antwoord bulkvraag”

De use case start met de ontvangst van het bericht “Ophalen antwoord bulkvraag”. Dit bericht bevat de onderstaande gegevens:

Vraagbericht
Algemeen deel
Identificatie afzender
Berichtnummer afzender
Indicatie eindgebruiker
Behandelnummer

1.1.2    Leg bericht “Ophalen antwoord bulkvraag” vast

Het BV BSN-berichtnummer wordt toegekend en het vraagbericht wordt vastgelegd in het berichtenlogboek. Zie use case “Leg bericht vast”.

1.1.3    Autoriseer verzoek

De autorisatie wordt aangevraagd en verleend. Zie use case “Autoriseer verzoek” (Zie alternatieve scenario´s 1).

1.2    Verwerking

1.2.1    Controleer bericht

Het bericht moet voldoen aan de volgende eisen:

  • De afzender moet gevuld zijn (zie Alternatieve scenario’s 2)
  • Het berichtnummer van de afzender moet gevuld zijn (zie Alternatieve scenario’s 3)
  • De indicatie eindgebruiker moet gevuld zijn (zie Alternatieve scenario’s 4)
  • Het behandelnummer moet gevuld zijn (zie Alternatieve scenario’s 5)
     

1.2.2    Haal antwoord op

Het antwoord wordt opgehaald. Indien er (nog) geen antwoord beschikbaar is bij het opgegeven behandelnummer, wordt dit gemeld (zie Alternatieve scenario’s 6).
Indien de combinatie afzender- behandelnummer niet bestaat, wordt dit gemeld (zie Alternatieve scenario’s 7).
Indien de afzender niet gelijk is aan de afzender van de bulkvraag, wordt dit gemeld (zie Alternatieve scenario’s 8).

1.3    Afronding

1.3.1    Leg antwoordbericht “Ophalen antwoord bulkvraag” vast

Het antwoordbericht wordt vastgelegd in het berichtenlogboek. Zie use case “Leg bericht vast”.

1.3.2    Bied antwoordbericht “Ophalen antwoord bulkvraag” aan

Het antwoordbericht wordt door het systeem aangeboden aan de afzender.

1.3.3    Verwijder vastgelegde bulkvraag en -antwoord

Na het versturen van het antwoord worden de vastgelegde bulkvraag en- antwoord en het bijbehorende behandelnummer verwijderd.

1.3.4    Vul het auditlog

Het systeem registreert in het auditlog het resultaat van alle bovenstaande stappen. De volgende gegevens worden hierbij vastgelegd (zie ook Alternatieve scenario´s 9):

Gegevens auditlog Toelichting
Huidige datum en tijd Systeemdatum-tijd
Identificatie afzender DN uit het certificaat
BV BSN-berichtnummer Het toegekende BV BSN berichtnummer
Berichtnummer afzender Overnemen uit vraagbericht
Indicatie eindgebruiker/instantie Overnemen uit vraagbericht
Uitgevoerde actie de stap die uitgevoerd is
Resultaat van de uitgevoerde actie Resultaat van de uitgevoerde stap
Resultaatcode Berichtresultaatcode uit het antwoordbericht


Wanneer alle stappen met succes zijn doorlopen, worden de voorkomens van de betreffende stappen in het auditlog verwijderd. Van het verwerkte bericht wordt één nieuw voorkomen aangemaakt met de volgende gegevens:

Gegevens auditlog Toelichting
Huidige datum en tijd Datum-tijd van de eerste stap van het auditlog van betreffende bericht
Identificatie afzender DN uit het certificaat
BV BSN-berichtnummer Het toegekende BV BSN berichtnummer
Berichtnummer afzender Overnemen uit vraagbericht
Indicatie eindgebruiker/instantie Overnemen uit vraagbericht
Uitgevoerde actie “Bericht verwerkt”
Resultaat van de uitgevoerde actie “Succesvol
Resultaatcode Berichtresultaatcode uit het antwoordbericht


2    Alternatieve scenario’s

2.1    Alternatief 1: Autorisatie mislukt

Indien de autorisatie wordt geweigerd, wordt de volgende melding verstuurd naar de afzender “Afzender niet geautoriseerd” (berichtresultaatcode 4).Daarnaast wordt een melding in het systeemfoutenlogboek opgenomen. Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.2    Alternatief 2: Identificatie afzender in vraagbericht is niet gevuld

Indien het veld Identificatie afzender van het vraagbericht niet gevuld is, wordt de volgende foutmelding naar de afzender verstuurd ”De afzender van het bericht moet gevuld zijn” (berichtresultaatcode 8). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.3    Alternatief 3: Berichtnummer afzender in vraagbericht is niet gevuld

Indien het veld berichtnummer afzender van het vraagbericht niet gevuld is, wordt de volgende foutmelding naar de afzender verstuurd ”Het berichtnummer van de afzender moet gevuld zijn” (berichtresultaatcode 9). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.4    Alternatief 4: Indicatie eindgebruiker in vraagbericht is niet gevuld

Indien het veld indicatie eindgebruiker van het vraagbericht niet gevuld is, wordt de volgende foutmelding naar de afzender verstuurd ”De indicatie eindgebruiker van het bericht moet gevuld zijn” (berichtresultaatcode 10). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.5    Alternatief 5: Behandelnummer moet ingevuld zijn

Indien het behandelnummers niet gevuld is, wordt de volgende foutmelding naar de afzender verstuurd “Het behandelnummer moet gevuld zijn” (berichtresultaatcode 34001). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.6    Alternatief 6: (Nog) geen antwoord beschikbaar bij opgegeven behandelnummer

Indien er (nog) geen antwoord beschikbaar is bij het opgegeven behandelnummer, wordt de volgende melding naar de afzender verstuurd: “(Nog) geen antwoord beschikbaar” (berichtresultaacode 34002). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.7    Alternatief 7: De combinatie afzender-behandelnummer komt niet voor

Indien de combinatie afzender –behandelnummer niet voorkomt, wordt de volgende melding naar de afzender verstuurd: “Het opgegeven behandelnummer is onjuist” (berichtresultaatcode 34003). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.8    Alternatief 8: Afzender komt niet overeen met afzender van de bulkvraag

Indien de afzender niet overeenkomt met de afzender van de bulkvraag, wordt de volgende melding naar de afzender verstuurd: “De afzender komt niet overeen met de afzender van de bullkvraag” (berichtresultaatcode 34004). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.9    Alternatief 9: Fout bij vullen auditlog

Indien het auditlog niet gevuld kan worden, wordt een melding in het systeemfoutenlogboek opgenomen en moet de verwerking van het bericht stoppen. Aan de afzender van het bericht wordt de melding "Er is een fout opgetreden" (berichtresultaatcode 2) verstuurd.
Indien het tussenstappen betreft wordt direct verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.
Indien het de laatste stap betreft, zal wel de beheerorganisatie, maar niet de afzender hierover geïnformeerd worden.

3    Subprocessen

Niet van toepassing.

4    Belangrijke scenario’s

Niet van toepassing.

5    Precondities

•    De actor die het bericht verstuurt, is geauthenticeerd (zie use case: authenticeren).

6    Postcondities

•    Alle ondernomen acties zijn vastgelegd in het auditlog;
•    Er is een antwoordbericht verstuurd naar de actor.

7    Extensies

Niet van toepassing.

8    Speciale eisen

Niet van toepassing

9    Aanvullende informatie

Delen

Naslagwerk

UC33 Stellen Bulkvraag

UC33 Stellen Bulkvraag


Inleiding


De use case “Stellen bulkvraag” stelt gebruikers in staat om meerdere vragen met betrekking tot het opvragen van het BSN op basis van identificerende gegevens. De gebruiker krijgt een behandelnummer terug en kan later op basis van dit behandelnummer het antwoord op de bulkvraag ophalen.
Het betreft hier een tijdelijke dienst van de BV BSN.


1    Hoofdscenario

1.1    Initiatie

1.1.1    Ontvang bericht “Stellen bulkvraag”

De use case start met de ontvangst van het bericht “Stellen bulkvraag”. Dit bericht bevat de onderstaande gegevens:

Vraagbericht
Algemeen deel
Identificatie afzender
Berichtnummer afzender
Indicatie eindgebruiker
1 of meerdere vragen
Vraagnummer
Voornamen
Voorvoegsel Geslachtsnaam
Geslachtsnaam
Geboortedatum
Geboorteplaats
Geboorteland
Geslachtsaanduiding
Gemeente van inschrijving
Straatnaam
Huisnummer
Huisletter
Huisnummertoevoeging
Aanduiding bij huisnummer
Postcode
Locatiebeschrijving
Land vanwaar ingeschreven

1.1.2    Leg bericht “Opvragen meerdere vragen” vast

Het BV BSN-berichtnummer wordt toegekend en het vraagbericht wordt vastgelegd in het berichtenlogboek. Zie use case “Leg bericht vast”.

1.1.3    Autoriseer verzoek

De autorisatie wordt aangevraagd en verleend. Zie use case “Autoriseer verzoek” (Zie alternatieve scenario´s 1).

1.2    Verwerking

1.2.1    Controleer bericht

Het bericht moet voldoen aan de volgende eisen:

  • Het vraagnummer moet bij 1 beginnen (zie Alternatieve scenario’s 2)
  • De vraagnummers moeten oplopend zijn (zie Alternatieve scenario’s 3)
  • Het bericht moet minimaal één vraag bevatten (zie Alternatieve scenario’s 4)
  • Het bericht mag niet meer vragen bevatten dan het toegestane maximum, waarbij dit maximum een instelbare waarde heeft en initieel wordt ingesteld op 100.000 (zie Alternatieve scenario’s 5)
  • De afzender moet gevuld zijn (zie Alternatieve scenario’s 6)
  • Het berichtnummer van de afzender moet gevuld zijn (zie Alternatieve scenario’s 7)
  • De indicatie eindgebruiker moet gevuld zijn (zie Alternatieve scenario’s 8)
  • De vraagnummers moeten gevuld zijn (zie Alternatieve scenario’s 9)

1.2.2    Vastleggen te verwerken bulkvraag

Het behandelnummer wordt aangemaakt en de bijbehorende bulkvraag wordt ter verwerking vastgelegd.
De volgende gegevens worden vastgelegd:

Vastleggen te verwerken bulkvraag
Behandelnummer
Identificatie afzender
Bulkvraag
Datum/tijd van vastleggen


1.3    Afronding

1.3.1    Stel antwoordbericht “Stellen bulkvraag” samen

De afzender krijgt een behandelnummer terug in het antwoordbericht. Het bericht wordt als volgt samengesteld:

Antwoordbericht
Berichtnummer afzender
BV BSN Berichtnummer
Berichtresultaatcode (33000)
Omschrijving berichtresultaat (“Verwerking bericht succesvol”)
Behandelnummer

Met dit behandelnummer kan de afzender de antwoorden bij zijn vragen ophalen. Zie UC 34 “Ophalen antwoord bulkvraag”.

1.3.2    Leg antwoordbericht “Stellen bulkvraag” vast

Het antwoordbericht wordt vastgelegd in het berichtenlogboek. Zie use case “Leg bericht vast”.

1.3.3    Bied antwoordbericht “Stellen bulkvraag” aan

Het antwoordbericht wordt door het systeem aangeboden aan de afzender.

1.3.4    Vul het auditlog

Het systeem registreert in het auditlog het resultaat van alle bovenstaande stappen. De volgende gegevens worden hierbij vastgelegd (zie ook Alternatieve scenario´s 10):

Gegevens auditlog Toelichting
Huidige datum en tijd Systeemdatum-tijd
Identificatie afzender DN uit het certificaat
BV BSN-berichtnummer Het toegekende BV BSN berichtnummer
Berichtnummer afzender Overnemen uit vraagbericht
Indicatie eindgebruiker/instantie Overnemen uit vraagbericht
Uitgevoerde actie de stap die uitgevoerd is
Resultaat van de uitgevoerde actie Resultaat van de uitgevoerde stap
Resultaatcode Berichtresultaatcode uit het antwoordbericht

Wanneer alle stappen met succes zijn doorlopen, worden de voorkomens van de betreffende stappen in het auditlog verwijderd. Van het verwerkte bericht wordt één nieuw voorkomen aangemaakt met de volgende gegevens:

Gegevens auditlog Toelichting
Huidige datum en tijd Datum-tijd van de eerste stap van het auditlog van betreffende bericht
Identificatie afzender DN uit het certificaat
BV BSN-berichtnummer Het toegekende BV BSN berichtnummer
Berichtnummer afzender Overnemen uit vraagbericht
Indicatie eindgebruiker/instantie Overnemen uit vraagbericht
Uitgevoerde actie “Bericht verwerkt”
Resultaat van de uitgevoerde actie “Succesvol
Resultaatcode Berichtresultaatcode uit het antwoordbericht

2    Alternatieve scenario’s

2.1    Alternatief 1: Autorisatie mislukt

Indien de autorisatie wordt geweigerd, wordt de volgende melding verstuurd naar de afzender “Afzender niet geautoriseerd” (berichtresultaatcode 4). Daarnaast wordt een melding in het systeemfoutenlogboek opgenomen. Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.2    Alternatief 2: Vraagnummer begint niet bij 1

Indien de vraagnummer niet bij nummer 1 begint, wordt de volgende melding verstuurd naar de afzender “Vraagnummer begint niet bij 1” (berichtresultaatcode 13). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.3    Alternatief 3: Vraagnummers zijn niet oplopend

Indien de nummering van vraagnummers niet oplopend (+1) zijn, wordt de volgende melding verstuurd naar de afzender “Vraagnummers zijn niet oplopend” (berichtresultaatcode 14). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.4    Alternatief 4: Bericht bevat geen vragen

Indien het inkomende bericht geen vragen bevat, wordt de volgende foutmelding naar de afzender verstuurd ”Het bericht moet meerdere vragen bevatten” (berichtresultaatcode 7). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.5    Alternatief 5: Bericht bevat teveel vragen

Indien het inkomende bericht meer dan het ingestelde maximum aan vragen bevat, wordt de volgende foutmelding naar de afzender verstuurd “Het bericht bevat meer vragen dan het toegestane maximum” (berichtresultaatcode 6). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.6    Alternatief 6: Identificatie afzender in vraagbericht is niet gevuld

Indien het veld Identificatie afzender van het vraagbericht niet gevuld is, wordt de volgende foutmelding naar de afzender verstuurd ”De afzender van het bericht moet gevuld zijn” (berichtresultaatcode 8). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.7    Alternatief 7: Berichtnummer afzender in vraagbericht is niet gevuld

Indien het veld berichtnummer afzender van het vraagbericht niet gevuld is, wordt de volgende foutmelding naar de afzender verstuurd ”Het berichtnummer van de afzender moet gevuld zijn” (berichtresultaatcode 9). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.8    Alternatief 8: Indicatie eindgebruiker in vraagbericht is niet gevuld

Indien het veld indicatie eindgebruiker van het vraagbericht niet gevuld is, wordt de volgende foutmelding naar de afzender verstuurd ”De indicatie eindgebruiker van het bericht moet gevuld zijn” (berichtresultaatcode 10). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.9    Alternatief 9: Eén of meer vraagnummers niet ingevuld

Indien één of meer vraagnummers niet gevuld zijn, wordt de volgende foutmelding naar de afzender verstuurd “De vraagnummers moeten gevuld zijn” (berichtresultaatcode 11). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.10    Alternatief 10: Fout bij vullen auditlog

Indien het auditlog niet gevuld kan worden, wordt een melding in het systeemfoutenlogboek opgenomen en moet de verwerking van het bericht stoppen. Aan de afzender van het bericht wordt de melding "Er is een fout opgetreden" (berichtresultaatcode 2) verstuurd.
Indien het tussenstappen betreft wordt direct verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.
Indien het de laatste stap betreft, zal wel de beheerorganisatie, maar niet de afzender hierover geïnformeerd worden.

3    Subprocessen

Niet van toepassing.

4    Belangrijke scenario’s

Niet van toepassing.

5    Precondities

•    De actor die het bericht verstuurt, is geauthenticeerd (zie use case: authenticeren).

6    Postcondities

•    Alle ondernomen acties zijn vastgelegd in het auditlog;
•    Er is een antwoordbericht verstuurd naar de actor.

7    Extensies

Niet van toepassing.

8    Speciale eisen

Niet van toepassing

9    Aanvullende informatie

9.1    Activiteitendiagram

Delen

Naslagwerk

UC32 Vastleggen foutvermoeden

UC32 Vastleggen foutvermoeden

 

Inleiding

De use case “Vastleggen foutvermoeden” beschrijft de stappen voor het melden van een foutvermoeden door een beheercomponent. Deze worden vastgelegd in het nummerfoutenlogboek
In onderstaand model is de use case “Vastleggen foutvermoeden” weergegeven.

Image
model Vastleggen foutvermoeden

1    Hoofdscenario

1.1    Initiatie

1.1.1    Ontvang bericht “melden foutvermoeden”


De use case start met de ontvangst van het bericht “melden foutvermoeden”. In dit bericht staan de volgende gegevens:

Vraagbericht
Identificatie afzender
Berichtnummer afzender
Nummer
Indicatie van de fout
Datum/tijd

1.1.2    Leg bericht “melden foutvermoeden” vast

Het BV BSN-berichtnummer wordt toegekend en het vraagbericht wordt vastgelegd in het berichtenlogboek. Zie use case “Leg bericht vast”.

1.1.3    Autoriseer verzoek

De autorisatie wordt aangevraagd en verleend. Zie use case “Autoriseer verzoek” (Zie ook alternatieve scenario´s 1).

1.2    Verwerking

1.2.1    Controleer bericht

Het bericht moet voldoen aan de volgende eisen:

  • De afzender moet gevuld zijn (zie Alternatieve scenario’s 2)
  • Het berichtnummer van de afzender moet gevuld zijn (zie Alternatieve scenario’s 3)
  • Nummer moet gevuld zijn (zie Alternatieve scenario’s 4) 
  • Het nummer moet aan de 11-proef voldoen (zie Alternatieve scenario’s 5)
  • Datum/tijd moet valide zijn (zie Alternatieve scenario’s 6)

1.2.2    Leg foutvermoeden vast in nummerfoutenlogboek

Het foutvermoeden wordt vastgelegd in het nummerfoutenlogboek, hierbij worden de volgende gegevens vastgelegd (zie Alternatieve scenario’s 7):

Gegevens nummerfoutenlogboek Toelichting
Foutnummer Uniek volgnummer
Berichtnummer Berichtnummer waarmee de fout gemeld is.
BSN BSN waar de fout betrekking op heeft
Indicatie van de fout Overnemen uit vraagbericht (afkappen indien te lang)
Datum/tijd Overnemen uit vraagbericht
Status van de verwerking van de fout Open

1.3    Afronding

1.3.1    Stel antwoordbericht “melden foutvermoeden” samen

In onderstaande tabel wordt beschreven welke gegevens in het antwoordbericht zijn opgenomen.

Antwoordbericht
Algemeen deel
Berichtnummer afzender
BV BSN Berichtnummer
Berichtresultaatcode (32000)
Omschrijving berichtresultaat (“Verwerking bericht succesvol”)
Behandelnummer

1.3.2    Leg antwoordbericht “melden foutvermoeden” vast

Het antwoordbericht wordt vastgelegd in het berichtenlogboek. Zie use case “Leg bericht vast”.

1.3.3    Bied antwoordbericht “melden foutvermoeden” aan

Het antwoordbericht wordt aangeboden aan de afzender.

1.3.4    Vul het auditlog

Het systeem registreert in het auditlog het resultaat van alle bovenstaande stappen. De volgende gegevens worden hierbij vastgelegd (Zie ook alternatieve scenario´s 8):

Gegevens auditlog Toelichting
Huidige datum en tijd Systeemdatum-tijd
Identificatie afzender DN uit het certificaat
BV BSN-berichtnummer Het toegekende BV BSN berichtnummer
Berichtnummer afzender Overnemen uit vraagbericht
Indicatie eindgebruiker/instantie Overnemen uit vraagbericht
Uitgevoerde actie de stap die uitgevoerd is
Resultaat van de uitgevoerde actie Resultaat van de uitgevoerde stap
Resultaatcode Berichtresultaatcode uit het antwoordbericht

Wanneer alle stappen met succes zijn doorlopen, worden de voorkomens van de betreffende stappen in het auditlog verwijderd. Van het verwerkte bericht wordt één nieuw voorkomen aangemaakt met de volgende gegevens:

Gegevens auditlog Toelichting
Huidige datum en tijd Datum-tijd van de eerste stap van het auditlog van betreffende bericht
Identificatie afzender DN uit het certificaat
BV BSN-berichtnummer Het toegekende BV BSN berichtnummer
Berichtnummer afzender Overnemen uit vraagbericht
Indicatie eindgebruiker/instantie Overnemen uit vraagbericht
Uitgevoerde actie “Bericht verwerkt”
Resultaat van de uitgevoerde actie “Succesvol
Resultaatcode Berichtresultaatcode uit het antwoordbericht


2    Alternatieve scenario’s

2.1    Alternatief 1: Autorisatie mislukt

Indien de autorisatie wordt geweigerd, wordt het volgende antwoordbericht verstuurd naar de afzender “Afzender niet geautoriseerd” (berichtresultaatcode 4) Daarnaast wordt een melding in het systeemfoutenlogboek opgenomen.
Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.2    Alternatief 2: Identificatie afzender in vraagbericht is niet gevuld

Indien het veld Identificatie afzender van het vraagbericht niet gevuld is, wordt de volgende foutmelding naar de afzender verstuurd ”De afzender van het bericht moet gevuld zijn” (berichtresultaatcode 8). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.3    Alternatief 3: Berichtnummer afzender in vraagbericht is niet gevuld

Indien het veld berichtnummer afzender van het vraagbericht niet gevuld is, wordt de volgende melding naar de afzender verstuurd ”Het berichtnummer van de afzender moet gevuld zijn” (berichtresultaatcode 9). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.4    Alternatief 4: Nummer is niet gevuld

Indien het veld ‘nummer’ van het vraagbericht niet gevuld is, wordt de volgende melding naar de afzender verstuurd ”Nummer moet gevuld zijn” (berichtresultaatcode 32002). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.5    Alternatief 5: Nummer voldoet niet aan de 11-proef

Indien het veld ‘nummer’ van het vraagbericht niet voldoet aan de 11- proef, wordt de volgende melding naar de afzender verstuurd ”Nummer voldoet niet aan de 11-proef” (berichtresultaatcode 32003). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.6    Alternatief 6: Datum/tijd niet valide

Indien de datum-tijd niet geldig is (onjuist formaat of ongeldige datum), wordt de volgende melding naar de afzender verstuurd: “Datum-tijd niet valide” (berichtresultaatcode 32004). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.7    Alternatief 7: Vastleggen foutvermoeden niet gelukt

Indien er een fout is opgetreden bij het vastleggen van het foutvermoeden in het nummerfoutenlogboek, wordt de volgende melding naar de afzender verstuurd “Er is een fout opgetreden” (berichtresultaatcode 2).
Daarnaast wordt een melding in het systeemfoutenlogboek opgenomen. Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.8    Alternatief 8: Fout bij vullen auditlog

Indien het auditlog niet gevuld kan worden, wordt een melding in het systeemfoutenlogboek opgenomen en moet de verwerking van het bericht stoppen. Aan de afzender van het bericht wordt de melding "Er is een fout opgetreden" (berichtresultaatcode 2) verstuurd.
Indien het tussenstappen betreft wordt direct verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.
Indien het de laatste stap betreft, zal wel de beheerorganisatie, maar niet de afzender hierover geïnformeerd worden.

3    Subprocessen

Niet van toepassing.

4    Belangrijke scenario’s

Niet van toepassing.

5    Precondities

•    De afzender die het bericht verstuurt is geauthenticeerd (zie use case: authenticeren).

6    Postcondities

•    Alle ondernomen acties zijn vastgelegd in het auditlog;
•    Er is een antwoordbericht verstuurd naar de afzender.

7    Extensies

Niet van toepassing.

8    Speciale eisen

Niet van toepassing.

9    Aanvullende informatie

Niet van toepassing

 

Delen

Naslagwerk

UC31 Vastleggen autorisatiegegevens

UC31 Vastleggen autorisatiegegevens

 

Inleiding

De use case “vastleggen autorisatiegegevens” beschrijft de stappen voor het vastleggen van autorisatiegegevens in de BV BSN.
De gegevens worden door de beheerorganisatie van de BV BSN opgegeven.
In onderstaand model is de use case “vastleggen autorisatiegegevens” weergegeven.

N.B. De implementatie van deze use case wijkt af van deze beschrijving. Zie voor meer informatie de aanvullende specificaties.

Image
model vastleggen autorisariegegevens


1    Hoofdscenario

1.1    Initiatie

1.1.1    Ontvang bericht “vastleggen autorisatiegegevens”

De use case start met de ontvangst van het bericht “vastleggen autorisatiegegevens”. In dit bericht staan de volgende gegevens:

Vraagbericht
Identificatie afzender
Berichtnummer afzender
Indicatie eindgebruiker
Distinguished Name
Rol
Datum vanaf
Datum t/m

1.1.2    Leg bericht “vastleggen autorisatiegegevens” vast

Het BV BSN-berichtnummer wordt toegekend en het vraagbericht wordt vastgelegd in het berichtenlogboek. Zie use case “Leg bericht vast”

1.1.3    Autoriseer verzoek

De autorisatie wordt aangevraagd en verleend. Zie use case ‘Autoriseer verzoek’. (zie Alternatieve scenario’s 1)
 

1.2    Verwerking

1.2.1    Controleer bericht

Hier wordt gecontroleerd of de velden uit het vraagbericht goed gevuld zijn. De inhoud van het bericht moet voldoen aan de volgende eisen:
•    De afzender van het vraagbericht moet gevuld zijn (zie Alternatieve scenario’s 2)
•    Het berichtnummer van de afzender moet gevuld zijn (zie Alternatieve scenario’s 3)
•    Indicatie eindgebruiker moet gevuld zijn (zie Alternatieve scenario’s 4)
•    De DN moet gevuld zijn(zie Alternatieve scenario’s 5)
•    De rol moet gevuld zijn (zie Alternatieve scenario’s 6)
•    Datum vanaf moet gevuld zijn (zie Alternatieve scenario’s 7)
•    Datums vanaf en Datum t/m moeten geldige datums zijn (zie Alternatieve scenario’s 8)

1.2.2    Leg autorisatiegegevens vast

De volgende situaties worden onderscheiden:
•    Indien de DN al voorkomt, worden de gevonden gegevens gemuteerd met de gegevens uit het bericht.
•    Indien de DN nog niet voorkomt, wordt een nieuwe autorisatieregel aangemaakt met daarin de gegevens uit het bericht

Zie ook Alternatieve scenario’s 9


1.3    Afronding

1.3.1    Stel antwoordbericht “vastleggen autorisatiegegevens” samen

Het systeem stelt het antwoordbericht samen. In dit bericht staan de volgende gegevens:

Antwoordbericht
Berichtnummer afzender
BV BSN Berichtnummer
Berichtresultaatcode (31000)
Omschrijving berichtresultaat (“Verwerking bericht succesvol”)


1.3.2    Leg antwoordbericht “vastleggen autorisatiegegevens” vast

Het antwoordbericht wordt vastgelegd in het berichtenlogboek. Zie use case “Leg bericht vast”

1.3.3    Bied antwoordbericht “vastleggen autorisatiegegevens” aan

Het antwoordbericht wordt aangeboden aan de afzender.

1.3.4    Vul het auditlog

Het systeem registreert in het auditlog het resultaat van alle bovenstaande stappen. De volgende gegevens worden hierbij vastgelegd (zie Alternatieve scenario’s 10):

Gegevens auditlog Toelichting
Huidige datum en tijd Systeemdatum-tijd
Identificatie afzender DN uit het certificaat
BV BSN-berichtnummer Het toegekende BV BSN berichtnummer
Berichtnummer afzender Overnemen uit vraagbericht
Indicatie eindgebruiker/instantie Overnemen uit vraagbericht
Uitgevoerde actie de stap die uitgevoerd is
Resultaat van de uitgevoerde actie Resultaat van de uitgevoerde stap
Resultaatcode Berichtresultaatcode uit het antwoordbericht

Wanneer alle stappen met succes zijn doorlopen, worden de voorkomens van de betreffende stappen in het auditlog verwijderd. Van het verwerkte bericht wordt één nieuw voorkomen aangemaakt met de volgende gegevens:

Gegevens auditlog Toelichting
Huidige datum en tijd Datum-tijd van de eerste stap van het auditlog van betreffende bericht
Identificatie afzender DN uit het certificaat
BV BSN-berichtnummer Het toegekende BV BSN berichtnummer
Berichtnummer afzender Overnemen uit vraagbericht
Indicatie eindgebruiker/instantie Overnemen uit vraagbericht
Uitgevoerde actie “Bericht verwerkt”
Resultaat van de uitgevoerde actie “Succesvol
Resultaatcode Berichtresultaatcode uit het antwoordbericht

2    Alternatieve Scenario’s

2.1    Alternatief 1: Autorisatie mislukt

Indien de autorisatie wordt geweigerd, wordt de volgende melding verstuurd naar de afzender van het bericht “Afzender niet geautoriseerd” (berichtresultaatcode 4).
Daarnaast wordt een melding in het systeemfoutenlogboek opgenomen. Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.2    Alternatief 2: Identificatie afzender in vraagbericht is niet gevuld

Indien het veld Identificatie afzender van het vraagbericht niet gevuld is, wordt de volgende foutmelding naar de afzender verstuurd ”De afzender van het bericht moet gevuld zijn” (berichtresultaatcode 8).
Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.3    Alternatief 3: Berichtnummer afzender in vraagbericht is niet gevuld

Indien het veld berichtnummer afzender van het vraagbericht niet gevuld is, wordt de volgende foutmelding naar de afzender verstuurd ”Het berichtnummer van de afzender moet gevuld zijn” (berichtresultaatcode 9). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.4    Alternatief 4: Indicatie eindgebruiker in vraagbericht is niet gevuld

Indien het veld indicatie eindgebruiker van het vraagbericht niet gevuld is, wordt de volgende foutmelding naar de afzender verstuurd ”De indicatie eindgebruiker van het bericht moet gevuld zijn” (berichtresultaatcode 10). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.5    Alternatief 5: De DN moet gevuld zijn

Indien de DN niet gevuld is, wordt de volgende melding aan de afzender gestuurd: “De DN moet gevuld zijn” (berichtresultaatcode 31001).
Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.6    Alternatief 6: De rol moet gevuld zijn

Indien de rol niet is gevuld, wordt de volgende melding aan de afzender gestuurd: “De rol moet gevuld zijn” (berichtresultaatcode 31002).
Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.7    Alternatief 7: Datum vanaf moet gevuld zijn

Indien de datum vanaf niet gevuld is, wordt de volgende melding aan de afzender gestuurd: “Datum vanaf moet gevuld zijn” (berichtresultaatcode 31003).
Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.8    Alternatief 8: Datum vanaf en Datum t/m moeten geldige datums zijn

Indien de datum vanaf en de datum t/m niet geldig (onjuist datumformaat of datum in de toekomst) zijn, wordt de volgende melding aan de afzender gestuurd: “Datum vanaf en Datum t/m moeten geldige datums zijn” (berichtresultaatcode 31004).
Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.9    Alternatief 9: Fout bij het vastleggen van de gegevens.

Indien de BV BSN niet in staat is de autorisatiegegevens vast te leggen wordt in het antwoordbericht de melding ”Er is een fout opgetreden” (berichtresultaatcode 2) opgenomen.
Daarnaast wordt een melding in het systeemfoutenlogboek opgenomen. Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.10    Alternatief 10: Fout bij vullen auditlog

Indien het auditlog niet gevuld kan worden, wordt een melding in het systeemfoutenlogboek opgenomen en moet de verwerking van het bericht stoppen. Aan de afzender van het bericht wordt de melding "Er is een fout opgetreden" (berichtresultaatcode 2) verstuurd.
Indien het tussenstappen betreft wordt direct verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.
Indien het de laatste stap betreft, zal wel de beheerorganisatie, maar niet de afzender hierover geïnformeerd worden.

3    Subprocessen

Niet van toepassing.
 

4    Belangrijke scenario’s

Niet van toepassing.

5    Precondities

•    De actor die het bericht verstuurt, is geauthenticeerd (zie use case: authenticeren).

6    Postcondities

•    Alle ondernomen acties zijn vastgelegd in het auditlog;
•    Er is een antwoordbericht verstuurd naar de actor.

7    Extensies

Niet van toepassing.

8    Speciale eisen

Niet van toepassing.

9    Aanvullende Informatie

9.1    Activiteitendiagram

Image
Activiendiagram


 

Delen

Naslagwerk

UC29 Ophalen nummerfouten uit het nummerfoutenlogboek

UC29 Ophalen nummerfouten uit het nummerfoutenlogboek

Inleiding

De use case “Ophalen nummerfouten uit het nummerfoutenlogboek” beschrijft de stappen van het doorgeven van nummerfouten aan het Foutenmeldpunt. De nummerfouten worden opgehaald uit het nummerfoutenlogboek. De bevraging vanuit het foutenmeldpunt wordt periodiek uitgevoerd. Gezien de BV BSN niet op de hoogte is van deze periode wordt deze meegegeven in het vraagbericht (begin- en einddatum), zodoende worden alleen gegevens van een bepaalde periode opgehaald waarbij de status van de foutmelding “Open” is. Voor de meldingen die worden doorgegeven wijzigt de status naar “Doorgegeven aan Foutenmeldpunt”.

In onderstaand model is de use case “Ophalen nummerfouten uit het nummerfoutenlogboek” weergegeven.
 

Image
Ophalen nummerfouten uit het nummerfoutenlogboek


1    Hoofdscenario

1.1    Initiatie

1.1.1    Ontvang bericht “Ophalen nummerfout”

De use case start met de ontvangst van het bericht “Ophalen nummerfout”. In het bericht staan de volgende gegevens:

Vraagbericht
Identificatie afzender
Berichtnummer afzender
Indicatie eindgebruiker
Begindatum
Einddatum

1.1.2    Leg bericht “Ophalen nummerfout” vast

Het BV BSN-berichtnummer wordt toegekend en het vraagbericht wordt vastgelegd in het berichtenlogboek. Zie use case “Leg bericht vast”.

1.1.3    Autoriseer verzoek

De autorisatie wordt aangevraagd en verleend. Zie use case “Autoriseer verzoek” (zie ook Alternatieve scenario´s 1).

1.2    Verwerking

1.2.1    Controleer bericht

Het bericht moet voldoen aan de volgende eisen:

  •  De afzender moet gevuld zijn (zie Alternatieve scenario’s 2)
  •  Het berichtnummer van de afzender moet gevuld zijn (zie Alternatieve scenario’s 3)
  •  De indicatie eindgebruiker moet gevuld zijn (zie Alternatieve scenario’s 4)
  •  De begin- en einddatum moeten gevuld zijn (zie Alternatieve scenario’s 5)

1.2.2    Maak batch aan

Het systeem maakt een nieuwe batch aan. Deze wordt gevuld met gegevens uit het nummerfoutenlogboek. De selectie bestaat uit gegevens waarvan de datum binnen de begin- en einddatum valt en de waarvan de status “Open” is. (zie ook Alternatieve scenario 6).

1.2.3    Registreer gedistribueerde foutmeldingen

De status van de foutmeldingen die zijn opgenomen in het nummerfoutenlogboek wordt gewijzigd in “Doorgegeven aan Foutenmeldpunt” en veld “Datumtijd naar foutenmeldpunt” wordt gevuld met huidige datum en tijd. (zie ook Alternatieve scenario 7)

1.3    Afronding

1.3.1    Stel antwoordbericht “Ophalen nummerfout” samen

In onderstaande tabel wordt beschreven welke gegevens in het antwoordbericht zijn opgenomen.

Antwoordbericht
Algemeen deel
Berichtnummer afzender
BV BSN Berichtnummer
Aantal foutmeldingen
Berichtresultaatcode (29000)
Omschrijving berichtresultaat (“Verwerking
bericht succesvol”)
Per foutmelding
Foutnummer
BV BSN berichtnummer
BSN
Indicatie van de fout
Datum/tijd van constateren

1.3.2    Leg antwoordbericht “Ophalen nummerfout” vast

Het antwoordbericht wordt vastgelegd in het berichtenlogboek. Zie use case “Leg bericht vast”.

1.3.3    Bied antwoordbericht “Ophalen nummerfout” aan

Het antwoordbericht wordt aangeboden aan de afzender.

1.3.4    Vul het auditlog

Het systeem registreert in het auditlog het resultaat van alle bovenstaande stappen. De volgende gegevens worden hierbij vastgelegd (Zie ook alternatieve scenario´s 8):

Gegevens auditlog Toelichting
Huidige datum en tijd Systeemdatum-tijd
Identificatie afzender DN uit het certificaat
BV BSN-berichtnummer Het toegekende BV BSN berichtnummer
Berichtnummer afzender Overnemen uit vraagbericht
Indicatie eindgebruiker/instantie Overnemen uit vraagbericht
Uitgevoerde actie de stap die uitgevoerd is
Resultaat van de uitgevoerde actie Resultaat van de uitgevoerde stap
Resultaatcode Berichtresultaatcode uit het antwoordbericht

Wanneer alle stappen met succes zijn doorlopen, worden de voorkomens van de betreffende stappen in het auditlog verwijderd. Van het verwerkte bericht wordt één nieuw voorkomen aangemaakt met de volgende gegevens:

Gegevens auditlog Toelichting
Huidige datum en tijd Datum-tijd van de eerste stap van het auditlog van betreffende bericht
Identificatie afzender DN uit het certificaat
BV BSN-berichtnummer Het toegekende BV BSN berichtnummer
Berichtnummer afzender Overnemen uit vraagbericht
Indicatie eindgebruiker/instantie Overnemen uit vraagbericht
Uitgevoerde actie “Bericht verwerkt”
Resultaat van de uitgevoerde actie “Succesvol
Resultaatcode Berichtresultaatcode uit het antwoordbericht


2    Alternatieve Scenario’s

2.1    Alternatief 1: Autorisatie mislukt

Indien de autorisatie wordt geweigerd, wordt het volgende antwoordbericht verstuurd naar de afzender “Afzender niet geautoriseerd” (berichtresultaatcode 4). Daarnaast wordt een melding in het systeemfoutenlogboek opgenomen.
Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.2    Alternatief 2: Identificatie afzender in vraagbericht is niet gevuld

Indien het veld Identificatie afzender van het vraagbericht niet gevuld is, wordt de volgende foutmelding naar de afzender verstuurd ”De identificatie afzender van het bericht moet gevuld zijn” (berichtresultaatcode 8). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.3    Alternatief 3: Berichtnummer afzender in vraagbericht is niet gevuld

Indien het veld berichtnummer afzender van het vraagbericht niet gevuld is, wordt de volgende foutmelding naar de afzender verstuurd ”Het berichtnummer van de afzender moet gevuld zijn” (berichtresultaatcode 9). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.4    Alternatief 4: Identificatie eindgebruiker in vraagbericht is niet gevuld

Indien het veld Identificatie eindgebruiker van het vraagbericht niet gevuld is, wordt de volgende foutmelding naar de afzender verstuurd ”De indicatie eindgebruiker van het bericht moet gevuld zijn” (berichtresultaatcode 10). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.5    Alternatief 5: Begin- en einddatum zijn niet gevuld

Indien de gewenste periode niet is ingevuld of als de einddatum voor de begindatum ligt, wordt de volgende foutmelding “De gewenste periode moet opgegeven worden” (berichtresultaatcode 29001) naar de afzender verstuurd. Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.6    Alternatief 6: Fout bij aanmaken batch

Indien er een fout optreedt bij het aanmaken van een batch, wordt de melding ”Er is een fout opgetreden” ((berichtresultaatcode 2)) verstuurd naar de afzender en een melding in het systeemfoutenlogboek opgenomen.

2.7    Alternatief 7: Fout bij wijzigen status nummerfout

Indien er een fout optreedt bij het nummerfoutenlogboek, wordt de melding ”Er is een fout opgetreden” (berichtresultaatcode 2) verstuurd naar de afzender. Het nummerfoutenlogboek wordt teruggebracht in de toestand als deze was voor de verwerking van het bericht en een melding in het systeemfoutenlogboek opgenomen.

2.8    Alternatief 8: Fout bij vullen auditlog

Indien het auditlog niet gevuld kan worden, wordt een melding in het systeemfoutenlogboek opgenomen. Aan de afzender van het bericht wordt de melding "Er is een fout opgetreden" (berichtresultaatcode 2) verstuurd. Indien het tussenstappen betreft wordt direct verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.
Indien het de laatste stap betreft, zal wel de beheerorganisatie, maar niet de afzender hierover geïnformeerd worden.


3    Subprocessen

Niet van toepassing.

4    Belangrijke scenario’s

Niet van toepassing.

5    Precondities

•    De actor die het bericht verstuurt is geauthenticeerd (zie use case: authenticeren).

6    Postcondities

•    Alle ondernomen acties zijn vastgelegd in het auditlog;
•    Er is een antwoordbericht verstuurd naar de actor.

7    Extensies

Niet van toepassing.
 

8    Speciale eisen

Niet van toepassing.

9    Aanvullende Informatie

9.1    Activiteitendiagram

Image
Activiendiagram

Delen

Naslagwerk

UC28 Ophalen nummergegevens

UC28 Ophalen nummergegevens

 

Inleiding

De use case “Ophalen nummergegevens” beschrijft de stappen voor het ophalen van de gevraagde nummergegevens die in de BV BSN zijn vastgelegd.
De beheerorganisatie BV BSN en het Foutenmeldpunt kunnen gegevens uit het nummerregister opvragen.

In onderstaande model is de use case “Ophalen nummergegevens” weergegeven.

Image
model Ophalen nummergegevens


1    Hoofdscenario

1.1    Initiatie

1.1.1    Ontvang bericht “Ophalen nummergegevens”

De use case start met de ontvangst van het bericht “opvragen nummergegevens”. In dit bericht staan de volgende gegevens:
 

Vraagbericht
Algemeen deel
Identificatie afzender
Berichtnummer afzender
Indicatie eindgebruiker
Zoekcriteria
BSN

1.1.2    Leg bericht “Ophalen nummergegevens” vast

Het BV BSN-berichtnummer wordt toegekend en het vraagbericht wordt vastgelegd in het berichtenlogboek. Zie use case “Leg bericht vast”.

1.1.3    Autoriseer verzoek

De autorisatie wordt aangevraagd en verleend. Zie use case “Autoriseer verzoek” (zie Alternatieve scenario 1).

1.2    Verwerking

1.2.1    Controleer bericht “Ophalen nummergegevens”

Het bericht moet voldoen aan de volgende eisen:

  •  De afzender moet gevuld zijn (zie Alternatieve scenario’s 2)
  •  Het berichtnummer van de afzender moet gevuld zijn (zie Alternatieve scenario’s 3)
  •  De indicatie eindgebruiker moet gevuld zijn (zie Alternatieve scenario’s 4)
  •  Het BSN moet gevuld zijn(zie Alternatieve scenario’s 5)

1.2.2    Selecteer gegevens uit het nummerregister

Het systeem selecteert op basis van het BSN alle beschikbare gegevens (inclusief historie) uit het nummerregister (zie Alternatieve scenario 6 en 7).

1.3    Afronding

1.3.1    Stel antwoordbericht “Ophalen nummergegevens” samen

In onderstaande tabel wordt beschreven welke gegevens in het antwoordbericht zijn opgenomen.
 

Antwoordbericht
Algemeen deel
Berichtnummer afzender
BV BSN Berichtnummer
Berichtresultaatcode (28000)
Omschrijving berichtresultaat (“Verwerking bericht succesvol”)
Per resultaat
Nummer
Status
Instantie
Datum/tijd toekennen
Instantie opwaarderen
Datum/tijd opwaarderen
Instantie omhangen
Datum/tijd omhangen
Instantie uit verkeer halen
Datum/tijd uit verkeer halen
Registratie
Datum tijd van wijziging
BV BSN berichtnummer van wijziging


1.3.2    Leg antwoordbericht “Ophalen nummergegevens” vast

1.3.3    Het antwoordbericht wordt vastgelegd in het berichtenlogboek.

Zie use case “Leg bericht vast”.Bied antwoordbericht “Ophalen nummergegevens” aan
Het antwoordbericht wordt aangeboden aan de afzender.

1.3.4    Vul het auditlog

Het systeem registreert in de auditlog het resultaat van alle bovenstaande stappen. De volgende gegevens worden hierbij vastgelegd (zie ook Alternatieve scenario´s 8):

Gegevens auditlog Toelichting
Huidige datum en tijd Systeemdatum-tijd
Identificatie afzender DN uit het certificaat
BV BSN-berichtnummer Het toegekende BV BSN berichtnummer
Berichtnummer afzender Overnemen uit vraagbericht
Indicatie eindgebruiker/instantie Overnemen uit vraagbericht
Uitgevoerde actie de stap die uitgevoerd is
Resultaat van de uitgevoerde actie Resultaat van de uitgevoerde stap
Resultaatcode Berichtresultaatcode uit het antwoordbericht

Wanneer alle stappen met succes zijn doorlopen, worden de voorkomens van de betreffende stappen in het auditlog verwijderd.

Van het verwerkte bericht wordt één nieuw voorkomen aangemaakt met de volgende gegevens:

Gegevens auditlog Toelichting
Huidige datum en tijd Datum-tijd van de eerste stap van het auditlog van betreffende bericht
Identificatie afzender DN uit het certificaat
BV BSN-berichtnummer Het toegekende BV BSN berichtnummer
Berichtnummer afzender Overnemen uit vraagbericht
Indicatie eindgebruiker/instantie Overnemen uit vraagbericht
Uitgevoerde actie “Bericht verwerkt”
Resultaat van de uitgevoerde actie “Succesvol
Resultaatcode Berichtresultaatcode uit het antwoordbericht

2    Alternatieve Scenario’s

2.1    Alternatief 1: Autorisatie mislukt

Indien de autorisatie wordt geweigerd, wordt er een antwoordbericht aangemaakt en verstuurd naar de afzender van het bericht met daarin de melding “Afzender niet geautoriseerd” (berichtresultaat code 4).
Daarnaast wordt een melding in het systeemfoutenlogboek opgenomen. Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.2    Alternatief 2: Identificatie afzender in vraagbericht is niet gevuld

Indien het veld Identificatie afzender van het vraagbericht niet gevuld is, wordt de volgende foutmelding naar de afzender verstuurd ”De afzender van het bericht moet gevuld zijn” (berichtresultaat code 8). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.3    Alternatief 3: Berichtnummer afzender in vraagbericht is niet gevuld

Indien het veld berichtnummer afzender van het vraagbericht niet gevuld is, wordt de volgende foutmelding naar de afzender verstuurd ”Het berichtnummer van de afzender moet gevuld zijn” (berichtresultaat code 9). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.4    Alternatief 4: Indicatie eindgebruiker in vraagbericht is niet gevuld

Indien het veld indicatie eindgebruiker van het vraagbericht niet gevuld is, wordt de volgende foutmelding naar de afzender verstuurd ”De indicatie eindgebruiker van het bericht moet gevuld zijn” (berichtresultaat code 10). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.5    Alternatief 5: Vraagbericht bevat geen BSN

Indien er geen BSN is gevuld in het vraagbericht, wordt de volgende foutmelding naar de afzender verstuurd “BSN moet gevuld zijn” (berichtresultaatcode 28001). Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.6    Alternatief 6: Fout bij het ophalen van de gegevens.

Indien de BV BSN niet in staat is de gegevens uit het nummerregister op te halen wordt in het antwoordbericht de melding ”Er is een fout opgetreden” opgenomen (berichtresultaatcode 2). Daarnaast wordt een melding in het systeemfoutenlogboek opgenomen. Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.7    Alternatief 7: Geen resultaten gevonden

Indien er geen resultaten zijn gevonden, wordt de melding “Geen resultaat gevonden” (berichtresultaatcode 28002) in het antwoordbericht opgenomen. Hierna wordt verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.

2.8    Alternatief 8: Fout bij vullen auditlog

Indien het auditlog niet gevuld kan worden, wordt een melding in het systeemfoutenlogboek opgenomen. Aan de afzender van het bericht wordt de melding "Er is een fout opgetreden" (berichtresultaatcode 2) verstuurd. Indien het tussenstappen betreft wordt direct verdergegaan met de afronding, waarbij in het antwoordbericht de genoemde berichtresultaatcode en omschrijving worden opgenomen.
Indien het de laatste stap betreft, zal wel de beheerorganisatie, maar niet de afzender hierover geïnformeerd worden.
 

3    Subprocessen

Niet van toepassing.

4    Belangrijke Scenario’s

Niet van toepassing.

5    Precondities

Niet van toepassing.

6    Postcondities

Niet van toepassing.

7    Extensies

Niet van toepassing.

8    Speciale eisen

Niet van toepassing.

9    Aanvullende Informatie

9.1    Activiteitendiagram

Image
Activiendiagram

Delen

Naslagwerk

UC27 Genereren nummers

UC27 Genereren nummers


Inleiding

De use case “Genereren nummers” beschrijft het proces waarbij nieuwe nummers die kunnen worden toegekend als Burgerservicenummer worden gegenereerd en in het register worden opgenomen.

Voor de nummers gelden de volgende eisen:
•    Ieder gegenereerd nummer moet uniek zijn;
•    Ieder gegenereerd nummer mag slechts eenmaal worden uitgegeven;
•    Ieder gegenereerd nummer moet 9-cijferig zijn en aan de 11- proef voldoen;
•    Ieder gegenereerd nummer moet informatieloos zijn;
•    Er mag geen volgordelijkheid uit de nummers blijken;
•    Het nummer moet binnen het ingestelde interval liggen.

In onderstaand model is de use case “Genereren nummers” weergegeven:

Image
model gegereren nummers

1    Hoofdscenario

1.1    Initiatie

1.1.1    Start proces “Genereren nummers”

Binnen (en ten behoeve van) het systeem zijn processen actief die (na een instelbare periode) periodiek de use case “Genereren nummers” starten. (zie ook Alternatieve scenario’s 1)


1.2    Verwerking

1.2.1    Controle aantal aangemaakte nummers

Het systeem controleert hoeveel nummers er nog in het register zijn. Indien het gevonden aantal nummers groter is dan de “minimale voorraad” (dit is een instelbare variabele) dan wordt de use case afgerond. Zo niet, dan start het proces “bepaal gewenst aantal nieuwe nummers”.

1.2.2    Bepaal gewenst aantal nieuwe nummers

Er is een instelbare variabele “gewenste aantal nieuwe nummers”. Het gaat hierbij om het aantal nummers dat gegenereerd gaat worden.
De volgende stappen worden herhaald totdat het gewenst aantal nummers is aangemaakt en er meer nummers in het nummerregister staan dan de minimale voorraad.

1.2.3    Genereer nieuw nummer

pEr wordt binnen het ingestelde interval een willekeurig nummer (op basis van een randomgenerator, volgens een nondeterministisch algoritme) bepaald van 8 cijfers waarachter een negende cijfer wordt toegevoegd zodanig dat aan de elfproef wordt voldaan. In 1 op 11 gevallen is dit niet mogelijk waarna deze processtap (2.2.3) opnieuw wordt aangeroepen.

Van het nummer dat aan de 11-proef voldoet wordt nagegaan of het reeds in het nummerregister is opgenomen. Is dit het geval dan wordt deze processtap (2.2.3) opnieuw aangeroepen.

Het nummer wordt aan het nummerregister toegevoegd en krijgt de status ‘aangemaakt’. (zie ook Alternatieve scenario’s 2)

1.3    Afronding

Niet van toepassing

2    Alternatieve scenario’s

2.1    Alternatief 1: Opstarten genereer nummer mislukt

Indien het opstarten van het proces ´genereer nummer´ mislukt, wordt een melding in het systeemfoutenlogboek opgenomen.

2.2    Alternatief 2: Vastleggen nummer in nummerregister mislukt

Indien de vastlegging in het nummerregister mislukt dan blijft het nummerregister onveranderd en wordt er een melding

3    Subprocessen

Niet van toepassing.

4    Belangrijke scenario’s

Niet van toepassing.

5    Precondities

•    Een periode moet opgegeven zijn om deze use case te kunnen starten.

6    Postcondities

•    Na deze use case zijn er “minimale voorraad” of meer nummers beschikbaar.

7    Extensies

Niet van toepassing.

8    Speciale eisen

Het moet mogelijk zijn deze de processen fouttolerant op meerdere servers te installeren. Het is aanvaardbaar als dat er toe leidt dat er gelijktijdig meermalen “Gewenste aantal nieuwe nummers” worden gegenereerd.

9    Aanvullende informatie

9.1    Activiteitendiagram

Image
activiteitendiagram.jpg

Delen

Abonneer op Instructies
Scroll naar boven