GEBRUIKERSHANDLEIDING DOMEIN PERSOON WIJZIGKSZPERSOON 2.0. Versie /// 2.0 Publicatiedatum /// /// Gebruikershandleiding

Transcriptie

1 /// Gebruikershandleiding GEBRUIKERSHANDLEIDING DOMEIN PERSOON WIJZIGKSZPERSOON 2.0 Versie /// 2.0 Publicatiedatum ///

2 Informatie Vlaanderen /// Auteur: Elin Vanlierde Datum aanmaak: Wijzigingsdatum: Datum afdruk: Interne bestandsnaam: Gebruikershandleiding WijzigKSZPersoon 2.0 Documenthistoriek: Versie Opmerking Datum Auteur Status 0.1 Eerste versie Jan Van Geert Concept 0.2 Review Michaël Loedts Concept 0.3 Verwerking review Jan Van Geert Concept 1.0 Publicatie Jan Van Geert Finale versie 2.0 Nieuwe lay-out Elin Vanlierde Finale versie 2 /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

3 /// Informatie Vlaanderen INHOUD Inhoud Inleiding Verklarende woordenlijst Doel Opbouw document Algemeen Omgevingsinformatie Functionaliteiten Leverancier van de gegevens Gebruiksvoorwaarden Batch Interface Vraag Algemeen XSD visueel Detail Naam Nationaliteit Geboorte Overlijden Geslacht Burgerlijke Staten Hoofdverblijfplaats Voorbeelden Antwoord Algemeen Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

4 Informatie Vlaanderen /// XSD visueel XSD in detail Codetabellen en foutcodes Codetabellen Resultaat Geslacht Foutcodes Runtime Fouten Voorbeeld uitzonderingen Werking Opvraging Logging Beschikbaarheid Testgegevens en voorbeelden Testgegevens Voorbeelden Wijzigingen ten opzichte van 01.x Vraag Antwoord Contactgegevens /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

5 /// Informatie Vlaanderen 1 INLEIDING 1.1 VERKLARENDE WOORDENLIJST Term GW BD KSZ Omschrijving Maximale gegevensdeling tussen administraties Gateway Businessdienst Kruispuntbank Sociale Zekerheid 1.2 DOEL De dienst WijzigKSZPersoon 2.0 geeft de afnemer de mogelijkheid een persoon te wijzigen in de registers van KSZ. 1.3 OPBOUW DOCUMENT Het algemeen overzicht van de functionaliteiten en het gebruik van deze webservice is opgenomen in hoofdstuk 2. Hoofdstuk 3 behandelt de interface van de webservice, dit zowel de Vraag als Antwoord inclusief voorbeelden en bevindingen. Hoofstuk 4 bevat de codetabellen. Hoofdstuk 5 geeft meer informatie over de werking. Hoofdstuk 6 bevat informatie voor het uitvoeren van testen alsook de nodige voorbeelden. Hoofdstuk 7 bevat de verschillen met de vorige versie. De contactgegevens zijn opgenomen in hoofdstuk 8. Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

6 Informatie Vlaanderen /// 2 ALGEMEEN 2.1 OMGEVINGSINFORMATIE Domein: Persoon Naam: WijzigKSZPersoon Versie: Classificatie: Privacy gevoelig 2.2 FUNCTIONALITEITEN De request bestaat uit de te wijzigen gegevens van een persoon en diens INSZ-nummer. De mogelijk te wijzigen gegevens zijn: - Naam - Nationaliteiten - Geboorte - Overlijden - Geslacht - BurgerlijkeStaten - Hoofdverblijfplaats Indien een wijziging niet slaagt krijgt de afnemer een uitzondering terug met de reden waarom de wijziging niet geslaagd is. Het antwoord bevat de persoon met de gewijzigde gegevens 2.3 LEVERANCIER VAN DE GEGEVENS De authentieke bron van de gegevens is de KSZ. Het platform is dan ook afhankelijk van deze bronnen voor de kwaliteit en de aanlevering van de gegevens. 2.4 GEBRUIKSVOORWAARDEN Afnemers moeten aan volgende voorwaarden voldoen om deze webservice te mogen gebruiken: Toelating tot het platform 6 /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

7 /// Informatie Vlaanderen Machtiging van het sectoraal comité van het Rijksregister EN/OF Machtiging van het sectoraal comité van de Sociale Zekerheid Meer informatie over deze voorwaarden is terug te vinden in het document Machtigingen en toelatingen [MT]. 2.5 BATCH Deze webservice is eveneens beschikbaar in een batch-variant (enkel XML). Hiervoor moet men de Service-XSD gebruiken en niet de Webservice. Door de Service-XSD te gebruiken zijn er meerdere vragen mogelijk in één bestand. De vraag-bestanden worden op de FTP geplaatst in een afnemer specifieke folder. Deze folder wordt tijdens het aansluitingsproces toegekend. Als prefix voor de batchbestanden wordt WKPD gebruikt. Meer informatie hierover kan u vinden via Aansluiting op het -platform in het document MS Gebruikershandleiding_WebserviceInBatch, of neem contact op met helpdesk.magda@vlaanderen.be. Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

