...
| Table of Contents | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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 | SIS API | Administratiesysteem onderwijsdeelnemer | Bron |
Identiteitsbeheervoorziening Gebruiksomgeving digitaal leermateriaal Digitaal toetssysteem Bestelomgeving leermiddelen Aanspraakmanager Licentieregistratie Distributiefaciliteit Leermiddelenportaal Leermiddelendashboard | Afnemer | ||||
SchoolPeriod SchoolSubject | SIS API | Selectieomgeving leermiddelen | Afnemer | ||
Leerresultaten | Het versturen van leerresultaten op toetsen naar het administratie-systeem onderwijs-resultaten. | Result Score | Results API | Digitaal toetssysteem Gebruiksomgeving digitaal leermateriaal | Verzender |
Administratiesysteem leerresultaten Leermiddelendashboard | Ontvanger | ||||
Leermiddelen | Gegevens over leermiddelen die als product of set worden verkocht. | Product Set Access URL | Catalogue API | Leveranciersspecifieke leermiddelencatalogus | Bron |
Overkoepelende leermiddelencatalogus Bestelomgeving leermiddelen Selectieomgeving leermiddelen Leermiddelenportaal Aanspraakmanager Licentieregistratie Distributiefaciliteit Leermiddelendashboard | Afnemer | ||||
Aanspraken en leermiddelactivatie | Het verwerken van bestellingen zodat deze correct gereed staan in de licentieregistratie en het leermiddelenportaal. Dit gebeurt door uitwisseling van Aanspraken en Leermiddelactivatie. | Entitlement ChangeLicenseStatus
| Entitlement API | Aanspraakmanager | Verzender |
Licentieregistratie Leermiddelenportaal Leermiddelendashboard | Ontvanger | ||||
InitialActivation | Usage API | Licentieregistratie | Verzender | ||
Aanspraakmanager Leermiddelenportaal Leermiddelendashboard | Ontvanger | ||||
ActivationCode ActivationCode-Revoke | Entitlement API | Aanspraakmanager | Verzender | ||
Licentieregistratie | Ontvanger | ||||
Leermaterialen | Gegevens over de inhoudelijke structuur van leermiddelen bestaande uit leermodules en leermaterialen. | Course Block AUS Deeplink | Course API | Leermaterialencatalogus | Bron |
Overkoepelende leermiddelencatalogus Onderwijsleeromgeving Leermiddelendashboard | Afnemer | ||||
Leermiddelgebruik | Het delen van leermiddelengebruik ten behoeve van de facturatie of het inzicht in het leermiddelengebruik. | InitialActivation Usage | Usage API | Licentieregistratie | Verzender |
Bestelomgeving leermiddelen Leermiddelendashboard | Ontvanger | ||||
Leermateriaal-gebruik | Het delen van leermaterialengebruik ten behoeve van inzicht in leervoortgang | Progress | Progress API | Digitaal toetssysteem Gebruiksomgeving digitaal leermateriaal | Verzender |
Administratiesysteem leerresultaten Leermiddelendashboard | Ontvanger | ||||
Leermiddelorders | Het inkopen van leermiddelen als afnemende leverancier bij een leverancier van leermiddelen | Order CreditOrder | Order API | Bestelomgeving leermiddelen | Verzender |
Ordersysteem leermiddelen | Ontvanger | ||||
Consent | Gegevens over de gegevensuitwisselingen die door een onderwijsorganisatie zijn ge(de)activeert. | ConsentStatus | Consent API | 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.
...
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 | SIS API | Administratiesysteem onderwijsdeelnemer | Bron | GCIV | ! | – | ! | – | ! | * | – | ! | – | ! |
Identiteitsbeheervoorziening Gebruiksomgeving digitaal leermateriaal Digitaal toetssysteem Bestelomgeving leermiddelen Aanspraakmanager Licentieregistratie Distributiefaciliteit Leermiddelenportaal Leermiddelendashboard | Afnemer | GCIV | * | ! | – | ! | – | – | * | ! | !* | * | ||
Selectieomgeving leermiddelen | Afnemer | GCII | * | ! | – | ! | – | – | * | ! | !* | * | ||
Leerresultaten | Results API | Digitaal toetssysteem Gebruiksomgeving digitaal leermateriaal | Verzender | GCIV | * | ! | – | ! | – | – | – | ! | !* | * |
Administratiesysteem leerresultaten Leermiddelendashboard | Ontvanger | GCIV | ! | – | ! | – | ! | – | – | ! | – | ! | ||
Leermiddelen | Catalogue API | Leveranciersspecifieke leermiddelencatalogus | Bron | GCI | ! | – | ! | – | – | * | – | – | – | – |
Overkoepelende leermiddelencatalogus Bestelomgeving leermiddelen Selectieomgeving leermiddelen Leermiddelenportaal Aanspraakmanager Licentieregistratie Distributiefaciliteit Leermiddelendashboard | Afnemer | GCI | * | ! | – | – | – | – | * | – | – | – | ||
Aanspraken en leermiddelactivatie | Entitlement API | Aanspraakmanager | Verzender | GCIII of GCIV | ! | ! | ! | ! | ! | – | – | * | * | * |
Licentieregistratie | Ontvanger | GCIII | ! | ! | ! | ! | ! | – | – | – | – | – | ||
Leermiddelenportaal Leermiddelendashboard | Ontvanger | GCIV | ! | ! | ! | ! | ! | – | – | ! | – | ! | ||
Usage API | Licentieregistratie | Verzender | GCIII of GCIV | ! | ! | ! | ! | ! | – | – | * | * | * | |
Aanspraakmanager | Ontvanger | GCIII | ! | ! | ! | ! | ! | – | – | – | – | – | ||
Leermiddelenportaal Leermiddelendashboard | Ontvanger | GCIV | ! | ! | ! | ! | ! | – | – | ! | – | ! | ||
Leermaterialen | Course API | Leermaterialencatalogus | Bron | GCI | ! | – | ! | – | – | * | – | – | – | – |
Overkoepelende leermiddelencatalogus Onderwijsleeromgeving Leermiddelendashboard | Afnemer | GCI | * | ! | – | – | – | – | * | – | – | – | ||
Leermiddel-gebruik | Usage API | Licentieregistratie | Bron | GCIII of GCIV | ! | ! | ! | ! | ! | – | – | * | * | * |
Aanspraakmanager | Ontvanger | GCIII | ! | ! | ! | ! | ! | – | – | – | – | – | ||
Leermiddelendashboard | Ontvanger | GCIV | ! | ! | ! | ! | ! | – | – | ! | – | ! | ||
Leermateriaal-gebruik | Progress API | Gebruiksomgeving digitaal leermateriaal Digitaal toetssysteem | Verzender | GCIV | * | ! | – | ! | – | – | – | ! | * | * |
Leermiddelendashboard | Ontvanger | GCIV | ! | – | ! | – | ! | – | – | ! | – | ! | ||
Leermiddelorders | Order API | Bestelomgeving leermiddelen | Verzender | GCI | ! | ! | ! | – | – | – | – | – | – | – |
Ordersysteem leermiddelen | Ontvanger | GCI | ! | ! | ! | – | – | – | – | – | – | – | ||
Consent | Consent API | 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 Leermiddelgebruik Activatiecode | Bron Verzender Ontvanger Verzender Bron | ! ! * * * |
Ordersysteem leermiddelen | Leermiddelorders | Bron | ! |
Overkoepelende leermiddelencatalogus | Leermiddelen Leermaterialen | Afnemer Afnemer | ! * |
Selectieomgeving leermiddelen | Leermiddelen Onderwijsadministratie | Afnemer Afnemer | ! * |
Bestelomgeving leermiddelen | Leermiddelen Onderwijsadministratie Leermiddelorders | Afnemer Afnemer Verzender | ! * * |
Ordersysteem leermiddelen | Leermiddelorders | Ontvanger | ! |
Aanspraakmanager | Aanspraken Leermiddelen Licenties Leermiddelactivatie Activatiecode | Verzender Afnemer Afnemer Ontvanger Afnemer | ! * * * * |
Distributiefaciliteit | Adresgegevens | Afnemer | * |
Leermiddelenportaal | Onderwijsadministratie Leermiddelen Aanspraken Leermiddelactivatie | Afnemer Afnemer Ontvanger Ontvanger | * ! ! * |
Onderwijsleeromgeving
| Onderwijsadministratie Leermiddelen Leermaterialen | Afnemer Afnemer Afnemer | * * * |
Leermiddelendashboard | Onderwijsadministratie Leermiddelen Leermaterialen Aanspraken Licenties Leermiddelactivatie Leermiddelgebruik Leermateriaalgebruik Leerresultaat | Afnemer Afnemer Afnemer Ontvanger Ontvanger Ontvanger Ontvanger Ontvanger 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.
...