OneRoster synchronisatie met Smartschool

Smartschool ondersteunt OneRoster 1.1. Deel leerling- en leerkrachtgegevens vanuit Smartschool met jouw toepassing.

OneRoster is een internationale standaard voor de uitwisseling van leerling-, klas- en leerkrachtgegevens. Smartschool ondersteunt de OneRoster 1.1 REST API zodat informatie uit Smartschool eenvoudig gedeeld kan worden met andere platformen die OneRoster ondersteunen. Smartschool treedt op als de provider van de data.

Het gebruik van OneRoster is volledig gratis, zowel voor de school als voor de externe partij.

OneRoster – Vragen en antwoorden

Wat is OneRoster?

OneRoster is een specificatie voor het uitwisselen van klas en leerling gegevens tussen verschillende pakketten op een gestandaardiseerde manier.

Welke versie van OneRoster ondersteunt Smartschool?

Smartschool heeft de OneRoster 1.1 standaard geïmplementeerd. Smartschool treedt op als provider van data.

Waar vind ik meer technische informatie over OneRoster?

https://www.imsglobal.org/oneroster-11-introduction

https://www.imsglobal.org/oneroster-v11-final-specification

Hoe verkrijg je als partner OneRoster credentials?

Een partner kan OneRoster credentials rechtstreeks ontvangen de school.

Een school kan OneRoster-clients aanmaken binnen haar platform en vrij kiezen welke databronnen (meerdere zijn mogelijk) het gebruikt voor een specifieke client.
De school dient de gegenereerde client_id, client_secret en url’s door te geven aan de partner.

Welke gegevens worden via OneRoster gedeeld?

De volgende bronnen zijn beschikbaar:

Lesopdrachten uit Skore: De lesopdrachten vanuit het actieve werkjaar in Skore worden gedeeld. Op deze manier stuur je de combinatie vak – leerkracht – leerlingen door zoals deze gekend zijn bij de lesopdrachten in Skore. De klas of groep zal automatisch een logische benaming krijgen in het formaat “vak schooljaar leerkracht klas”. Bijvoorbeeld: Nederlands 22-23 Els Dendonker 3A.
Lidmaatschap van Vakken (leeromgeving): Elke vak wordt gedeeld als een klas/groep. Ieder vak in Smartschool zal een aparte klas/groep zijn. Alle leerlingen van dat vak in Smartschool worden als leerling gedeeld, alle niet-leerlingen van dat vak in Smartschool worden als leerkracht gedeeld. De vaknaam vanuit Smartschool wordt overgenomen.
Groepen: Bepaal zelf welke groepen en klassen gedeeld worden via de client met de externe tool. Iedere groep in Smartschool zal als aparte klas/groep gedeeld worden. De groepen in Smartschool worden recursief opgehaald en gedeeld. Alle leerlingen van een groep in Smartschool zullen worden gedeeld als leerling van die klas/groep, alle niet-leerlingen van die groep in Smartschool worden als leerkracht gedeeld. De groepsnaam vanuit Smartschool wordt overgenomen.

BELANGRIJK: afhankelijk van je toepassing wil je je mogelijk baseren op een specifieke bron. Het is belangrijk dat je zelf aan de school de juiste instructie geeft welke bron ze voor jouw toepassing het best gebruiken.

Welke leerlingen worden gedeeld?

Alle leerlingen die volgens de databron geselecteerd zijn worden gedeeld, inclusief de administratieve en uitgeschakelde accounts.

Welke leerkrachten worden gedeeld?

Alle leerkrachten die via de databron geselecteerd zijn worden gedeeld. Voor de databron ‘Lesopdrachten uit Skore’ zijn dat de leerkrachten die het vak geven. Voor de databron ‘Groepen’ worden ook de gekozen klastitularissen gedeeld.

Welke klassen worden gedeeld?

De geselecteerde ‘klassen’ naar gelang de databron worden gedeeld. Bij ‘Lesopdrachten uit Skore’ wordt geen effectief klas gedeeld maar delen we een lesopdracht. Bij ‘Lidmaatschap van Vakken’ delen we het lidmaatschap voor dat specifieke vak.

Welke endpoints zijn voorzien?

Volgende endpoints zijn, conform de specificatie, beschikbaar:

/ims/oneroster/v1p1/schools
/ims/oneroster/v1p1/schools/…
ims/oneroster/v1p1/classes
/ims/oneroster/v1p1/classes/….
/ims/oneroster/v1p1/schools/…/classes
/ims/oneroster/v1p1/users
/ims/oneroster/v1p1/students
/ims/oneroster/v1p1/students/…
/ims/oneroster/v1p1/schools/…/students
/ims/oneroster/v1p1/teachers
/ims/oneroster/v1p1/teachers/…
/ims/oneroster/v1p1/schools/…/teachers
/ims/oneroster/v1p1/schools/…/enrollments
/ims/oneroster/v1p1/academicSessions
/ims/oneroster/v1p1/academicSessions/…
/ims/oneroster/v1p1/terms/…

Hoe verkrijg je een access_token om OneRoster te kunnen versturen?

Stuur een request naar https://subdomain-platform.smartschool.be/ims/oneroster/token met de correcte parameters.

Zie https://www.imsglobal.org/oneroster-v11-final-specification#:~:text=3.6.2.%20OAuth%202%20Bearer%20Token%20Authorization voor meer info.

Je zal een json-response ontvangen welke het access_token bevat.

Welke scope dien ik aan te vragen?

https://purl.imsglobal.org/spec/or/v1p1/scope/roster-core.readonly

Hoe dien ik de OneRoster requesten te authenticeren?

Dit kan via Bearer token authenticatie. Dit komt erop neer dat je een ‘Authorization’ header meestuurt met als waarde ‘Bearer accesstokenvalue’.
Voorbeeld: ‘Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOi8vZXhhbXBsZ….’

OneRoster synchronisatie met Smartschool

OneRoster – Vragen en antwoorden

Doelgroep

Werken bij Smartschool

Producten

Privacy

Laatste nieuws

BLOG ARCHIEF

Categorieën