8 Informatie Vlaanderen /// 3 INTERFACE 3.1 VRAAG Algemeen De vraag bestaat uit het INSZ-nummer van de te wijzigen persoon en de gegevens die men wenst te wijzigen. Deze kunnen zijn: - Naam - Nationaliteiten - Geboorte - Overlijden - Geslacht - BurgerlijkeStaten - Hoofdverblijfplaats XSD visueel 8 /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

9 /// Informatie Vlaanderen Detail Naam Element Achternaam Voornamen Voornaam Omschrijving Naam van de persoon, bevat de achternaam en eventueel voorna(a)m(en) Begindatum van de gegevens Achternaam van de persoon, string, maximum 48 karakters Bevat de voornamen van de persoon Voornaam van de persoon, string, maximum 48 karakters. Indien er meerdere voornamen ingegeven worden, wordt er een sequence toegevoegd naargelang de volgorde ingegeven in de vraag. (eerste voornaam krijgt 1 enzovoort, tot maximum 3) <Naam DatumBegin=" "> <Achternaam>Castafiore</Achternaam> <Voornamen> <Voornaam>Bianca</Voornaam> </Voornamen> </Naam> Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

10 Informatie Vlaanderen /// Nationaliteit Element LandNISCode Omschrijving De nationaliteit(en) van de persoon De nationaliteit van de persoon, a.d.h.v. de NIS-Code van het land Begindatum van de gegevens Einddatum van de gegevens De NIS-Code van het land waarmee de nationaliteit bepaald wordt. <Nationaliteiten> <Nationaliteit DatumBegin=" "> <LandNISCode>150</LandNISCode> </Nationaliteit> </Nationaliteiten> 10 /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

11 /// Informatie Vlaanderen Geboorte Element Geboorte Datum Plaats Gemeente NISCode Postcode Naam Land NISCode ISOCode Naam Omschrijving De geboortegegevens van de persoon, bevat datum en plaats. De geboortedatum van de persoon De plaats waar de persoon geboren is De gemeente waar de persoon geboren is, bevat NIS-Code, Postcode en naam NIS-code van de gemeente, wordt door KSZ overgenomen indien aanwezig Postcode van de gemeente, wordt niet overgenomen Naam van de gemeente, wordt door KSZ overgenomen indien aanwezig Land waar de persoon geboren is NIS-Code van het land, wordt overgenomen ISO-Code van het land, wordt niet overgenomen Naam van het land, wordt door KSZ overgenomen indien aanwezig <Geboorte> <Datum> </Datum> <Plaats> <Gemeente> Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

12 Informatie Vlaanderen /// <NISCode>41002</NISCode> <PostCode>9300</PostCode> <Naam>Aalst</Naam> </Gemeente> <Land> <NISCode>150</NISCode> <ISOCode>BEL</ISOCode> <Naam>België</Naam> </Land> </Plaats> </Geboorte> Overlijden Element Overlijden Datum Plaats Gemeente Omschrijving Bevat de gegevens omtrent het overlijden van de persoon De overlijdensdatum van de persoon De plaats waar de persoon overleden is De gemeente waar de persoon overleden is, bevat NIS-Code, Postcode en naam 12 /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

13 /// Informatie Vlaanderen Land NISCode Postcode Naam NISCode ISOCode Naam NIS-code van de gemeente, wordt overgenomen indien aanwezig Postcode van de gemeente, wordt niet overgenomen Naam van de gemeente, wordt overgenomen indien aanwezig Land waar de persoon overleden is NIS-Code van het land, wordt overgenomen ISO-Code van het land, wordt niet overgenomen Naam van het land, wordt overgenomen indien aanwezig <Overlijden> <Datum> </Datum> <Plaats> <Gemeente> <NISCode>41002</NISCode> <PostCode>9300</PostCode> <Naam>Aalst</Naam> </Gemeente> <Land> <NISCode>150</NISCode> <ISOCode>BEL</ISOCode> <Naam>België</Naam> </Land> </Plaats> </Overlijden> Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

14 Informatie Vlaanderen /// Geslacht Element Code Omschrijving Geslacht van de persoon, a.d.h.v. een code Begindatum van de gegevens Code die geslacht weergeeft; 1=Mannelijk, 2=Vrouwelijk, dit wordt in runtime gemapt naar de KSZ-waarden. (1=M, 2=F) <Geslacht DatumBegin=" "> </Geslacht> <Code>2</Code> Burgerlijke Staten 14 /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

