ࡱ > #` R+ bjbj 8h # J
B4 B4 B4 8 z4 5 d
y v5 *7 ( R7 R7 R7 -8 : g9 \ 9 0 x x x x x x x $ U{ h } R y
9 -8 -8 9 9 y
R7 R7 !y @ MD MD MD 9 L
R7
R7 x MD 9 x MD MD zr
t R7 j5 X5> B4 ?= H "t * *x ay H y Lt N > T t t 8
t X 9 9 MD 9 9 9 9 9 y y e@ 9 9 9 y 9 9 9 9
d % d
%
Dit document wordt u aangeboden door de
Kruispuntbank van de Sociale Zekerheid
Het kan vrij verspreid worden op voorwaarde dat
de bron en de URL vermeld worden
Kruispuntbank
van de
Sociale Zekerheid
Sint-Pieterssteenweg 375
B-1040 BRUSSEL
Tel: +32 2 741 83 11
Fax: +32 2 741 83 00
HYPERLINK "http://www.ksz-bcss.fgov.be" http://www.ksz-bcss.fgov.be
XML-dienst FamilyComposition
Versies
DatumVersieOmschrijving03-Aug-20061.0Creatie11-May-20071.1Uitbreiding: wettelijke gegevens van elke gezinslid worden teruggegeven in het antwoord Index
TOC \o "1-3" \h \z \u HYPERLINK \l "_Toc172535267" Versies PAGEREF _Toc172535267 \h 2
HYPERLINK \l "_Toc172535268" Index PAGEREF _Toc172535268 \h 2
HYPERLINK \l "_Toc172535269" Doel van het document PAGEREF _Toc172535269 \h 2
HYPERLINK \l "_Toc172535270" Functionaliteit PAGEREF _Toc172535270 \h 2
HYPERLINK \l "_Toc172535271" Overzicht PAGEREF _Toc172535271 \h 2
HYPERLINK \l "_Toc172535272" Opzoekingscriteria PAGEREF _Toc172535272 \h 3
HYPERLINK \l "_Toc172535273" Beschrijving van het XML-bericht PAGEREF _Toc172535273 \h 4
HYPERLINK \l "_Toc172535274" De aanvraag PAGEREF _Toc172535274 \h 4
HYPERLINK \l "_Toc172535275" Het antwoord PAGEREF _Toc172535275 \h 5
HYPERLINK \l "_Toc172535276" Foutcodes PAGEREF _Toc172535276 \h 8
HYPERLINK \l "_Toc172535277" Referenties PAGEREF _Toc172535277 \h 8
Doel van het document
Dit document bespreekt de XML-dienst FamilyComposition zoals die aangeboden wordt aan VIP en DAF.
Functionaliteit
Overzicht
De dienst FamilyComposition zoekt de gezinssamenstelling van een persoon op, op basis van het INSZ. In het antwoord wordt het adres waarop de familie verblijft alsook een beschrijving van alle gezinsleden teruggegeven. Voor elk gezinslid wordt een beperkte set van wettelijke gegevens teruggegeven.
Deze beperkte gegevensset bestaat uit het INSZ van de persoon, samen met de datum van toetreding tot het gezin, en een code van de positie binnen het gezin ten opzichte van het gezinshoofd. Daarnaast worden voor elke persoon de naam, geboortedatum en het geslacht vermeld.
De gegevens uit deze dienst zijn afkomstig van het Rijksregister. Het KSZ-register kent op dit ogenblik nog geen notie van gezinssamenstelling. De functionaliteit is gebaseerd op de klassieke R400- en R401-berichten van het Rijksregister.
Indien het gezin meer dan 18 gezinsleden bevat, dan worden het adres en de wettelijke gegevens niet teruggegeven. Het antwoord bevat dan enkel per gezinslid het INSZ-nummer en de positie binnen het gezin.
Opzoekingscriteria
Velden:
INSZ (verplicht)
Werking:
Register:
De dienst is momenteel enkel beschikbaar voor rijksregisternummers.
De gezinssamenstelling is niet beschikbaar voor personen in het KSZ-register (BIS-nummers of geradieerden).
Vervangen INSZ:
Als het INSZ van de opgevraagde persoon vervangen is of niet gevonden werd, dan zal de dienst stoppen met een foutboodschap in het antwoord.
Beschrijving van het XML-bericht
Dit hoofdstuk beschrijft enkel het eigenlijke berichtgedeelte van de XML-berichten die naar de FamilyComposition-dienst gestuurd kunnen worden. Dit houdt in dat enkel de elementen worden besproken die zich kunnen bevinden op de plaats van het -element in de - en -elementen. Een gedetailleerde beschrijving van de algemene structuur van de berichten en het gebruik ervan is te vinden in de algemene documentatie over de KSZ-webservice-architectuur [REF01].
ServiceId: FamilyComposition
Version: 20070511
Gebruikte XML-namespaces:
http://www.ksz-bcss.fgov.be/XSD/SSDN/FamilyCompositionschema's van de eigenlijke aanvraag- en antwoordberichten
http://www.ksz-bcss.fgov.be/XSD/SSDN/Commonschema's voor veelgebruikte algemene xml-elementen en -types
http://www.ksz-bcss.fgov.be/XSD/SSDN/Personschema's voor persoonsgegevens
De aanvraag
FamilyCompositionRequestHoofdelement van de aanvraag. Dit element komt op de plaats van het -element in een -element in het bericht.
SocialSecurityUserHet INSZ van de gebruiker waarvan de gezinssamenstelling moet worden opgezocht
Het antwoord
FamilyCompositionReplyHoofdelement van het antwoord. Dit element komt op de plaats van het -element in een -element in het bericht
SocialSecurityUserINSZ van de persoon waarvan de gezinssamenstelling werd opgezocht.
FamilyCompositionDe gezinssamenstelling. Dit element heeft een attribuut origin dat altijd gelijk zal zijn aan RN_RR omdat de gezinssamenstelling enkel beschikbaar is voor het Rijksregister. Dit element bevat het adres en n of meer FamilyMembers.
AddressDit blok duidt het adres aan waar de personen van het gezin officieel verblijven.
origin
Geeft de oorsprong van de gegevens in het element weer. Dit zal steeds de waarde RN_RR hebben.
modificationDate
Voor het Rijksregister is dit de datum waarop de gegevens van kracht werden. Dit is dus niet noodzakelijk de datum waarop de gegevens gewijzigd werden.
CountryHet land van het adres. Vermits het om personen uit het Rijksregister gaat, zal dit steeds Belgi zijn.
MunicipalityDe gemeente waar dit adres zich bevindt. Een Municipality wordt steeds omschreven door een
Code: dit is de NIS-code van de gemeente
PostalCode: dit is de postcode van de gemeente
Description: dit is de omschrijving van de gemeente. Voor eentalige gemeenten zal hier steeds maar n beschrijving staan. Voor meertalige gemeenten zullen de meerdere officile beschrijvingen worden gegeven.
Bij elke beschrijving staat een aanduiding van de taal van de beschrijving. Vermits we deze taalaanduiding voor meertalige omschrijvingen niet altijd doorkrijgen, zal die niet altijd ingevuld zijn.
StreetEen omschrijving van de straat van het adres. Een omschrijving bestaat steeds uit een code en een beschrijving.
Code: de NIS-code van de straat
Description: de officile omschrijving van de straat. Voor eentalige gemeenten zal hier steeds maar n beschrijving staan. Voor meertalige gemeenten zullen de meerdere officile beschrijvingen worden gegeven.
Bij elke beschrijving staat een aanduiding van de taal van de beschrijving. Vermits we deze taalaanduiding voor meertalige omschrijvingen niet altijd doorkrijgen, zal die niet altijd ingevuld zijn.
HouseNumberHet huisnummer in de straat
BoxBusnummer in het gebouw (voor appartementen e.d.) of index woning
FamilyMemberEen gezinslid.
SocialSecurityUserHet INSZ van het gezinslid.
RelationShipCode en beschrijving van de positie van het gezinslid binnen het gezin, ten opzichte van het gezinshoofd. (zie verder voor de lijst met de codes)
EntryDate (optioneel)De datum waarop het gezinslid zijn intrede deed in het gezin. Let op dat voor het gezinshoofd geen EntryDate aanwezig is.
LegalData (optioneel)De beperkte set van wettelijke gegevens van dit gezinslid.
Name
Dit blok bevat de naam, voornaam en tweede voornaam zoals ze gekend zijn bij het Rijksregister. Verder heb je een aanduiding of de persoon over meerdere officile voornamen beschikt (wordt aangeduid met het attribuut CompleteFirstName).
Gender
Het geslacht van de persoon. Dit kan de volgende waarden hebben
0: geslacht is onbekend
1: mannelijk
2: vrouwelijk
Birthdate
De geboortedatum van de persoon. Dit kan een onvolledige geboortedatum zijn. Dit is het geval wanneer men bij de registratie van deze gegevens over onvoldoende informatie beschikt om de geboortedatum vast te stellen.
Codelijst: Positie binnen het gezin
01 gezinshoofd
02 echtgenoot, echtgenote
03 zoon, dochter
04 schoonzoon, schoondochter
05 kleinzoon, kleindochter
06 vader, moeder
07 schoonvader, schoonmoeder
08 grootvader, grootmoeder
09 broer, zuster
10 schoonbroer, schoonzuster
11 verwante
12 zonder familieverband
13 stiefzoon, stiefdochter
14 achterkleinzoon, achterkleindochter
15 tante, oom
16 nicht, neef (verwantschap : 3de graad)
17 nicht, neef (verwantschap : 4de graad)
20 gemeenschappen, tehuizen
Foutcodes
35000001 De betrokkene is niet correct gentegreerd voor deze dienst.
35000002 U heeft geen toelating om deze dienst uit te voeren.
32000004 Geen gegevens werden gevonden voor dit INSZ.
32000002 Het INSZ is vervangen door een ander.
32000001 De toegang tot de gegevens is tijdelijk geblokkeerd.
31000007 De verplichte parameter is niet gespecificeerd of is leeg.
Referenties
[REF01] :
01_KSZ-BCSS Webservices Rode Draad Document_NL.doc
02_KSZ-BCSS Webservices Documentation Map_NL.doc
03_KSZ-BCSS Webservices Modes de connexion Extranet_NL.doc
04_KSZ-BCSS Webservices Omgevingen_NL.doc
05_KSZ-BCSS Webservices Machtigingen_NL.doc
06_KSZ-BCSS Webservices Tester la connexion_NL.doc
07_KSZ-BCSS Webservices HTTPS-SOAP-WSDL_NL.doc
08_KSZ-BCSS Webservices SSDN request-reply envelope definition_NL.doc
09_KSZ-BCSS Webservices SSDN common status messages_NL.doc
XML Dienst FamilyComposition
PAGE 2/ NUMPAGES 8
* + T U V q r w y ᾭyaNyF>3 hK hRv mHsH hK mHsH hU mHsH $hX] hX] 0J CJ OJ QJ mHsH /j hn hX] CJ OJ QJ UmHsH hX] hX] CJ OJ QJ mHsH #j hX] CJ OJ QJ UmHsH hX] hX] CJ OJ QJ mHsH hX] hX] CJ OJ QJ mHsH hX] hX] CJ OJ QJ mHsH #hOV hX] 5CJ OJ QJ mHsH hOV hX] CJ OJ QJ mHsH h*/ CJ OJ QJ mHsH * Q R S ) * $a$gd*/ + Q+ * t w x T kd $$If l F h 0 4
l a ytB_| $If gds/- gds/- gdX] $a$gdX] $a$gd*/ <
B
C
Z
[
\
]
y
z
{
|
ǼiYN?N j h*/ UmH nH uh*/ mH nH u h6 h*/ 0J mH nH sHu2j h*/ h\ >*B*UmH nH ph u h*/ mH nH uh6 h*/ 0J mH nH u$j h6 h*/ 0J UmH nH u j hK h6 UmHsHhK h6 mHsH hK hB_| aJ mHsH hK hB_| mHsH hK hv4 mHsH hK h mHsH hK hHy mHsH ;
n e e e $If gd6 kd $$If l F h 0 4
l a ytB_| $If gds/- ;
<
B
E 8 8
w r p p p p j j p j j p
"
gds/- kdC $$If l F h 0 4
l a ytB_|
µ§tcµ§I 2j h*/ h\ >*B*UmH nH ph u jh h\ UmH nH u h6 h*/ 0J mH nH sHu2j h*/ h\ >*B*UmH nH ph u h*/ mH nH uh6 h*/ 0J mH nH uh*/ mH nH sHtHu$j h6 h*/ 0J UmH nH u h*/ mH nH u j h*/ UmH nH u jn h\ UmH nH u # $ % ? @ A B C D E F G c d e f u v w ձsbձ j\ h\ UmH nH u 2j h*/ h\ >*B*UmH nH ph u h*/ mH nH uh6 h*/ 0J mH nH uh*/ mH nH sHtHu$j h6 h*/ 0J UmH nH u jb h\ UmH nH u j h*/ UmH nH uh*/ mH nH u h6 h*/ 0J mH nH sHu 2 3 4 5 6 7 8 øӋ}t}ZøIӋ jP h\ UmH nH u 2j h*/ h\ >*B*UmH nH ph u h*/ mH nH uh6 h*/ 0J mH nH uh*/ mH nH sHtHu jV h\ UmH nH u j h*/ UmH nH uh*/ mH nH u h6 h*/ 0J mH nH sHu$j h6 h*/ 0J UmH nH u 2j h*/ h\ >*B*UmH nH ph u8 9 : V W X Y y z { tZI jD
h\ UmH nH u 2j h*/ h\ >*B*UmH nH ph u h*/ mH nH sHtHu jJ h\ UmH nH u j h*/ UmH nH uh*/ mH nH u h6 h*/ 0J mH nH sHu2j h*/ h\ >*B*UmH nH ph u h*/ mH nH uh6 h*/ 0J mH nH u$j h6 h*/ 0J UmH nH u
2
3
4
5
6
7
8
9
:
V
W
X
Y
b
c
d
~
ӸӅtӸZӅ 2j h*/ h\ >*B*UmH nH ph u j> h\ UmH nH u h6 h*/ 0J mH nH sHu2j
h*/ h\ >*B*UmH nH ph u h*/ mH nH uh6 h*/ 0J mH nH uh*/ mH nH sHtHu$j h6 h*/ 0J UmH nH u j h*/ UmH nH uh*/ mH nH u~
µ§tcµTI hK h mHsH j hK h6 UmHsH j2
h\ UmH nH u h6 h*/ 0J mH nH sHu2j h*/ h\ >*B*UmH nH ph u h*/ mH nH uh6 h*/ 0J mH nH uh*/ mH nH sHtHu$j h6 h*/ 0J UmH nH u h*/ mH nH u j h*/ UmH nH u j8 h\ UmH nH u
K [ e b v ~ T gd5v`
&