Versions Compared

Old Version 2

changes.mady.by.user Bert Van Kets

Saved on

compared with

New Version Current

changes.mady.by.user Bert Van Kets

Saved on

Key

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

Algemeen

De GET persons/officialDocuments-V1 vraag laat toe om een PDF extract of akte op te vragen uit 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-languageOp dit moment wordt enkel "nl" aanvaardJadocumentReference De referentie van het document of uittreksel, opgevraagd met de GET persons/officialDocumentReferences dienstNee

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

Ja

language

Taal van het document dat opgevraagd wordtJagetExtract

Boolean vlag die aanduidt of een uittreksel of document wordt opgevraagd

  • True :  uittreksel
  • False of niet ingevuld : document

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

  • nl

  • fr

  • de

Indien de taal niet opgegeven wordt, zal de akte in de Nederlandse taal worden opgevraagd

Nee

documentReference

De referentie van de akte zoals opgegeven door de GET persons/officialDocumentReferences-v1 dienst

Ja

actType

Template die moet gebruikt worden om een extract aan te maken.

Parameter wordt genegeerd in de getExtract parameter false is of niet ingevuld. ART_16 en ART_34 kunnen Nee

A (Art16) kan enkel gebruikt worden voor geboorte-, huwelijks- en overlijdensaktes

  • BELGIAN : de standaard template. Het Belgisch formaat
  • ART_16 : Template volgens conventie 16 van Wenen
  • ART_34 : Template volgens conventie 34 van Wenen

  • C : Copy

  • E : Extract

  • A : Art16

Ja

Validaties op vraag

Element

Omschrijving van de validatie

Mogelijke Foutcodes

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

Voorbeeld

Code Block
languagexml
titleVoorbeeld
linenumberstrue

personNumber

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

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

Codetabellen Vraag

Er worden geen codetabellen gebruikt in de vraag

Op deze pagina

Table of Contents
maxLevel2
minLevel1

Binnen deze handleiding

Page Treeroot@parent

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

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