15 /// Informatie Vlaanderen Element Code Partner Plaats Gemeente NISCode Postcode Naam Land NISCode ISOCode Naam Omschrijving Omvat de burgerlijke staten van de persoon Burgerlijke staat van de persoon Begindatum van de burgerlijke staat, wordt overgenomen door KSZ Einddatum van de burgerlijke staat, wordt overgenomen indien aanwezig. Code die burgerlijke staat weergeeft Partner waarmee de persoon een bepaalde burgerlijke staat heeft, wordt overgenomen indien aanwezig Plaats van creatie van burgerlijke staat De gemeente, bevat NIS-Code, Postcode en naam van de gemeente NIS-code van de gemeente, wordt overgenomen indien aanwezig Postcode van de gemeente, wordt niet overgenomen Naam van de gemeente, wordt overgenomen indien aanwezig Land, bevat NIS-Code, ISO-Code en naam van het land NIS-Code van het land, wordt overgenomen door KSZ ISO-Code van het land, wordt niet overgenomen Naam van het land, wordt overgenomen indien aanwezig <BurgerlijkeStaat DatumBegin=" "> <Code Beschrijving="Gehuwd">20</Code> <Omschrijving Oorsprong="KSZ">Gehuwd</Omschrijving> <Partner> <INSZ>XXX11520XXX</INSZ> <Naam> <Achternamen> <Achternaam>Adriaens</Achternaam> </Achternamen> <Voornamen> Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

16 Informatie Vlaanderen /// <Voornaam>Lieve</Voornaam> <Voornaam>Lucille</Voornaam> </Voornamen> </Naam> </Partner> <Plaats> <Gemeente> <NISCode>44021</NISCode> <Naam>Gent</Naam> </Gemeente> <Land> <NISCode>150</NISCode> <ISOCode>BEL</ISOCode> <Naam>België</Naam> </Land> </Plaats> </BurgerlijkeStaat> Hoofdverblijfplaats 16 /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

17 /// Informatie Vlaanderen Element Straat Code Naam Huisnummer Busnummer Gemeente NISCode PostCode Naam Land NISCode ISOCode Naam Omschrijving Bevat de gegevens van de hoofdverblijfplaats van de persoon. Bevat de gegevens van de straat De code de straat, wordt overgenomen indien aanwezig De straatnaam, wordt overgenomen indien aanwezig Het huisnummer van de woonst van de persoon, wordt overgenomen indien aanwezig Het busnummer van de woonst van de persoon, wordt overgenomen indien aanwezig De gemeente, bevat NIS-Code, Postcode en naam van de gemeente NIS-code van de gemeente, wordt overgenomen indien aanwezig Postcode van de gemeente, wordt niet overgenomen Naam van de gemeente, wordt overgenomen indien aanwezig Land, bevat NIS-Code, ISO-Code en naam van het land NIS-Code van het land Wordt niet overgenomen Naam van het land, wordt overgenomen indien aanwezig <Hoofdverblijfplaats DatumBegin=" "> <Straat> <Code>61451</Code> <Naam>Aartstraat</Naam> </Straat> <Huisnummer>10</Huisnummer> <Gemeente> <NISCode>41002</NISCode> <PostCode>9300</PostCode> <Naam>Aalst</Naam> Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

18 Informatie Vlaanderen /// </Gemeente> <Land> <NISCode>150</NISCode> <ISOCode>BEL</ISOCode> <Naam>België</Naam> </Land> </Hoofdverblijfplaats> Voorbeelden Naam en Geboortegegevens <Vragen> <Vraag> <Referte>referte</Referte> <Inhoud> <Persoon> <Naam DatumBegin=" "> <Achternaam>De Tester</Achternaam> <Voornamen> <Voornaam>Charel</Voornaam> </Voornamen> </Naam> <Nationaliteiten> <Nationaliteit DatumBegin=" "> <LandNISCode>150</LandNISCode> </Nationaliteit> </Nationaliteiten> <Geboorte> <Datum> </Datum> </Geboorte> 18 /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

19 /// Informatie Vlaanderen </Persoon> </Inhoud> </Vraag> </Vragen> Een volledig voorbeeld is terug te vinden in hoofdstuk ANTWOORD Algemeen In grote lijnen bevat WijzigKSZPersoon 2.0 volgende gegevens: - Resultaat, dit geeft weer of de wijziging al dan niet geslaagd is. - Gegevens van de persoon met gewijzigde gegevens incluis. - INSZ-Nummer. - Naam. - Geslacht. - Nationaliteiten. - Geboorte. - Overlijden. - BurgerlijkeStaten. - Hoofdverblijfplaats Niet alle gegevens weergegeven in de XSD komen terug van de KSZ. In dit document worden enkel de gegevens besproken die terugkomen van de bron. Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

20 Informatie Vlaanderen /// XSD visueel 20 /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

