MAGDA geefPersoon
Inleiding
Persoonsgebonden informatie ophalen uit het rijksregister en andere gerelateerde bronnen. Denk daarbij aan domicilie, gezinssamenstelling of afstammingsgegevens.
Setup
Idem als bij alle Magda connectoren.
Applicatie eigenschappen
Algemeen
Opdat de connector toegang zou krijgen tot de MAGDA service, moet deze beschikken over de volgende informatie. De placeholder {service} moet je telkens vervangen door de specifieke service die je wil implementeren.
dosis(legacy connector)ebox(magda documentendienst)gc(ondernemingen - giveCompany)ghpgp(geefPersoon)mobility(mobiliteit)poc(kadaster)ri(repertorium)sme(ondernemingen - geefJaarrekeningen)zoekeigendomstoestanden(kadaster)
URL-endpoint
Eigenschap | Beschrijving |
|---|---|
| Geef het URL-endpoint. Voorbeeld: |
Keys en certificaten
Eigenschap | Beschrijving |
|---|---|
|
|
| Lokale opslag van het certificaat. Voorbeeld: |
| Lokale opslag van de key. Voorbeeld: |
| Bevat het pad naar het certificaat in AWS Secrets Manager. |
| Bevat het pad naar de key in AWS Secrets Manager. |
| Bevat het pad naar het wachtwoord voor de key in AWS Secrets Manager. |
Hoedanigheid
Onderstaand is de default voor alle magda services. In de meeste gevallen wordt dit vervangen door een service specifieke eigenschap.
Eigenschap | Beschrijving |
|---|---|
| Bevat de aansluitingscode of IPDC-code. |
Uri
Onderstaand is de default voor alle magda services. In de meeste gevallen wordt dit vervangen door een service specifieke eigenschap.
Eigenschap | Beschrijving |
|---|---|
| Bevat het pad naar de aan te spreken service. |
GeefPersoon specifiek
Specifieke applicatie eigenschappen, los van de eigenschappen die de toegang regelen.
Eigenschap | Beschrijving |
|---|---|
| Info die je ontvangt bij het onboardingsproces. Voorbeeld: |
| Info die je ontvangt bij het onboardingsproces. Voorbeeld: |
Services en functies
geefPersoon
Zoek persoonsgegevens op basis van een rijksregisternummer. Deze functie kan je configureren via een specifieke Skryv Studio workflow template.
Workflow expressie 1
${magda.geefPersoon(String identifier, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
identifier | String | ‘85010212345’ | Rijksregisternummer |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Ouput
Je krijgt een object GeefPersoonResponse terug met gegevens over een persoon.
MAGDA-documentatie
Technische documentatie voor Persoon.GeefPersoon-02.02
geefPersoonWithUri
Zoek persoonsgegevens op basis van een rijksregisternummer. Variant waarbij de magda aansluitingsgegevens expliciet worden meegegeven.
Workflow expressie 1
${magda.geefPersoonWithUri(String identifier, String uri, String hoedanigheid, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
identifier | String | ‘85010212345’ | Rijksregisternummer |
uri | String | - | Bron (deze info verkrijg je tijdens het onboardingproces bij Magda) |
hoedanigheid | String | - | IDPC-code (deze info verkrijg je tijdens het onboardingproces bij Magda) |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object GeefPersoonResponse terug met gegevens over een persoon.
MAGDA-documentatie
Technische documentatie voor Persoon.GeefPersoon-02.02
geefPersoonWithAfstammingWithUri
Zoek persoonsgegevens met afstammingsgegevens op basis van rijksregisternummer.
Workflow expressie 1
${magda.geefPersoonWithAfstammingWithUri(String identifier, String uri, String hoedanigheid, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
identifier | String | ‘85010212345’ | Rijksregisternummer |
uri | String | - | Bron (deze info verkrijg je tijdens het onboardingproces bij Magda) |
hoedanigheid | String | - | IDPC-code (deze info verkrijg je tijdens het onboardingproces bij Magda) |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object GeefPersoonResponse terug met gegevens over een persoon, inclusief afstammingsgegevens.
MAGDA-documentatie
Technische documentatie voor Persoon.GeefPersoon-02.02
geefPersoonWithUriAsHM
Zoek persoonsgegevens op basis van rijksregisternummer en krijg deze binnen als Java hashmap.
Workflow expressie 1
${magda.geefPersoonWithUriAsHM(String identifier, String uri, String hoedanigheid, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
identifier | String | ‘85010212345’ | Rijksregisternummer |
uri | String | - | Uri (deze info verkrijg je tijdens het onboardingproces bij Magda) |
hoedanigheid | String | - | IDPC-code (deze info verkrijg je tijdens het onboardingproces bij Magda) |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een Java hashmap GeefPersoonResponse terug met gegevens over een persoon.
MAGDA-documentatie
Technische documentatie voor Persoon.GeefPersoon-02.02
giveFamilyComposition
Zoek gegevens over gezinssamenstelling op basis van een rijksregisternummer.
Workflow expressie 1
${magda.giveFamilyComposition(String ssin, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
identifier | String | ‘85010212345’ | Rijksregisternummer |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object GeefGezinssamenstellingResponse terug met info over de gezinssamenstelling.
MAGDA-documentatie
Technische documentatie voor Persoon.GeefGezinssamenstelling-02.02
giveFamilyCompositionWithUri
Zoek gegevens over gezinssamenstelling op basis van een rijksregisternummer. Variant waarbij de magda aansluitingsgegevens expliciet worden meegegeven.
Workflow expressie 1
${magda.giveFamilyCompositionWithUri(String ssin, String uri, String hoedanigheid, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
identifier | String | ‘85010212345’ | Rijksregisternummer |
uri | String | - | Uri (deze info verkrijg je tijdens het onboardingproces bij Magda) |
hoedanigheid | String | - | IDPC-code (deze info verkrijg je tijdens het onboardingproces bij Magda) |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object GeefGezinssamenstellingResponse terug met info over de gezinssamenstelling.
MAGDA-documentatie
Technische documentatie voor Persoon.GeefGezinssamenstelling-02.02
giveHistoryFamilyComposition
Zoek gegevens over historiek van gezinssamenstelling op basis van een rijksregisternummer.
Workflow expressie 1
${magda.giveHistoryFamilyComposition(String ssin, String date, String on, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
ssin | String | ‘85010212345’ | Rijksregisternummer |
date | String | ‘2010-06-30’ | Startdatum referteperiode, geef alle gezinssamenstellingen sinds dat moment |
on | String | ‘2020-01-01’ | Refertedatum, geef de gezinssamenstelling zoals die op dat moment was |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object GeefHistoriekGezinssamenstellingResponse met de historiek van de gezinssamenstelling.
MAGDA-documentatie
Technische documentatie voor Persoon.GeefHistoriekGezinssamenstelling-02.02
giveHistoryFamilyCompositionWithUri
Zoek gegevens over historiek van gezinssamenstelling op basis van een rijksregisternummer. Variant waarbij de magda aansluitingsgegevens expliciet worden meegegeven.
Workflow expressie 1
${magda.giveHistoryFamilyCompositionWithUri(String ssin, String date, String on, String uri, String hoedanigheid, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
ssin | String | ‘85010212345’ | Rijksregisternummer |
date | String | ‘2010-06-30’ | Startdatum referteperiode, geef alle gezinssamenstellingen sinds dat moment |
on | String | ‘2020-01-01’ | Refertedatum, geef de gezinssamenstelling zoals die op dat moment was |
uri | String | - | Uri (deze info verkrijg je tijdens het onboardingproces bij Magda) |
hoedanigheid | String | - | IDPC-code (deze info verkrijg je tijdens het onboardingproces bij Magda) |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object GeefHistoriekGezinssamenstellingResponse met de historiek van de gezinssamenstelling.
MAGDA-documentatie
Technische documentatie voor Persoon.GeefHistoriekGezinssamenstelling-02.02
giveHistoryPerson
Geef historische persoonsgegevens op basis van een rijksregisternummer.
Workflow expressie
${magda.giveHistoryPerson(String identifier, String date, String oneDay, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
identifier | String | ‘85010212345’ | Rijksregisternummer |
date | String | ‘2010-06-30’ | Startdatum referteperiode, geef alle gezinssamenstellingen sinds dat moment |
oneDay | String | ‘true' of ‘false’ | ‘true’ betekent de historische persoonsgegevens op die exacte dag (zie date); ‘false’ betekent historische persoonsgegevens vanaf die dag (zie date) |
uri | String | - | Uri (deze info verkrijg je tijdens het onboardingproces bij Magda) |
hoedanigheid | String | - | IDPC-code (deze info verkrijg je tijdens het onboardingproces bij Magda) |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object GeefHistoriekPersoonResponse met historische persoonsgegevens.
MAGDA-documentatie
Technische documentatie voor Persoon.GeefHistoriekPersoon-02.02
giveHistoryPersonWithUri
Geef historische persoonsgegevens op basis van een rijksregisternummer. Variant waarbij de magda aansluitingsgegevens expliciet worden meegegeven.
Workflow expressie
${magda.giveHistoryPersonWithUri(String identifier, String date, String oneDay, String uri, String hoedanigheid, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
identifier | String | ‘85010212345’ | Rijksregisternummer |
date | String | ‘2010-06-30’ | Indien oneDay ‘true’ is, dan is dit de refertedatum; indien oneDay ‘false', dan is dit de startdatum van de referteperiode |
oneDay | String | ‘true' of ‘false’ | ‘true’ betekent de historische persoonsgegevens op die exacte dag (zie date); ‘false’ betekent historische persoonsgegevens vanaf die dag (zie date) |
uri | String | - | Uri (deze info verkrijg je tijdens het onboardingproces bij Magda) |
hoedanigheid | String | - | IDPC-code (deze info verkrijg je tijdens het onboardingproces bij Magda) |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object GeefHistoriekPersoonResponse met historische persoonsgegevens.
MAGDA-documentatie
Technische documentatie voor Persoon.GeefHistoriekPersoon-02.02
searchPersonByAddress
Zoek persoonsgegevens op basis van een adres.
Workflow expressie 1
${magda.searchPersonByAddress(String postCode, String streetCode, String houseNumber, String busNumber)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
postCode | String | ‘8000’ | Postcode adres |
streetCode | String | ‘67890’ | Straatcode (CRAB Stratenlijst) |
houseNumber | String | '1' | Huisnummer |
busNumber | String | '5' | Eventueel busnummer |
Output
Je verkrijgt een object ZoekPersoonOpAdresResponse met persoonsgegevens voor het opgegeven adres (domicilie).
Workflow expressie 2
Variant waarbij de magda aansluitingsgegevens expliciet worden meegegeven.
${magda.searchPersonByAddress(String postCode, String streetCode, String houseNumber, String busNumber, String uri, String hoedanigheid)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
postCode | String | ‘8000’ | Postcode adres |
streetCode | String | ‘67890’ | Straatcode (CRAB Stratenlijst) |
houseNumber | String | '1' | Huisnummer |
busNumber | String | '5' | Eventueel busnummer |
uri | String | - | Uri (deze info verkrijg je tijdens het onboardingproces bij Magda) |
hoedanigheid | String | - | IDPC-code (deze info verkrijg je tijdens het onboardingproces bij Magda) |
Output
Je krijgt een object ZoekPersoonOpAdresResponse terug met persoonsgegevens voor het opgegeven adres (domicilie).
MAGDA-documentatie
Technische documentatie voor Persoon.ZoekPersoonOpAdres-02.02