Titel | Gegevensdiensten |
Status | IN ONTWIKKELING BESLUITVORMING IN BEHEER |
Versie | 0.0.3 |
Datum | 13 December 2023 |
Auteur | Architectenraad Edu-V |
Acties |
|
In het Ecosysteem van Edu-V worden allerlei gegevenssoorten uitgewisseld. De gegevens worden uitgewisseld door referentiecomponenten. Op deze pagina zijn de gegevensdiensten beschreven die door deze referentiecomponenten benut kunnen worden om onderling gegevens uit te wisselen. Deze pagina bestaat uit de volgende paragrafen:
Gegevensdiensten
In onderstaand overzicht zijn de gegevensdiensten uit het Edu-V afsprakenstelsel weergegeven. Voor ieder van de gegevensdiensten is aangegeven welke referentiecomponenten de gegevensdienst kunnen benutten. Voor ieder van de referentiecomponenten is aangegeven in welke transactierol dit mogelijk is.
Gegevensdienst | Omschrijving | Gegevens | API | Referentiecomponent | Transactierol |
Onderwijs-administratie | Gegevens uit het administratiesysteem onderwijsdeelnemers voor provisioning van applicaties in het afsprakenstelsel. | Student Employee SchoolPeriod SchoolSubject Class Group Address | Administratiesysteem onderwijsdeelnemer | Bron | |
Identiteitsbeheervoorziening Gebruiksomgeving digitaal leermateriaal Digitaal toetssysteem Bestelomgeving leermiddelen Aanspraakmanager Licentieregistratie Distributiefaciliteit Leermiddelenportaal Leermiddelendashboard | Afnemer | ||||
SchoolPeriod SchoolSubject | Selectieomgeving leermiddelen | Afnemer | |||
Leermiddelen | Gegevens over leermiddelen die als product of set worden verkocht. | Product Set Access URL | Leveranciersspecifieke leermiddelencatalogus | Bron | |
Overkoepelende leermiddelencatalogus Bestelomgeving leermiddelen Selectieomgeving leermiddelen Leermiddelenportaal Aanspraakmanager Licentieregistratie Distributiefaciliteit Leermiddelendashboard | Afnemer | ||||
Leermaterialen | Gegevens over de inhoudelijke structuur van leermiddelen bestaande uit leermodules en leermaterialen. | Course Block AUS Deeplink | Leermaterialencatalogus | Bron | |
Overkoepelende leermiddelencatalogus Onderwijsleeromgeving Leermiddelendashboard | Afnemer | ||||
Leveringsorders | Een product uit een bestelling laten leveren door de aanspraakmanager of de distributiefaciliteit. | Delivery Order | Delivery API | Bestelomgeving leermiddelen | Verzender |
Aanspraakmanager Distributiefaciliteit | Ontvanger | ||||
Aanspraken en leermiddelactivatie | Het verwerken van leveringsorders voor digitale leermiddelen zodat deze correct gereed staan in de licentieregistratie en het leermiddelenportaal. Dit gebeurt door uitwisseling van Aanspraken en Leermiddelactivatie. | Entitlement ChangeLicenseStatus
| Aanspraakmanager | Verzender | |
Licentieregistratie Leermiddelenportaal Leermiddelendashboard | Ontvanger | ||||
InitialActivation | Licentieregistratie | Verzender | |||
Aanspraakmanager Leermiddelenportaal Leermiddelendashboard | Ontvanger | ||||
Leermiddelactivatie en leermiddelgebruik | Het delen van leermiddelactivatie en leermiddelgebruik ten behoeve van de facturatie of het inzicht in het leermiddelgebruik. | InitialActivation Usage Usage by Contract | Licentieregistratie | Bron of Verzender | |
Bestelomgeving leermiddelen Leermiddelendashboard | Afnemer of Ontvanger | ||||
Licenties | Het delen van statusinformatie over licenties die zijn geregistreerd op aanspraken. | Usage by Entitlement or User | Licentieregistratie | Bron | |
Aanspraakmanager Leermiddelendashboard | Afnemer | ||||
Leermiddelorders | Het inkopen van leermiddelen als afnemende leverancier bij een leverancier van leermiddelen | Order CreditOrder | Bestelomgeving leermiddelen | Verzender | |
Ordersysteem leermiddelen | Ontvanger | ||||
Activatiecode-verzoek | Het opvragen van een activatiecode bij een leverancier van leermiddelen | ActivationCode ActivationCode-Revoke | Bestelomgeving leermiddelen Aanspraakmanager | Verzender | |
Licentieregistratie | Ontvanger | ||||
Leermateriaal-gebruik | Het delen van leermaterialengebruik ten behoeve van inzicht in leervoortgang | Progress | Digitaal toetssysteem Gebruiksomgeving digitaal leermateriaal | Verzender | |
Administratiesysteem leerresultaten Leermiddelendashboard | Ontvanger | ||||
Leerresultaten | Het versturen van leerresultaten op toetsen naar het administratie-systeem onderwijs-resultaten. | Result Score | Digitaal toetssysteem Gebruiksomgeving digitaal leermateriaal | Verzender | |
Administratiesysteem leerresultaten Leermiddelendashboard | Ontvanger | ||||
Consent | Gegevens over de gegevensuitwisselingen die door een onderwijsorganisatie zijn ge(de)activeert. | ConsentStatus | Consentmanagement | Bron | |
Consentdashboard | Afnemer |
Technische vereisten per gegevensdienst
In onderstaand overzicht is voor ieder van de gegevensdiensten aangegeven wat de technische vereisten zijn die gesteld worden aan de infrastructuur en het consentmanagement.
Ten aanzien van de infrastructuur zijn de volgende elementen benoemd:
Edukoppeling REST/OAuth: het profiel dat van toepassing is op de gegevensuitwisseling.
API: of de referentiecomponent in combinatie met de transactierol al dan niet een eigen API vereist. Indien gebruik wordt gemaakt van het transactiepatroon Abonneren op wijzigingen middels notificaties dan is een API noodzakelijk voor het notificatie endpoint.
OAuth2.0 Client: een standaard OAuth2.0 Client om te communiceren met een OAuth2.0 autorisatieserver.
OAuth2.0 Server: een OAuth2.0 autorisatieserver om Afnemers of Verzenders te identificeren en authenticeren.
PKI Client: een mTLS Client met een PKI certificaat om te communiceren met de Autorisatieserver.
PKI Server: een autorisatieserver die in staat is om een mTLS verbinding op te zetten waarin een Client met een PKI-overheidscertificaat zich kan identificeren en authenticeren.
Abonneeservice: een abonneeservice en notificatiedienst om abonnees te notificeren bij wijzigingen.
Notificatie endpoint: een notificatie endpoint waarop de leverancier als abonnee notificaties kan ontvangen bij wijzigingen.
Ten aanzien van het Consentmanagement zijn de volgende elementen benoemd:
Consent UI: een gebruikersinterface waarin de applicatiebeheerder toestemming kan geven of intrekken voor een gegevensuitwisseling.
Consent Consumer: een Client applicatie die bij een Consent API de status van een Consent kan opvragen, een Consent kan melden of Consentbevestigingen kan opvragen.
Consent API: de Consent API waarin een Consent Consumer de status van een Consent kan opvragen, een Consent kan melden of Consentbevestigingen kan opvragen. Ook kan de Consent API Consent notificaties van een andere Consent API ontvangen en/of bevestigingen.
Voor ieder van deze elementen is aangegeven of deze verplicht (!), optioneel (*) of niet van toepassing (-) zijn voor de combinatie van gegevensdienst, referentiecomponent en transactierol. In de kolom Consent Consumer wordt de combinatie van verplicht en optioneel ((!*) weergegeven. Een leverancier heeft de keuze om Consent Consumer of Consent API toe te passen, waarbij de minimale vereiste Consent Consumer is.
Laagdrempeligheid
Om de toetredingsdrempels tot het Ecosysteem zo laag mogelijk te houden is het voor referentiecomponenten die enkel als Afnemer of Verzender optreden in de gegevensdiensten geen noodzaak tot het implementeren van een API. Zij kunnen met een PKI Client en Consent Consumer gegevens opvragen uit de Bron of verzenden naar de Ontvanger.
Gegevensdienst | API | Referentiecomponent | Transactierol | Edukoppeling REST/OAuth | Infrastructuur | Consentmanagement | ||||||||
API | OAuth2.0 Client | OAuth2.0 Server | PKI Client | PKI server | Abonnee-service | Notificatie endpoint | Consent | Consent Consumer | Consent API | |||||
Onderwijs-administratie | Administratiesysteem onderwijsdeelnemer | Bron | GCIV | ! | – | ! | – | ! | * | – | ! | – | ! | |
Identiteitsbeheervoorziening Gebruiksomgeving digitaal leermateriaal Digitaal toetssysteem Bestelomgeving leermiddelen Aanspraakmanager Licentieregistratie Distributiefaciliteit Leermiddelenportaal Leermiddelendashboard | Afnemer | GCIV | * | ! | – | ! | – | – | * | ! | !* | * | ||
Selectieomgeving leermiddelen | Afnemer | GCII | * | ! | – | ! | – | – | * | ! | !* | * | ||
Leermiddelen | Leveranciersspecifieke leermiddelencatalogus | Bron | GCI | ! | – | ! | – | – | * | – | – | – | – | |
Overkoepelende leermiddelencatalogus Bestelomgeving leermiddelen Selectieomgeving leermiddelen Leermiddelenportaal Aanspraakmanager Licentieregistratie Distributiefaciliteit Leermiddelendashboard | Afnemer | GCI | * | ! | – | – | – | – | * | – | – | – | ||
Leermaterialen | Leermaterialencatalogus | Bron | GCI | ! | – | ! | – | – | * | – | – | – | – | |
Overkoepelende leermiddelencatalogus Onderwijsleeromgeving Leermiddelendashboard | Afnemer | GCI | * | ! | – | – | – | – | * | – | – | – | ||
Leveringsorders | Delivery API | Bestelomgeving leermiddelen | Verzender | GCIII | ! | ! | ! | ! | ! | – | – | – | – | – |
Aanspraakmanager Distributiefaciliteit | Ontvanger | GCIII | ! | ! | ! | ! | ! | – | – | – | – | – | ||
Aanspraken en leermiddelactivatie | Aanspraakmanager | Verzender | GCIII of GCIV | ! | ! | ! | ! | ! | – | – | * | * | * | |
Licentieregistratie | Ontvanger | GCIII | ! | ! | ! | ! | ! | – | – | – | – | – | ||
Leermiddelenportaal Leermiddelendashboard | Ontvanger | GCIV | ! | ! | ! | ! | ! | – | – | ! | – | ! | ||
Licentieregistratie | Verzender | GCIII of GCIV | ! | ! | ! | ! | ! | – | – | * | * | * | ||
Aanspraakmanager | Ontvanger | GCIII | ! | ! | ! | ! | ! | – | – | – | – | – | ||
Leermiddelenportaal Leermiddelendashboard | Ontvanger | GCIV | ! | ! | ! | ! | ! | – | – | ! | – | ! | ||
Leermiddelactivatie en leermiddel-gebruik | Licentieregistratie | Bron of Verzender | GCIII of GCIV | ! | ! | ! | ! | ! | – | – | * | * | * | |
Bestelomgeving leermiddelen | Afnemer of Ontvanger | GCIII | ! | ! | ! | ! | ! | – | – | – | – | – | ||
Leermiddelendashboard | Afnemer of Ontvanger | GCIV | ! | ! | ! | ! | ! | – | – | ! | – | ! | ||
Licenties | Licentieregistratie | Bron | GCIII of GCIV | ! | ! | ! | ! | ! | – | – | * | * | * | |
Bestelomgeving leermiddelen | Afnemer | GCIII | ! | ! | ! | ! | ! | – | – | – | – | – | ||
Leermiddelendashboard | Afnemer | GCIV | ! | ! | ! | ! | ! | – | – | ! | – | ! | ||
Leermiddelorders | Bestelomgeving leermiddelen | Verzender | GCIII | ! | ! | ! | – | – | – | – | – | – | – | |
Ordersysteem leermiddelen | Ontvanger | GCIII | ! | ! | ! | – | – | – | – | – | – | – | ||
Activatiecode-verzoek | Bestelomgeving leermiddelen Aanspraakmanager | Verzender | GCIII | ! | ! | ! | – | – | – | – | – | – | – | |
Licentieregistratie | Ontvanger | GCIII | ! | ! | ! | – | – | – | – | – | – | – | ||
Leermateriaal-gebruik | Gebruiksomgeving digitaal leermateriaal Digitaal toetssysteem | Verzender | GCIV | * | ! | – | ! | – | – | – | ! | * | * | |
Leermiddelendashboard | Ontvanger | GCIV | ! | – | ! | – | ! | – | – | ! | – | ! | ||
Leerresultaten | Digitaal toetssysteem Gebruiksomgeving digitaal leermateriaal | Verzender | GCIV | * | ! | – | ! | – | – | – | ! | !* | * | |
Administratiesysteem leerresultaten Leermiddelendashboard | Ontvanger | GCIV | ! | – | ! | – | ! | – | – | ! | – | ! | ||
Consent | Consentmanagement | Bron | GCIII | ! | – | ! | – | ! | – | – | ! | – | ! | |
Consentdashboard | Afnemer | GCIII | * | ! | – | ! | – | – | – | ! | !* | * | ||
Verplichte en optionele gegevensdiensten per referentiecomponent
Referentiecomponent | Gegevensdienst | Rol | ! of * |
Leverancierspecifieke leermiddelencatalogus | Leermiddelen | Bron | ! |
Gebruiksomgeving digitaal leermateriaal
| Onderwijsadministratie Leermateriaalgebruik Leerresultaat | Afnemer Verzender Verzender | * * * |
Leermaterialencatalogus | Leermaterialen | Bron | ! |
Digitaal toetssysteem | Onderwijsadministratie Leermateriaalgebruik Leerresultaat | Afnemer Verzender Verzender | * * * |
Licentieregistratie | Licenties Leermiddelactivatie Aanspraken Activatiecodeverzoek Leermiddelactivatie en leermiddelgebruik | Bron Verzender Ontvanger Ontvanger Bron of Verzender | ! ! * * * |
Ordersysteem leermiddelen | Leermiddelorders | Ontvanger | ! |
Overkoepelende leermiddelencatalogus | Leermiddelen Leermaterialen | Afnemer Afnemer | ! * |
Selectieomgeving leermiddelen | Leermiddelen Onderwijsadministratie | Afnemer Afnemer | ! * |
Bestelomgeving leermiddelen | Leermiddelen Onderwijsadministratie Leermiddelorders Leveringsorders Activatiecodeverzoek Leermiddelactivatie en leermiddelgebruik | Afnemer Afnemer Verzender Verzender Verzender Afnemer of Ontvanger | ! * * * * * |
Ordersysteem leermiddelen | Leermiddelorders | Ontvanger | ! |
Aanspraakmanager | Aanspraken Leermiddelen Leermiddelactivatie Licenties Activatiecodeverzoek Leveringsorders | Verzender Afnemer Ontvanger Afnemer Verzender Ontvanger | ! * * * * * |
Distributiefaciliteit | Leveringsorders Adresgegevens | Ontvanger Afnemer | * * |
Leermiddelenportaal | Onderwijsadministratie Leermiddelen Aanspraken Leermiddelactivatie | Afnemer Afnemer Ontvanger Ontvanger | * ! ! * |
Onderwijsleeromgeving
| Onderwijsadministratie Leermiddelen Leermaterialen | Afnemer Afnemer Afnemer | * * * |
Leermiddelendashboard | Onderwijsadministratie Leermiddelen Leermaterialen Aanspraken Licenties Leermiddelactivatie Leermateriaalgebruik Leerresultaat Leermiddelactivatie en gebruik | Afnemer Afnemer Afnemer Ontvanger Afnemer Ontvanger Ontvanger Ontvanger Afnemer of Ontvanger | ! * * * * * * * * |
Administratiesysteem onderwijsdeelnemer | Onderwijsadministratie | Bron | ! |
Administratiesysteem onderwijsmedewerker | Onderwijsmedewerker | Bron | ! |
Administratiesysteem leerresultaten | Leerresultaat Onderwijsadministratie Leermaterialen | Ontvanger Afnemer Afnemer | ! * * |
Register leveranciers | Leveranciers | Bron | ! |
Register onderwijsorganisaties | Onderwijsorganisaties | Bron | ! |
Identiteitsbeheervoorziening | Onderwijsadministratie Onderwijsmedewerker | Afnemer Afnemer | * * |
Consentmanagement | Onderwijsorganisaties Leveranciers Consent | Afnemer Afnemer Bron Afnemer Verzender Ontvanger | ! ! * * * * |
Consentdashboard | Onderwijsorganisaties Leveranciers Consent | Afnemer Afnemer Ontvanger | ! ! ! |
Release notes
Deze uitwerking is gebaseerd op basis van de volgende stappen:
0.0.1: De gegevensdiensten zijn opgesteld op basis van de eerdere uitwerking van gegevenssoorten, verzenders en ontvangers. Voor ieder van de referentiecomponenten is aangegeven voor welke gegevensdiensten ze in aanmerking komen. Ook zijn de technische vereisten per referentiecomponent en gegevensdienst uitgewerkt.
0.0.2: Gegevensdiensten voor de praktijksituatie Verwerven en in gebruik nemen toegevoegd.
0.0.3: Links naar de technische documentatie van de APIs toegevoegd.