21 /// Informatie Vlaanderen XSD in detail Resultaat Gegeven Resultaat Beschrijving Uitleg Dit geeft aan of de wijziging van de persoon al dan niet geslaagd is (0 of 1) Beschrijving van de code in het resultaat, 0= Niet geslaagd, 1= Wel geslaagd <Inhoud> <Resultaat Beschrijving="Wel geslaagd">1</resultaat> <Persoon> < > </Persoon> </Inhoud> INSZ Gegeven INSZ Uitleg INSZ van de persoon de gewijzigde persoon. <INSZ>xxxx112xxxx</ INSZ > Naam Achternaam Voornaam Uitleg Attribuut, geeft de start van het gegeven weer Achternaam van de persoon, er kan maximum 1 Achternaam terugkomen. Voornaam van de persoon, er kunnen tot 3 voornamen terugkomen <Naam DatumBegin=" "> <Achternaam>De Koster</Achternaam> <Voornamen> <Voornaam>Bart</Voornaam> Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

22 Informatie Vlaanderen /// </Naam> </Voornamen> <Voornaam>Lieve</Voornaam> Geslacht Gegeven Code Beschrijving Uitleg Code die het geslacht van de persoon weergeeft. (1=Mannelijk; 2=Vrouwelijk) Beschrijving van de code van het geslacht komende van, 1= Mannelijk, 2= Vrouwelijk <Geslacht DatumBegin=" "> </Geslacht> <Code Beschrijving="Mannelijk">1</Code> Nationaliteiten Gegeven Code Uitleg De nationaliteitscode (dit is meestal de NIS code van een land, maar het kan bv. ook een code zijn die wijst op een vluchteling of staatloze). <Nationaliteiten> <Nationaliteit DatumBegin=" "> <Code>150</Code> <Omschrijving>België</Omschrijving> </Nationaliteit> </Nationaliteiten> Geboorte Gegeven Datum Uitleg Geboortedatum van de persoon 22 /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

23 /// Informatie Vlaanderen Plaats Bewijsstuk Plaats waar de persoon geboren is, dit bevat de gemeente en het land. Gemeente: - NISCode - Naam Land: - NISCode - ISOCode (Toegevoegd door ) - Naam Het bewijsstuk dat gebruikt werd om de geboorte te staven <Geboorte> <Datum> </Datum> <Plaats> <Gemeente> <NISCode>85029</NISCode> <Naam>Rossignol</Naam> </Gemeente> <Land> <NISCode>150</NISCode> <ISOCode>BEL</ISOCode> <Naam>België</Naam> </Land> </Plaats> </Geboorte> Overlijden Gegeven Datum Plaats Uitleg Datum van overlijden Plaats van overlijden, dit bevat de gemeente en het land Gemeente: - NISCode - Naam Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

24 Informatie Vlaanderen /// Land: - NISCode - ISOCode - Naam <Overlijden> <Datum> </Datum> <Plaats> <Gemeente> <NISCode>85039</NISCode> <Naam>Tintigny</Naam> </Gemeente> <Land> <NISCode>150</NISCode> <ISOCode>BEL</ISOCode> <Naam>België</Naam> </Land> </Plaats> </Overlijden> BurgerlijkeStaten Code Beschrijving Partner Plaats Uitleg Attribuut, dit geeft het begin van de gegevens weer. Code die de burgerlijke stand weergeeft Beschrijving van de code van de burgerlijke stand, komende van. Gegevens van de partner, dit bevat het INSZ (of referentienummer) van de partner en diens achter- en voornaam Plaats van het gebeuren, dit bevat de gemeente en het land. Gemeente: - NISCode - Naam 24 /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

25 /// Informatie Vlaanderen Land: - NISCode - ISOCode - Naam <BurgerlijkeStaat DatumBegin=" "> <Code Beschrijving="Gehuwd">20</Code> <Omschrijving Oorsprong="KSZ">Gehuwd</Omschrijving> <Partner> <INSZ>XXX81106XXX</INSZ> <Naam> <Achternamen> <Achternaam>Rossignon</Achternaam> </Achternamen> <Voornamen> <Voornaam>Octave</Voornaam> <Voornaam>Joseph</Voornaam> <Voornaam>Laurent</Voornaam> </Voornamen> </Naam> </Partner> <Plaats> <Gemeente> <NISCode>85029</NISCode> <Naam>Rossignol</Naam> </Gemeente> <Land> <NISCode>150</NISCode> <ISOCode>BEL</ISOCode> <Naam>België</Naam> </Land> Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

26 Informatie Vlaanderen /// </Plaats> </BurgerlijkeStaat> Hoofdverblijfplaats Straat Huisnummer & Busnummer Gemeente (+ postcode) en land Uitleg Attribuut, de begindatum van de gegevens. Straat waar de hoofdverblijfplaats zich bevindt. Dit bevat een code die de straat specifieert en de straatnaam. Huis- & busnummer van de hoofdverblijfplaats Gemeente en land van de hoofdverblijfplaats Gemeente: - NISCode - PostCode - Naam Land: - NISCode - ISOCode - Naam <Hoofdverblijfplaats DatumBegin=" "> <Straat> <Code>3120</Code> <Naam>Rue de Chiny,Rossignol</Naam> </Straat> <Huisnummer>45</Huisnummer> <Gemeente> <NISCode>85039</NISCode> <PostCode>6730</PostCode> <Naam>Tintigny</Naam> </Gemeente> <Land> 26 /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

