Algemeen
Via deze dienst kan een leerbewijs voor een bepaalde INSZ geregistreerd worden.
Parameters
Element | Opmerkingen | Primaire parameter | Verplicht | Parameter Type |
|---|
x-corrrelation-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. | Nee | Ja | Header |
X-Magda-Enduser-Id | Semantiek van dat veld: een referentie naar een END_USER. Idee er achter: Indien er een probleem was met de afhandeling van een request die er kwam op vraag van een fysiek persoon en er iets mis gaat, kan er zo na de feiten (asynchroon) terug gekoppeld worden naar die persoon. Technisch gezien wordt er niets nagekeken. Wat we wel vragen: Zet er zeker geen INSZ in, want dat zou inbreuken met zich mee kunnen brengen met privacy rulings. Gebruik hem waar je een added value ziet voor uw toepassing. Bvb. Indien de dienst geconsumed wordt door een proces, kan je er bvb een waarde in steken die dat proces identificeert. Indien de dienst echt gebruikt wordt door een user die ergens gekend is in 1 van jullie applicaties, zou je er de ID van die user kunnen insteken (zodat enkel jullie die gebruiker kunnen terugvinden – indien nodig). |
| Ja | Header |
Validaties op vraag
Element | Omschrijving van de validatie | Mogelijke Foutcodes |
|---|
INSZ
| Moet voldoen aan aan checksum 97
| 400 - Bad request
|
Voorbeeld
Beschrijving payload
"referte": Unieke referte (36posities)
"naamLeverancier": Naam van de gegevensleverancier
"insz": INSZ-nummer van de deelnemer. Personen worden in de LED aan de bewijzen gekoppeld op basis van het INSZ, d.i. het Rijksregister- of BIS-nummer van de persoon in kwestie.
"instantieId": Nummer waaronder de naam van de instantie gekend is bij de bron
"instantieDoelgroep": Doelgroep waartoe de uitreikende instantie behoord
"uitreikingsdatum": Datum uitreiking leerbewijs
"volledigeNaam": Omschrijving/titel van het leerbewijs
"instellingNaam": Naam van de instelling waar het bewijs behaald werd. Dit is m.a.w. de specifieke instelling, lesplaats, centrum waar de opleiding gevolgd werd.
"instellingNummer": Instellingsnummer waaronder de naam van de instelling gekend is bij de bron.
"specialisatieNaam": Verfijning van de studierichting
"specialisatieCode": Code van de specialisatie
"detailOnderwerpNaam": verdere verfijning van de specialisatie
"detailOnderwerpCode": code van de verfijning detailOnderwerp
"urenVolwassenOnderwijs": Aantal uren volwassenonderwijs
"alternatieveInstanties":
“instellingsrol”: wordt gebruikt om aan te geven in welke hoedanigheid de alternatieve instantie optreed
“naam”: Naam van de alternatieve instantie
"bijkomendeInformatie": Er kan bij een bewijs optioneel bijkomende informatie verstrekt worden
Voorbeeld
Headers Request:
X-Magda-Enduser-ID=Information retracted
X-Correlation-ID=Information retracted
Authorization=Bearer *Information retracted==
X-Magda-Sender-ID=kb.vlaanderen.be/Information retracted
X-Magda-Sender-QualityCode=123
X-Magda-ServiceDomain=led
X-Magda-ServiceName=bewijzen/bewijzenMetControle
X-Magda-ServiceVersion=1
Executed Request: POST https://Information retracted
ParametersFile: /rest/bewijzenBewijzenMetControlePostdienst/request/Information retracted
Request: {
"synchronousProcessing": true,
"request": {
"referte": "ABC/ABC/ABCD/2018/00001",
"naamLeverancier": "ABCD",
"insz": "01234567891",
"instantieId": "ABC123456",
"instantieDoelgroep": "AB",
"uitreikingsdatum": "2021-08-20",
"volledigeNaam": "Lorem Ipsum",
"instellingNaam": "Lorem Ipsum",
"instellingNummer": "0123456789",
"specialisatieNaam": "Lorem ipsum dolor sit amet",
"specialisatieCode": "ABCD A",
"detailOnderwerpNaam": "string",
"detailOnderwerpCode": "string",
"urenVolwassenOnderwijs": "string",
"alternatieveInstanties": [
{
"instellingsrol": "string",
"naam": "string"
}
],
"bijkomendeInformatie": [
{
"naam": "string",
"inhoud": "string"
}
]
}
}
