Algemeen
De vraag is opgebouwd zoals overige MAGDA webservices en bestaat uit:
- Referte
- Het INSZ (Rijksregisternummer) van de persoon waarvoor men inschrijvingen wil opvragen
- Een periode met een begindatum en een einddatum; zowel begindatum als einddatum zijn verplicht
- Optioneel kunnen één of meer van volgenden bronnen worden opgegeven waarvoor men inschrijvingen wil opvragen
o “LP”: leerplicht onderwijs (Discimus)
o “INT”: internaat (Discimus)
o “VWO”: volwassenenonderwijs (Davinci)
o “HO”: hoger onderwijs (DHO)
Er wordt slechts één vraag per bericht toegelaten.
XSD Visueel
Detail
Enkel de relevante elementen zijn in onderstaande tabel opgenomen.
| Element | V/O | Formaat | Opmerkingen |
|---|---|---|---|
| Referte | Verplicht | Unieke referte over al de vragen heen | |
| INSZ | 11 numeriek | Het INSZ-nummer, 11 lang. Hierop zal er een checksum 97 validatie plaatsvinden. Indien het nummer niet voldoet aan deze validatie zal er een uitzondering aangemaakt worden. | |
| Periode/Begin | Verplicht | JJJJ-MM-DD | Begindatum van de periode of datum vanaf wanneer men inschrijvingen wil zien. De datum dient ná of op 2013-09-01 te liggen. |
| Periode/Einde | Verplicht | JJJJ-MM-DD | Einddatum van de periode waarin men inschrijvingen wil zien. De datum dient ná de Begindatum te liggen. Indien dit niet het geval is zal een uitzondering aangemaakt worden. |
| Bronnen/Bron | Verplicht | Enumeratie "LP", "INT", "VWO" of "HO" | De afnemer kan desgewenst meegeven van welke bronnen inschrijvingsgegevens opgevraagd dienen te worden. Voor de afnemer zijn volgende combinaties toegelaten:
Eenzelfde bron mag slechts 1 keer voorkomen in de vraag, zoniet zal een uitzondering aangemaakt worden. |
Validaties op vraag
Alle validaties op de context, zoals beschreven in het document “Gebruik MAGDA Webservices” [GMW], zijn van toepassing op deze dienst.
Voorbeeld
De bevraging van de bronnen gebeurt met het Verzoek zoals MAGDA dit ontvangen heeft van de afnemer.
Dit is inclusief Context, de Referte in de Vraag en het volledige Inhoud-element.
<n0:GeefHistoriekInschrijving> <Verzoek> <Context> .... </Context> <Vragen> <Vraag> <Referte>a</Referte> <Inhoud> <Criteria> <INSZ>00000000000</INSZ> <Periode> <Begin>2000-01-01</Begin> <Einde>2016-06-30</Einde> </Periode> <Bronnen> <Bron>VWO</Bron> </Bronnen> </Criteria> </Inhoud> </Vraag> </Vragen> </Verzoek> </n0:GeefHistoriekInschrijving>
<n0:GeefHistoriekInschrijving> <Verzoek> <Context> .... </Context> <Vragen> <Vraag> <Referte>a</Referte> <Inhoud> <Criteria> <INSZ>00000000000</INSZ> <Periode> <Begin>2000-01-01</Begin> <Einde>2016-06-30</Einde> </Periode> </Criteria> </Inhoud> </Vraag> </Vragen> </Verzoek> </n0:GeefHistoriekInschrijving>
Op deze pagina
Binnen deze handleiding