27 /// Informatie Vlaanderen <NISCode>150</NISCode> <ISOCode>BEL</ISOCode> <Naam>België</Naam> </Land> </Hoofdverblijfplaats> Voorbeeld: Wijziging geslaagd <Antwoord> <Referte> </Referte> <Inhoud> <Resultaat Beschrijving="Wel geslaagd">1</resultaat> <Persoon> <INSZ> </INSZ> <Naam DatumBegin=" "> <Achternamen> <Achternaam>Tester</Achternaam> </Achternamen> <Voornamen> <Voornaam>Mark</Voornaam> </Voornamen> </Naam> <Geslacht DatumBegin=" "> <Code Beschrijving="Vrouwelijk">2</Code> </Geslacht> <Register> <Code>BIS</Code> </Register> <Nationaliteiten> <Nationaliteit DatumBegin=" "> <Code>103</Code> Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

28 Informatie Vlaanderen /// <Omschrijving Oorsprong="KSZ" TaalCode="nl"> Duitsland (Dem. rep.)</omschrijving> </Nationaliteit> </Nationaliteiten> <Geboorte> <Datum> </Datum> <Plaats> <Gemeente> <NISCode>44021</NISCode> <Naam>Gent</Naam> </Gemeente> <Land> <NISCode>150</NISCode> <ISOCode>BEL</ISOCode> <Naam>België</Naam> </Land> </Plaats> </Geboorte> <Overlijden> <Datum> </Datum> <Plaats> <Gemeente> <NISCode>44021</NISCode> <Naam>Gent</Naam> </Gemeente> <Land> <NISCode>150</NISCode> <ISOCode>BEL</ISOCode> <Naam>België</Naam> </Land> 28 /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

29 /// Informatie Vlaanderen </Plaats> </Overlijden> <BurgerlijkeStaten> <BurgerlijkeStaat DatumBegin=" "> <Code>20</Code> <Omschrijving Oorsprong="KSZ" TaalCode="nl">Getrouwd</Omschrijving> <Plaats> <Gemeente> <NISCode>41002</NISCode> <Naam>Aalst</Naam> </Gemeente> <Land> <NISCode>150</NISCode> <ISOCode>BEL</ISOCode> <Naam>België</Naam> </Land> </Plaats> </BurgerlijkeStaat> </BurgerlijkeStaten> <Adressen> <Hoofdverblijfplaats DatumBegin=" "> <Straat> <Code>2101</Code> <Naam>Aaigemstraat</Naam> </Straat> <Huisnummer>10</Huisnummer> <Gemeente> <NISCode>44021</NISCode> <PostCode>9000</PostCode> Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

30 Informatie Vlaanderen /// <Naam>Gent</Naam> </Gemeente> <Land> <NISCode>150</NISCode> <ISOCode>BEL</ISOCode> <Naam>België</Naam> </Land> </Hoofdverblijfplaats> </Adressen> </Persoon> </Inhoud> </Antwoord> Voorbeeld 2: Wijziging mislukt, datum geboorte te vroeg. <Antwoord> <Referte>referte</Referte> <Inhoud> <Resultaat Beschrijving="Niet geslaagd">0</resultaat> </Inhoud> <Uitzonderingen> <Uitzondering> <Identificatie>48000</Identificatie> <Oorsprong></Oorsprong> <Type>FOUT</Type> <Tijdstip> <Datum> </Datum> <Tijd>13:50:30.704</Tijd> </Tijdstip> <Diagnose>Validatiefout opgetreden</diagnose> <Omstandigheid>MSG00008</Omstandigheid> 30 /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

31 /// Informatie Vlaanderen </Uitzondering> <Uitzondering> <Identificatie>48025</Identificatie> <Oorsprong></Oorsprong> <Type>FOUT</Type> <Tijdstip> <Datum> </Datum> <Tijd>13:50:30.743</Tijd> </Tijdstip> <Diagnose>Geboorte: De ingangsdatum ligt voor de ingangsdatum van een andere gegevensgroep</diagnose> <Omstandigheid>301438</Omstandigheid> <Annotaties> <Annotatie> <Naam>Datagroup</Naam> <Waarde>birth</Waarde> </Annotatie> <Annotatie> <Naam>SSIN</Naam> <Waarde> </Waarde> </Annotatie> </Annotaties> </Uitzondering> </Uitzonderingen> </Antwoord> Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

32 Informatie Vlaanderen /// 4 CODETABELLEN EN FOUTCODES 4.1 CODETABELLEN Dit zijn de voor KSZ, op dit moment gekende codes (februari 16). Hou er rekening mee dat codes en omschrijvingen (of Beschrijvingen) kunnen wijzigen Resultaat Code Beschrijving 0 Niet geslaagd 1 Wel geslaagd Geslacht Code Beschrijving 1 Mannelijk 2 Vrouwelijk 4.2 FOUTCODES Wat betreft de Uitzonderingen wordt dezelfde werking gevolgd als de overige webservices. Enkel de dienst-specifieke foutcodes zijn opgenomen in het overzicht. Voor een volledig overzicht van de foutcodes wordt verwezen naar de generieke handleiding. Het is steeds mogelijk dat er in de toekomst foutcodes toegevoegd worden. 32 /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

