DPA (Data Processing Agreement) API

Titel	DPA (Data Processing Agreement) API
Status	In ontwikkeling ROSA-Architectuurscan BEsluitvorming in beheer
Versie	Documentatie: 0.0.6
Versie	schemaVersion: 0.0.3
Datum	18 April 2024
Auteur	Architectenraad Edu-V
Acties	Geen openstaande acties

Referentiecomponenten Consentmanagement kunnen optioneel gebruik maken van de referentiecomponent Verwerkersregister. In dit register kan voor een leverancier opgevraagd worden of deze een geldige verwerkersovereenkomst heeft met een onderwijsbestuur.

Indien er geen verwerkersovereenkomst is, dan is het niet wenselijk dat er een gegevensuitwisseling met de leverancier wordt geactiveerd. Door het verifiëren van de geldigheid van een verwerkersovereenkomst kan in een dergelijk geval een applicatiebeheerder die consent aan het verlenen is op dat moment gewaarschuwd worden.

De technische specificatie bestaat uit:

1 Samenvatting
2 Object: Agreement
3 Object: AgreementVerification
4 Status- en foutcodes
5 Technisch: API specificatie
6 Release notes

Samenvatting

Scope	dpa
Objecten	Agreement AgreementVerification
Bron	Verwerkersregister
Afnemer	Consentmanagement
Endpoints	Verwerkersregister GET Agreement Supplier itself has with School Board GET AgreementVerification for School Board and Supplier

De DPA API wordt aangeboden door de referentiecomponent Verwerkersregister en kan bevraagd worden door de referentiecomponent Consentmanagement.

Object: Agreement

In de overeenkomst is af te lezen of een leverancier een geldige verwerkersovereenkomst heeft met een onderwijsbestuur. Dit object kan worden gebruikt door een leverancier om informatie over een eigen verwerkersovereenkomst met een onderwijsbestuur op te vragen.

Veld	Type	Format	Omschrijving	Voorbeeld	O/V	Vullingsregel
agreementId	string	string	Unieke referentie naar de verwerkersovereenkomst.		V
supplierOin	string	string	OIN van de leverancier		V
boardId	string	string	Bestuursnummer van het Onderwijsbestuur		V	Zie ook primaire en secundaire identifiers voor onderwijsorganisaties.
ecosystem	string	string	Referentie naar de ketensamenwerking waarvoor een verwerkersovereenkomst is afgesloten,	Edu-V	V
dataServices	array	ENUM	Referentie naar de gegevensdiensten waar een verwerkersovereenkomst is afgesloten.	`Onderwijsaanbod` `Onderwijsinrichting` `Onderwijsdeelnemers` `Onderwijsmedewerkers` `Leveringsorders` `Aanspraken` `Leermiddelgebruik` `Leermateriaalgebruik` `Leerresultaten`	O	Betreft één of meerdere Ed-V gegevensdiensten waarop Regie op gegevens van toepassing is. Zie ook: gegevensdiensten.
valid	bool	boolean	Indicatie of de leverancier een geldige verwerkersovereenkomst heeft met het onderwijsbestuur voor de ketensamenwerking en de gegevensdiensten.	True False	V
startDate	string	date	Startdatum van de verwerkersovereenkomst	2022-08-01	O*	Veld is gevuld indien de eigen verwerkersovereenkomst voor het onderwijsbestuur wordt opgevraagd.
endDate	string	date	Einddatum van de verwerkersovereenkomst	2023-08-01	O	Veld is optioneel. De verwerkersovereenkomst kan ook geen einddatum hebben.

Object: AgreementVerification

In dit object is af te lezen of een leverancier al dan niet een geldige verwerkersovereenkomst heeft met een onderwijsbestuur voor een gespecificeerde ketensamenwerking en daarbinnen vallende gegevensdiensten.

Veld	Type	Format	Omschrijving	Voorbeeld	O/V	Vullingsregel
supplierOin	string	string	OIN van de leverancier		V
boardId	string	string	Bestuursnummer van het Onderwijsbestuur		V	Zie ook primaire en secundaire identifiers voor onderwijsorganisaties.
ecosystem	string	string	Referentie naar de ketensamenwerking waarvoor de geldigheid wordt gecontroleerd.	Edu-V	V
dataServices	array	ENUM	Referentie naar de gegevensdiensten waarvoor de geldigheid van een verwerkersovereenkomst wordt gecontroleerd.	Onderwijsaanbod Onderwijsinrichting Onderwijsdeelnemers Onderwijsmedewerkers Leveringsorders Aanspraken Leermiddelgebruik Leermateriaalgebruik Leerresultaten	O	Betreft één of meerdere Ed-V gegevensdiensten waarop Regie op gegevens van toepassing is. Zie ook: gegevensdiensten.
valid	bool	boolean	Indicatie of de leverancier een geldige verwerkersovereenkomst heeft met het onderwijsbestuur voor de ketensamenwerking en de gegevensdiensten.	True False	V

Status- en foutcodes

Voor alle APIs uit het Afsprakenstelsel Edu-V zijn de status- en foutcodes beschreven op de pagina Status- en foutcodes. Hierbij is onderscheid gemaakt in algemene en voor de API specifieke status- en foutcodes.

Technisch: API specificatie

Release notes

0.0.1: Pagina aangemaakt met verwijzing naar Mandatenregister van OSR Kennisnet.
0.0.2: Eerste versie Mandate API gespecificeerd met endpoint om te valideren of een Leverancier een verwerkersoverenkomst heeft met een onderwijsbestuur. Hierbij is een berichtdefinitie Mandaat toegevoegd en zijn ook de status codes beschreven.
0.0.3: Herziening Consent is verwerkt in deze API uitwerking:
- Naam is gewijzigd van Mandate API naar DPA API.
- Naam van mandate is gewijzigd naar Agreement.
- De endpoints zijn gesplitst in het opvragen van informatie over een verwerkersovereenkomst die de leverancier zelf heeft afgesloten met het onderwijsbestuur en een endpoint voor het opvragen van informatie over een overeenkomst die het onderwijsbestuur met een andere leverancier heeft gesloten.
- Het attribuut ecosystem is toegevoegd als referentie naar de ketensamenwerking waarvoor de verificatie wordt toegepast.
- Het attribuut dataServices is toegevoegd als optionele referentie naar de gegevensdiensten waarvoor de verificatie wordt toegepast. Deze dienen dan uiteraard wel vastgelegd te zijn in de registratie van de verwerksovereenkomst bij de referentiecomponent Verwerkersregister.
0.0.4: De pagina is besproken tijdens de bijeenkomst van de Architectenraad Edu-V en is gereed voor de ROSA-architectuurscan.
0.0.5: Gegevensdiensten zijn bijgewerkt in de ENUM.
0.0.6: Conform wijziging in architectuur de schemaVersion als attribuut verwijderd uit de berichtspecificaties.