TitelGegevensdiensten | Edu-V gegevensdiensten | ||||||||||||||||||
Status |
| ||||||||||||||||||
Versie | 1.0.0.3 | ||||||||||||||||||
Datum13 December 2023 | 27 Mei 2024 | ||||||||||||||||||
Auteur | Architectenraad Edu-V | ||||||||||||||||||
Acties |
|
...
Technische vereisten per gegevensdienstVerplichte en optionele gegevensdiensten per referentiecomponentgegevensdiensten
| Anchor | ||||
|---|---|---|---|---|
|
In de praktijk worden allerlei verschillende applicaties aangeboden waarin diverse functionaliteiten worden gecombineerd tot een waardevol product voor de gebruiker. In het afsprakenstelsel van Edu-V werken we met referentiecomponenten. Deze referentiecomponenten zijn gedefinieerd in het architectuurkader Edu-V en beschrijven een (deel)functionaliteit van een applicatie.
Het is als leverancier mogelijk om in een applicatie één of meerdere referentiecomponenten aan te bieden. De referentiecomponenten geven het recht of de plicht om gegevensdiensten aan te bieden of te consumeren. Een referentiecomponent wisselt gegevens uit in de transactierol van Bron, Afnemer, Verzender of Ontvanger.
Deze werking is nader toegelicht in het conceptueel model zoals weergegeven in figuur 1.
...
Leverancier A biedt een applicatie aan met twee referentiecomponenten:
Administratiesysteem onderwijsdeelnemer in de transactierol Bron voor de gegevensdienst Onderwijsadministratie.
Administratiesysteem leerresultaten in de transactierol Ontvanger voor de gegevensdienst Leerresultaten.
Leverancier B biedt een applicatie aan met één referentiecomponent:
Gebruiksomgeving digitaal leermateriaal in de transactierol Afnemer voor de gegevensdienst Onderwijsadministratie.
Leverancier C biedt een applicatie aan met twee referentiecomponenten:
Gebruiksomgeving digitaal leermateriaal in de transactierol Afnemer voor de gegevensdienst Onderwijsadministratie én Verzender voor de gegevensdienst Leermateriaalgebruik.
Digitaal toetssysteem in de transactierol Afnemer voor de gegevensdienst Onderwijsadministratie én Verzender voor de gegevensdienst Leerresultaten.
Leverancier D biedt een applicatie aan met één referentiecomponent:
Digitaal toetsplatform toetssysteem in de transactierol Afnemer voor de gegevensdienst Onderwijsadministratie én Verzender voor de gegevensdienst Leerresultaten.
Leverancier E biedt een applicatie aan met één referentiecomponent:
Leermiddelendashboard in de transactierol Afnemer voor de gegevensdienst Onderwijsadministratie, Ontvanger voor de gegevensdienst Leermateriaalgebruik én Ontvanger voor de gegevensdienst Leerresultaten.
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:
...
Release notes
...
Edu-V 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
...
...
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.
| Info |
|---|
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
UI
...
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.
0.0.4: Gegevensdiensten naar een separate sectie verplaatst. Conceptueel model gegevensdiensten toegevoegd. Tabellen met detailinformatie naar een eigen pagina verplaatst:
0.0.5: Gegevensdiensten SIS API opgesplitst in:
Onderwijsorganisatie
Adresgegevens fijndistributie
Onderwijsaanbod
0.0.6: De pagina is besproken tijdens de bijeenkomst van de Architectenraad Edu-V en is gereed voor de ROSA-architectuurscan.
1.0.0: Het Architectuurkader Edu-V is vastgesteld als startpunt voor de implementatie. Tevens is instemming verleend op verdere doorontwikkeling van het Architectuurkader Edu-V op basis van de Architectuurprincipes. Dit akkoord is verleend op het Bestuurlijk Overleg van 27 mei 2024.