33 /// Informatie Vlaanderen Identificatie Niveau Type Diagnose Oorsprong FOUT Persoon maar gedeeltelijk gewijzigd FOUT Persoon niet gewijzigd FOUT Persoon bevindt zich in een register waarvoor geen wijzigingen ondersteund worden FOUT De informatie is niet aangepast, maar door gestuurd naar de sector die meester is over deze informatie FOUT De vorige situatie van de gegevensgroep "Naam" in de voorlegging is verschillend van de informatie opgenomen in de KSZ-registers FOUT De vorige situatie van de gegevensgroep "Nationaliteit" in de voorlegging is verschillend van de informatie opgenomen in de KSZ-registers FOUT De vorige situatie van de gegevensgroep "Geslacht" in de voorlegging is verschillend van de informatie opgenomen in de KSZ-registers FOUT De vorige situatie van de gegevensgroep "Geboorte" in de voorlegging is verschillend van de informatie opgenomen in de KSZ-registers FOUT De vorige situatie van de gegevensgroep "Burgerlijke staat" in de voorlegging is verschillend van de informatie opgenomen in de KSZ-registers FOUT De vorige situatie van de gegevensgroep "Overlijden" in de voorlegging is verschillend van de informatie opgenomen in de KSZ-registers FOUT De vorige situatie van de gegevensgroep "Verblijfsadres" in de voorlegging is verschillend van de informatie opgenomen in de KSZ-registers FOUT INSZ van het type BIS werd vervangen door INSZ van Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

34 Informatie Vlaanderen /// het type rijksregister FOUT INSZ van het type BIS werd vervangen door INSZ van het type BIS FOUT INSZ van het type rijksregister werd vervangen door INSZ van het type rijksregister FOUT Het opgegeven INSZ kan enkel van het BIS- of RAD-type zijn FOUT Geen nieuwe informatie voor de gegevensgroep "Geslacht" FOUT Geen nieuwe informatie voor de gegevensgroep "Geboorte" FOUT Geboorteplaatscode geeft verlies tot informatie FOUT Syntax van de geboorteplaats is niet correct FOUT De vorige situatie van de gegevensgroep "Geboorte" in de voorlegging is verschillend van de informatie opgenomen in de KSZ-registers FOUT Geslacht: De ingangsdatum ligt voor de geboortedatum FOUT Geslacht: De ingangsdatum ligt in de toekomst FOUT Geslacht: De geregistreerde ingangsdatum ligt voor de minimaal toegestane datum (KSZ-datum) FOUT Geslacht: De geregistreerde ingangsdatum ligt voor de minimaal toegestane datum (KSZ-datum) FOUT De vorige situatie van de gegevensgroep "Geslacht" in de voorlegging is verschillend van de informatie opgenomen in de KSZ-registers FOUT Geen nieuwe informatie voor de gegevensgroep "Naam" FOUT Voornaam geeft verlies tot informatie FOUT Naam: Ingangsdatum is eerder dan datum in KSZ-register 34 /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

35 /// Informatie Vlaanderen FOUT Naam: De ingangsdatum ligt voor de geboortedatum FOUT Naam: De ingangsdatum is later dan de overlijdensdatum FOUT De geregistreerde ingangsdatum ligt voor de minimaal toegestane datum (KSZ-datum FOUT De vorige situatie van de gegevensgroep "Naam" in de voorlegging is verschillend van de informatie opgenomen in de KSZ-registers FOUT Geen nieuwe informatie voor de gegevensgroep "Nationaliteit" FOUT Nationaliteit: De set van de informatie in het verzoek is niet verenigbaar met de bestaande gegevens in het KSZ-Register FOUT Nationaliteit: De vervaldatum in het verzoek ligt vóór de ingangsdatum of de ingangsdatum in het verzoek ligt vóór die in het KSZ-register FOUT Nationaliteit: De ingangsdatum ligt voor de geboortedatum FOUT Nationaliteit: De ingangsdatum is later dan de overlijdensdatum FOUT Nationaliteit: De ingangsdatum is later dan de overlijdensdatum FOUT Nationaliteit: De geregistreerde ingangsdatum ligt voor de minimaal toegestane datum (KSZ-datum) FOUT Nationaliteit: De vervaldatum ligt na de overlijdensdatum voor de gegevensgroep Nationaliteit FOUT Nationaliteit: De vervaldatum ligt in de toekomst voor de gegevensgroep Nationaliteit FOUT De vorige situatie van de gegevensgroep "Nationaliteit" in de voorlegging is verschillend van de informatie opgenomen in de KSZ-registers. Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

