Versions Compared

Old Version 5

changes.mady.by.user Bert Van Kets

Saved on

compared with

New Version Current

changes.mady.by.user Bram Van Helleputte (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Algemeen

De GET persons/officialDocumentReferences-v1 vraag laat toe om referenties op te vragen van documenten die opgeslagen zijn in de DAtabase 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-languageOp dit moment wordt enkel "nl" aanvaardJadocumentTypeBepaalt het type document dat wordt opgevraagd. De lijst van mogelijke waarden staat hieronder

Nee

documentStateDe staat waarin het document zich moet bevinden. De lijst van mogelijke waarden staat hieronderNeefactDateDayDe dag waarop de akte is aangemaakt.
Kan enkel gebruikt worden in combinatie met factDateYearNeefactDateMonthDe maand waarop de akte is aangemaakt.
Kan enkel gebruikt worden in combinatie met factDateYearNeefactDateYearHet 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 optioneelNee

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

Ja

firstNamelastNameFamilienaam van de persoon waarvoor akten worden opgezochtNeebirthDateDayDe dag waarop de persoon geboren is.
Kan enkel gebruikt worden in combinatie met birthDateYearNeebirthDateMonthDe maand waarop de persoon geboren is.
Kan enkel gebruikt worden in combinatie met birthDateYearNeebirthDateYearHet 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 optioneelNeeplaceOfOriginDe gemeente die het documetn aangemaakt en getekend heeftNeesearchInRrnAanduiding of het RijksRegister ook moet doorzocht worden. true = YES, false = NOJa

language

Voornaam van de persoon waarvoor akten worden opgezochtNee

De taal van de opgevraagde akte. Volgende taal keuzen zijn mogelijk:

  • nl

  • fr

  • de

Indien de taal niet opgegeven wordt, zullen de akten in de Nederlandse taal worden opgevraagd

Nee

Validaties op vraag

Element

Omschrijving van de validatie

Mogelijke Foutcodes

accept-languageOp dit moment ondersteunt MAGDA enkel de Nederlanse taal. Deze paramter moet dus steeds "nl" zijn.

documentState

ValueDRAFTREADY_FOR_VALIDATIONDELETEDVALIDATE_FOR_SIGNATUREREADY_FOR_SIGNATURETO_CHECKREFUSEDPARTIALLY_MIGRATEDPARTIALLY_MIGR_COPYPARTIALLY_MIGR_EXTRACTFINAL

personNumber

De INSZ opgegeven in deze parameter moet voldoen aan de checksum97 validatie.

Voorbeeld

Code Block
languagexml
titleVoorbeeld
linenumberstrue

Codetabellen Vraag

Onderstaande lijsten zijn de mogelijke opties die opgenomen zijn in de enums in de swagger van de dienst.

documentType

ValueBIRTH_CERTIFICATEMARRIAGE_CERTIFICATEDEATH_CERTIFICATENATIONALITY_CERTIFICATERECOGNITION_CERTIFICATEPRENATAL_RECOGNITION_CERTIFICATENAME_CHANGE_CERTIFICATEFIRSTNAME_CHANGE_CERTIFICATEDECLARATION_OF_LIFELESS_CHILD_CERTIFICATESEX_CHANGE_CERTIFICATEJUDICIAL_DECREEABSENCE_CERTIFICATEUNKNOWN_PERSON_DEATH_CERTIFICATEDIVORCE_CERTIFICATEADOPTION_CERTIFICATEAUTHORITY_DECISIONANNULMENT_CERTIFICATEMODIFICATION_CERTIFICATEUPDATE_DOCUMENT

Status : 400 “Bad Request”

Detail : INSZ in the query parameters has an invalid structure

personNumber

Indien de INSZ ook meegegeven wordt in het OAuth token, door extentie van dat token met het ACM/IDM token, zal het opgegeven INSZ vergeleken worden met de waarde in de personNumber parameter.

Status : 400 “Bad Request”

Detail : personNumber parameter does not match the ACM/IDM token

Op deze pagina

Table of Contents
maxLevel2
minLevel1

Binnen deze handleiding

Page Treeroot@parent

Child pages (Children Display)
pageGET persons/officialDocumentReferences-v1
Info

Met vragen kunt u steeds terecht bij de MAGDA Service Desk.