De Aanmeld-API is een koppelvlak voor digitale aanmeldingen naar Magister. Hiermee kan een externe geautoriseerde partij een digitale aanmeldmodule aanbieden waarmee ouders/verzorgers hun kinderen kunnen aanmelden voor een school waarna de gegevens direct in Magister beschikbaar zijn.
Via de koppeling worden de gegevens van nieuwe leerlingen in Magister geplaatst. Deze optie vervangt de handmatige leerlinginvoer of de csv-import leerlinggegevens.
- Het gaat alleen om invoer van nieuwe leerlingen. Het plaatsen van de leerling in een aanmeldingsgroep of het aanmaken van de aanmelding voor een studie, moet daarna nog wel in Magister Desktop gebeuren.
- Als een leerling al in Magister staat, worden met deze koppeling geen bestaande gegevens gewijzigd of nieuwe gegevens toegevoegd.
Beschikbaarheid
De aanmeld-API is in januari 2023 opgeleverd in productie:
- Get There 'Leerlinq' is aangesloten;
- Van Volta 'RegisterPlus' is aangesloten;
- WIS 'LeerlingAanmelden.nl' is aangesloten;
- Steets 'SchoolAanmelding.nl' is aangesloten;
- EduLinQ 'Digitaal aanmeldportaal' is aangesloten;
- Triplewict (ELK/LDOS) is aan het ontwikkelen om aan te sluiten;
- Onderwijs Transparant gaat niet aansluiten op de aanmeld-api.
Uitleg
Vanaf schooljaar 2023-2024 biedt Magister een koppeling voor het automatisch aanleveren van nieuwe leerlingen door derde partijen. Als partijen hiervan gebruik maken zijn veel minder administratieve handelingen vereist, alle aangeleverde informatie is direct beschikbaar in Magister.
Niet alle genoemde gegevens zijn noodzakelijk voor het kunnen vastleggen van een digitale aanmelding. Meer informatie over verplichte en optionele gegevens is beschikbaar in de technische documentatie die verstrekt wordt aan de externe partij.
Alle gegevens die aangeleverd worden, worden overgenomen in Magister. De gegevens worden waar mogelijk direct op de juiste plaats in Magister geregistreerd. Gegevens die niet één-op-één overeenkomen met een Magisterveld worden op de leerlingdetailkaart ‘Aanvullend’ getoond. Bijlagen worden op de detailkaart Aanmeldingsdocumenten getoond.
De Aanmeld-API zal na uitlevering beschikbaar zijn in de Magister Privacy Manager en kan via die weg actief gezet worden.
Meer acties in Magister zijn niet nodig om de koppeling aan te zetten. Zie hier de handleiding van de Privacy Manager.
Tabel met velden - bekijk het hier
Uitbreiding
Vanzelfsprekend blijven we voortdurend in gesprek over dit nieuwe koppelvlak en wordt dit verder uitgebreid op basis van de ervaringen. Een mogelijkheid voor het direct aanleveren van documenten (zoals een PDF of Word-document) via de API is gereed en beschikbaar.
Lees ook over 'Handmatig inlezen van lijst met leerlingen voorgoed voorbij'.
Magister Join
Deze nieuwe Aanmeld API-koppeling is onderdeel van Magister Join. Met Magister Join kunt u nog eenvoudiger partners koppelen aan Magister. Wilt u hierover meer weten, neem contact op met uw accountmanager via relatiebeheer@magister.nl o.v.v. 'Magister Join Aanmelden' of vraag direct een offerte aan.
FAQ Aanmeld-API
Bekijk hier de informatie over Magister Join.
Zodra de derde partijen klaar zijn om aanmeldingen via de API aan te leveren. Zie de lijst onder 'Beschikbaarheid' voor de status van de derde partijen.
De Aanmeld-API is alleen beschikbaar in de Magister productiedatabase.
Via de Privacy Manager kan een tegel voor een derde partij aangezet worden, in het voorbeeld Leerlinq. Zie voor de beschikbare dedrde partijen de lijst onder 'Beschikbaarheid'. 
In het Leerlingenoverzicht via het filter 'Leerlingen zonder aanmeldingen'. 
Bestanden worden geplaatst op de nieuwe leerlingdetailkaart 'Aanmeldingsdocumenten'.
Extra gegevens worden geplaatst op de leerlingdetailkaart 'Aanvullend'.
Dit zal nagenoeg direct zichtbaar zijn in Magister, zodra de derde partij de Aanmeld-API gebruikt.
De Aanmeld-API is gebouwd voor invoer van aanmeldingen en niet om data terug te sturen naar derde partijen.
- Formulieren kunnen niet op de kaart 'Documenten' worden getoond, omdat die kaart voorgedefinieerde bestandstypes toont.
- Magister toont bestanden die binnenkomen via de Aanmeld-API bewust op de detailkaart 'Aanmeldingsdocumenten', zodat duidelijk is welke bestanden bij een aanmelding geüpload zijn door een derde partij en u als school niets mist.
De aanmeldingsdocumenten zijn momenteel alleen te benaderen via Magister Desktop. Op termijn zal dit onderdeel ook in de webversie worden getoond.
De stamnummers worden toegekend volgende de configuratie in Magister Desktop via Beheer > Beheer > Configuratie > Leerlingen - Stamnummer instellingen.
Nee de Aanmeld-API staat hier los van.
- Controleer in Magister de stamnummerconfiguratie (Beheer - Beheer - Configuratie - Leerlingen - Stamnummerinstellingen) en pas deze eventueel aan.
- Klopt het laagste en hoogste stamnummer?
- Na aanpassen kunnen de aangemaakte leerlingen via de Aanmeld-API verwijderd worden uit Magister.
- Verstuur daarna via de derde partij de nieuwe leerlingen opnieuw naar Magister.
Hier zijn velden voor aanwezig in de kolomkiezer van het leerlingenoverzicht bij Registraties - Extern - Externe aanmelding - Externe aanmelding.
- Aanmeld-API ID - Is het nummer van de derde partij.
- Code van externe partij - Is het nummer dat wordt toegekend bij invoer van een leerling via de Aanmeld-API.
- Gewenste locatie - Is door de derde partij opgegeven, de locatie waar de leerling zich voor wil aanmelden.
- Gewenste opleiding - Is door de derde partij opgegeven, de opleiding die de leerling wil gaan volgen.
- Dat kan via de de collectieve aanmeldingswizard 'Instroom aanmelden' >Leerlingen > Leerlingen > Collectieve aanmeldingsacties > Instroom aanmelden
- Deze wizard is uitgebreid met twee kolommen die gevuld worden vanuit 'digitaal aanmelden vo' via de Aanmeld-API in de Plusmodule Magister Join. Het gaat om de gegevens 'Gewenste locatie' en 'Gewenste opleiding'.
Wij adviseren eerst de invoer via de Aanmeld-API te laten plaatsvinden en daarna mutaties in Magister uit te voeren.
- De Aanmeld-API kan in dit scenario nog steeds gebruikt worden, echter worden de leerling (en aanmelding)-gegevens niet bijgewerkt in Magister.
- De aanmeldingsdocumenten worden wel toegevoegd aan de leerling in Magister.
- Eventuele ontbrekende ouders worden toegevoegd in Magister.
- Als er bijvoorbeeld een situatie is waarbij er een aanmelding is waarbij een leerling zich aanmeld voor 'studie A' op 'locatie A', dan worden deze gegevens opgeslagen in de Magister-database bij de leerling. Als er hierna een aanmelding binnenkomt van dezelfde leerling voor 'studie B' op 'locatie B' dan worden die gegevens niet bijgewerkt in de leerling in de Magister-database. Beide aanmeldingen worden wel opgeslagen en gekoppeld aan de leerling in de Magister-database.
Ja dat kan, de leerling bestaat dan al in Magister.
- Op het moment dat de aanmelding via de Aanmeld-API dan ook binnenkomt zal bij de verwerking naar de Magister-database de leerling gevonden worden (op basis van BSN of andere standaard set).
- De leerling blijft dan zoals hij is aangemaakt.
- Mocht er verschil zitten in de ouders/verzorgers, bijvoorbeeld via de Aanmeld-API zijn twee ouders opgegeven en in Magister is er 1 ouder aangemaakt, dan zal de extra ouder aangemaakt en gekoppeld worden aan de leerling (de bestaande ouderinformatie wordt ook niet aangepast).
- Documenten die via de Aanmeld-API zijn toegevoegd, worden ook in Magister aan de leerling gekoppeld (Aanmeldingsdocumenten).
Nee, met OSO kan een leerlingdossier aangevuld worden.
Uitzondering: Detailkaart Vooropleiding > Voorlopig schooladvies, zie deze FAQ > vraag 23.
- Magister kijkt eerst of de ouder bij de leerling bestaat op basis van de oudereigenschappen zoals achternaam, postcode, huisnummer, geslacht en voorletters.
- Als de ouder niet gevonden is dan kijken we of deze ouder misschien bij een andere leerling al wel bestaat.
- Als er meerdere ouders gevonden worden met deze criteria dan wordt een extra check gedaan of het e-mailadres of mobielnummer overeenkomt. Magister pakt dan hiervan de eerste die overeenkomt.
- Als er geen ouders zijn uit bovenstaande, dan wordt er een nieuwe ouder toegevoegd.
De leerling zelf wordt opgezocht op basis van het PGN (BSN of onderwijsnummer). Als het PGN niet aanwezig is, wordt de leerling gematcht op achternaam, geboortedatum of geslacht.
Het gegeven 'Advies Vorige School' wordt weggeschreven in het memo-veld op de detailkaart 'Aanvullend', Zie tabel gegevensuitwisseling. Echter als er een match mogelijk is, zal de Aanmeld-API het advies ook plaatsen in het veld 'Voorlopig schooladvies' op de detailkaart 'Vooropleiding'.
NB: Als hierna gegevens worden opgehaald via het OSO-overdrachtsdossier wordt het Voorlopig schooladvies overschreven.
Leerlingen die via de aanmeld-API binnenkomen krijgen niet automatisch een gebruikersaccount. Dit gebeurt pas na een wijziging of toevoeging in de leerlinggegevens (NAW, contact) in Magister Desktop. Zodra bijvoorbeeld in desktop een e-mailadres of telefoonnummer wordt ingevuld of gewijzigd controleert Magister of er een account is. Zo niet, dan wordt er een account aangemaakt mits de optie 'Automatisch leerlingaccount genereren' is aangevinkt in de Configuratie > Autorisatie.
Dit gebeurt wanneer in Beheer - Configuratie - Autorisatie de optie 'Automatisch leerling account genereren' is aangevinkt:
- Vanuit de api wordt telefoon en/of mailadres overgenomen in het veld Mobiel nummer en/of E-mail (privé)
- Door de instelling in de configuratie wordt na een wijziging van de gegevens automatisch een account aangemaakt.
- Zodra er een account wordt aangemaakt, wordt het telefoonnummer en/of e-mailadres van de leerling bij het account gezet.
- Zodra er bij het account een telefoonnummer en/of e-mailadres staat, wordt dit ook automatisch overgenomen in het veld Telefoon en/of het veld E-mail (school).
Het brinnummer wordt opgezocht in de centrale tabel met relatiescholen. In die tabel staat een schoolsoort. Alleen indien het schoolsoort 'Basisonderwijs' is, wordt de school bij de basisschool gezet. In alle andere gevallen (dus ook een school voor speciaal onderwijs) bij de vorige school.
Zodra een leerling via Join in desktop binnenkomt, stuurt Magister automatisch een identificatieverzoek naar DUO. Als de leerling wordt gevonden in BRP en DUO de bijbehorende persoonsgegevens terugkoppelt in een identificatiebericht, worden die persoonsgegevens weergegeven op de detailkaart Externe gegevens.