36 Informatie Vlaanderen /// FOUT Bestaande en/of nieuwe nationaliteiten met identieke code mogen niet overlappen in periode FOUT Geen nieuwe informatie voor de gegevensgroep "Burgerlijke stand" FOUT De set van de informatie in het verzoek is niet verenigbaar met de bestaande gegevens in het KSZ-Register voor de gegevensgroep "Burgerlijke stand" FOUT De vervaldatum in het verzoek ligt vóór de ingangsdatum of de ingangsdatum in het verzoek ligt vóór die in het KSZregister voor de gegevensgroep "Burgerlijke stand" FOUT Burgerlijke staat: De ingangsdatum ligt voor de geboortedatum FOUT Burgerlijke staat: De geregistreerde ingangsdatum FOUT Burgerlijke staat: Syntax van de locatie bij burgerlijke stand is niet correct FOUT De vervaldatum ligt na de overlijdensdatum voor de gegevensgroep "Burgerlijke stand" FOUT De vervaldatum ligt in de toekomst voor de gegevensgroep "Burgerlijke stand" FOUT De vorige situatie van de gegevensgroep "Burgerlijke staat" in de voorlegging is verschillend van de informatie opgenomen in de KSZ-registers FOUT De code "burgerlijke staat" wordt gewijzigd in "ongehuwd" terwijl vroeger een andere code dan ongehuwd actief was FOUT Men kan geen burgerlijk staat hebben met zichzelf als partner FOUT Een burgerlijke staat verschillend van onbepaald (90) kan niet naar onbepaald gewijzigd worden (90) FOUT De burgerlijke staat ongehuwd (10) kan niet gewijzigd worden naar onbepaald (90) 36 /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

37 /// Informatie Vlaanderen FOUT Geen nieuwe informatie voor de gegevensgroep "Overlijden" FOUT Overlijden: De ingangsdatum ligt voor de geboortedatum FOUT Overlijden: De geregistreerde ingangsdatum ligt voor de minimaal toegestane datum (KSZ-datum) FOUT Syntax van de code van de overlijdensplaats ongeldig FOUT De locatie bij overlijden geeft een verlies tot informatie FOUT De overlijdensdatum ligt vóór de vervaldatum van een andere gegevensgroep FOUT De vorige situatie van de gegevensgroep "Overlijden" in de voorlegging is verschillend van de informatie opgenomen in de KSZ-registers FOUT Geen nieuwe informatie voor de gegevensgroep "Verblijfsadres" FOUT Adres: De straat geeft een verlies tot informatie FOUT Adres: Ingangsdatum is eerder dan datum in KSZ-register FOUT Adres: De ingangsdatum ligt voor de geboortedatum FOUT Adres: De ingangsdatum is later dan de overlijdensdatum FOUT Adres: De geregistreerde ingangsdatum ligt voor de minimaal toegestane datum (KSZ-datum) FOUT Adres: De vorige situatie van de gegevensgroep "Verblijfsadres" in de voorlegging is verschillend van de informatie opgenomen in de KSZ-registers Runtime Fouten Identificatie Diagnose Landgegeven van de bron niet gekend binnen Magda, contacteer VIP Broncode niet aanwezig voor opgegeven Magda code in de vraag, contacteer VIP Magda code niet aanwezig voor teruggekomen broncode, contacteer VIP Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

38 Informatie Vlaanderen /// Magda beschrijving voor code niet aanwezig, contacteer VIP Ongekende foutcode van de bron, contacteer VIP Voorbeeld uitzonderingen Voorbeeld 1: <Uitzondering> <Identificatie>48028</Identificatie> <Oorsprong></Oorsprong> <Type>FOUT</Type> <Tijdstip> <Datum> </Datum> <Tijd>10:00:00.000</Tijd> </Tijdstip> <Diagnose>Syntax van de naam is niet correct</diagnose> <Annotaties> <Annotatie> <Naam>Achternaam</Naam> <Waarde>De </Annotatie> </Annotaties> </Uitzondering> Voorbeeld 2: <Uitzondering> <Identificatie>99986</Identificatie> <Oorsprong></Oorsprong> <Type>FOUT</Type> <Tijdstip> <Datum> </Datum> 38 /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

39 /// Informatie Vlaanderen <Tijd>14:16:02.848</Tijd> </Tijdstip> <Diagnose>Ongekende foutcode van de bron, contacteer VIP</Diagnose> <Omstandigheid>301782</Omstandigheid> </Uitzondering> Voorbeeld 3: <Uitzondering> <Identificatie>99981</Identificatie> <Oorsprong></Oorsprong> <Type>WAARSCHUWING</Type> <Tijdstip> <Datum> </Datum> <Tijd>09:03:39.391</Tijd> </Tijdstip> <Diagnose>Land gegevens van de bron niet gekend binnen Magda, contacteer VIP</Diagnose> <Annotaties> <Annotatie> <Naam>LandNISCode</Naam> <Waarde>159</Waarde> </Annotatie> </Annotaties> </Uitzondering> Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

