Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Algemeen
De GET Personpersons/OfficialDocumentsListofficialDocumentReferences-V1 v1 vraag laat toe om referenties op te vragen van documenten die opgeslagen zijn in de DAtabase van Akten Burgerlijke Stand
Detail
| Element | Opmerkingen | Verplicht |
|---|---|---|
| x-correlation-id | Maakt deel uit van de header. Zie ook: Werking en overzicht uitzonderingen MAGDA RESTful services. Dit is het transactie ID, gebruikt voor logging en foutafhandeling. | Ja |
| accept-language | Op dit moment wordt enkel "nl" aanvaard | Ja |
| documentType | Bepaalt het type document dat wordt opgevraagd. De lijst van mogelijke waarden staat hieronder | Nee |
| documentState | De staat waarin het document zich moet bevinden. De lijst van mogelijke waarden staat hieronder | Nee |
| factDateDay | De dag waarop de akte is aangemaakt. Kan enkel gebruikt worden in combinatie met factDateYear | Nee |
| factDateMonth | De maand waarop de akte is aangemaakt. Kan enkel gebruikt worden in combinatie met factDateYear | Nee |
| factDateYear | Het jaar waarop de akte is aangemaakt. Indien een factDate wordt opgegeven is dit minimaal het onderdeel dat moet worden opgegeven. De maand en dag zijn optioneel | Nee |
| personNumber | INSZ van de persoon waarvoor akten worden opgezocht. Indien het ACM/IDM token gebruikt wordt bij het opvragen van het OAuth token dient de INSZ die gekoppel daan het ACM/IDM token overeen te komen met deze parameter | Nee |
| firstName | Voornaam van de persoon waarvoor akten worden opgezocht | Nee |
| lastName | Familienaam van de persoon waarvoor akten worden opgezocht | Nee |
| birthDateDay | De dag waarop de persoon geboren is. Kan enkel gebruikt worden in combinatie met birthDateYear | Nee |
| birthDateMonth | De maand waarop de persoon geboren is. Kan enkel gebruikt worden in combinatie met birthDateYear | Nee |
| birthDateYear | Het jaar waarop de persoon geboren is. Indien een birthDate wordt opgegeven is dit minimaal het onderdeel dat moet worden opgegeven. De maand en dag zijn optioneel | Nee |
| placeOfOrigin | De gemeente die het documetn aangemaakt en getekend heeft | Nee |
| searchInRrn | Aanduiding of het RijksRegister ook moet doorzocht worden. true = YES, false = NO | Ja |
Validaties op vraag
| Element | Omschrijving van de validatie | Mogelijke Foutcodes |
|---|---|---|
| accept-language | Op dit moment ondersteunt MAGDA enkel de Nederlanse taal. Deze paramter moet dus steeds "nl" zijn. | |
| personNumber | De INSZ opgegeven in deze parameter moet voldoen aan de checksum97 validatie. |
Voorbeeld
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
Codetabellen Vraag
Onderstaande lijsten zijn de mogelijke opties die opgenomen zijn in de enums in de swagger van de dienst.
documentType
| Value |
|---|
| BIRTH_CERTIFICATE |
| MARRIAGE_CERTIFICATE |
| DEATH_CERTIFICATE |
| NATIONALITY_CERTIFICATE |
| RECOGNITION_CERTIFICATE |
| PRENATAL_RECOGNITION_CERTIFICATE |
| NAME_CHANGE_CERTIFICATE |
| FIRSTNAME_CHANGE_CERTIFICATE |
| DECLARATION_OF_LIFELESS_CHILD_CERTIFICATE |
| SEX_CHANGE_CERTIFICATE |
| JUDICIAL_DECREE |
| ABSENCE_CERTIFICATE |
| UNKNOWN_PERSON_DEATH_CERTIFICATE |
| DIVORCE_CERTIFICATE |
| ADOPTION_CERTIFICATE |
| AUTHORITY_DECISION |
| ANNULMENT_CERTIFICATE |
| MODIFICATION_CERTIFICATE |
| UPDATE_DOCUMENT |
documentState
| Value |
|---|
| DRAFT |
| READY_FOR_VALIDATION |
| DELETED |
| VALIDATE_FOR_SIGNATURE |
| READY_FOR_SIGNATURE |
| TO_CHECK |
| REFUSED |
| PARTIALLY_MIGRATED |
| PARTIALLY_MIGR_COPY |
| PARTIALLY_MIGR_EXTRACT |
| FINAL |
Op deze pagina
| Table of Contents | ||
|---|---|---|
|
Binnen deze handleiding
| Page Tree | ||
|---|---|---|
|