40 Informatie Vlaanderen /// 5 WERKING 5.1 OPVRAGING Van zodra de vraag (in deze dienst is dat de wijziging van de gegevens van een persoon) gesteld is wordt er een XSD-validatie uitgevoerd. Is de ontvangen vraag XML niet geldig tegenover het schema, dan stopt de verwerking en wordt een foutmelding aangemaakt, anders gaat de verwerking verder. Na de XSD-validatie vinden de nodige authenticatie- en autorisatiecontroles plaats. Hierna vindt de functionele validatie plaats (bijvoorbeeld Checksum 97 op het INSZ). Eens al deze controles geslaagd zijn wordt achterliggend de GeefPersoon-dienst opgeroepen, deze vult de bestaande persoonsgegevens aan in de vraag. Op deze wijze ontstaat er een structuur met een nieuwe persoon (de gewijzigde gegevens) en een oude persoon (de gegevens opgehaald met GeefPersoon 2.0). Deze samengestelde vraag wordt doorgestuurd naar KSZ. Bij KSZ gebeurd er een controle op de gegevens om te kijken of deze niet conflicteren met de bestaande gegevens in de registers. Indien niet geeft KSZ in het antwoord terug dat de wijziging geslaagd is, indien er een conflict opgetreden is stuurt KSZ een uitzondering in het antwoord met de reden waarom de wijziging niet geslaagd is. Dit antwoord wordt gevalideerd tegenover de XSD waarna het aan de afnemer ter beschikking gesteld wordt. 5.2 LOGGING De opvragingen die gebeuren via deze webservice worden bewaard zoals beschreven in het document logging [ML]. 5.3 BESCHIKBAARHEID De webservice op het platform is 24 uur op 24 en 7 dagen op 7 beschikbaar. Bij geplande onbeschikbaarheden worden de afnemers op de hoogte gebracht via mail. 40 /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

41 /// Informatie Vlaanderen 6 TESTGEGEVENS EN VOORBEELDEN 6.1 TESTGEGEVENS Wat betreft de T&I omgeving is het mogelijk om productieve data te registreren. Testgegevens voor de wijziging zijn beperkt tot eenmalig gebruik. Indien dezelfde gegevens een tweede maal ingevoerd worden is het resultaat Niet geslaagd, dit omdat de gegevens al bestaan. Dit heeft als gevolg dat elke testcase voor wijziging een unieke case moet zijn. 6.2 VOORBEELDEN Voorbeelden zijn terug te vinden in de hiervoor opgezette mappen. Van de voorbeelden zijn steeds vraag als antwoord beschikbaar. Voorbeeld Bestandsnaam Voorbeeld 1: Geslaagde wijziging van een persoon Vraag en Antwoord 1 Voorbeeld 2: Persoon maar gedeeltelijk gewijzigd Vraag en Antwoord 2 Voorbeeld 3: Geen nieuwe informatie voor een gegevensgroep Vraag en Antwoord 3 Voorbeelden.zip Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

42 Informatie Vlaanderen /// 7 WIJZIGINGEN TEN OPZICHTE VAN 01.X Dit hoofdstuk bespreekt de wijzigingen ten opzichte van WijzigKSZPersoon Gegeven ReferentiePersoon GeboorteGeslacht GeboortePlaats TweedeVoornaam VoornaamVolledigVlag AnderAdres Wijziging In de vorige versie van de dienst diende een referentiepersoon opgegeven te worden, dit is in deze versie niet meer het geval. In de nieuwe versie wordt deze automatisch opgesteld met de achterliggende dienst GeefPersoon. Geboorte en Geslacht zijn twee aparte elementen geworden, in de vorige versie van de dienst stonden deze samen onder 1 element genaamd GeboorteGeslacht. GeboortePlaats was in de vorige versie een apart element, dit valt nu onder het element Geboorte. Indien een persoon meerdere voornamen (max 2) werd dit gemapt onder TweedeVoornaam, in de huidige dienst kan het element Voornaam meerdere malen voorkomen. Dit is afwezig in de nieuwe dienst. In de vorige dienst was het mogelijk een ander type adres dan het HoofdAdres in te geven, in de huidige dienst is dit niet het geval. 42 /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

43 /// Informatie Vlaanderen 7.1 VRAAG Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

44 Informatie Vlaanderen /// 7.2 ANTWOORD /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0

45 /// Informatie Vlaanderen Gebruikershandleiding - Domein Persoon WijzigKSZPersoon 2.0 /// /// 46

46 Informatie Vlaanderen /// 8 CONTACTGEGEVENS Informatie Vlaanderen is elke werkdag bereikbaar van 9.00 tot uur. Postadres: Herman Teirlinckgebouw - Havenlaan 88, 1000 Brussel Virginie Lovelinggebouw - Koningin Maria Hendrikaplein 70, 9000 Gent Tel: 02/ helpdesk.magda@vlaanderen.be 46 /// /// Gebruikershandleiding Domein Persoon WijzigKSZPersoon 2.0