Technische specificatie digitale identiteiten

Titel	Technische specificatie digitale identiteiten
Status	In ontwikkeling ROSA-Architectuurscan BEsluitvorming implementatie in beheer
Versie	0.9.1
Datum	23 December 2024
Auteur	Architectenraad Edu-V
Acties	Geen openstaande acties

In de bericht- en koppelvlakspecificaties wordt veelvuldig verwezen naar onderwijsorganisaties (onderwijsaanbieders, onderwijsbesturen, onderwijslocaties) en eindgebruikers (onderwijsdeelnemers en onderwijsmedewerkers). We hanteren voor deze digitale identiteiten vastgestelde primaire en secundaire identifiers. Deze zijn opgenomen in het architectuurkader op de pagina Identiteiten.

Hieronder zijn de objecten gespecificeerd zoals we deze op een uniforme wijze toepassen binnen de bericht- en koppelvlakspecificaties.

Object: referentie onderwijsorganisatie

Een referentie naar een onderwijsorganisatie - zijnde onderwijsaanbieder of onderwijsbestuur - bevat de primaire identifier (eerste voorkeur) en indien deze niet beschikbaar is door een uitzonderingssituatie een secundaire identifier.

Veld	Type	Format	Omschrijving	Voorbeeld	O/V	Vullingsregel
organisation MasterIdentifier	string	string	De primaire identifier voor een onderwijsorganisatie.	104A158	V*	De werkingsregels is dat de primaire identifier wordt gehanteerd in de berichten. De primaire identifier voor onderwijsorganisaties is de OnderwijsaanbiederID: `OA_ID` voor Onderwijsaanbieder en `OB_ID` voor onderwijsbestuur. In geval van een uitzonderingssituatie kan gebruik gemaakt van een secundaire identifier.
organisationIds	array	organisationId	Een lijst van secundaire identifiers die gehanteerd kan worden als de primaire identifier ontbreekt.	[{organisationId: ‘09QQ', organisationIdType: 'OIE_CODE’}]	V*	Zodra een secundaire identifier voor een uitzonderingssituatie gehanteerd wordt dan dient naast het Id ook het Type gespecificeerd te worden. Zie de pagina Identiteiten voor de toegestane secundaire identifiers voor onderwijsaanbieder. Op deze pagina is ook de ENUM weergegeven van de primaire en secundaire identifiers.

Object: referentie locatie

Een referentie naar een onderwijsorganisatie – zijnde onderwijslocatie – bevat de primaire identifier (eerste voorkeur) en indien deze niet beschikbaar is door een uitzonderingssituatie een secundaire identifier.

Veld	Type	Format	Omschrijving	Voorbeeld	O/V	Vullingsregel
locationMasterIdentifier	string	string	De primaire identifier voor een locatie.	112X995	V*	De werkingsregels is dat de primaire identifier wordt gehanteerd in de berichten. De primaire identifier voor locatie is de onderwijslocatie (OL_CODE) In geval van een uitzonderingssituatie kan gebruik gemaakt van een secundaire identifier. Als locationMasterIdentifier gevuld is, dient locationIds leeg te zijn en andersom.
locationIds	array	locationId	Een lijst van secundaire identifiers die gehanteerd kan worden als de primaire identifier ontbreekt.	[{locationId: ‘09QQ00', locationIdType: 'VE_CODE’}]	V*	Zodra een secundaire identifier voor een uitzonderingssituatie gehanteerd wordt dan wordt naast het Id ook het Type gespecificeerd. De secundaire identifier voor locatie is de vestigingserkenning (`VE_CODE`).
name	string	string	Naam behorende bij de locatie		V

Object: referentie eindgebruiker

Een referentie naar een eindgebruiker – zijnde onderwijsdeelnemer of onderwijsmedewerker – bevat de primaire identifier (eerste voorkeur) en indien deze niet beschikbaar is door een uitzonderingssituatie een secundaire identifier.

Primaire identifier voor onderwijsmedewerker ontbreekt

Er is nog geen ketenidentifier voor onderwijsmedewerkers beschikbaar. In het Edu-V afsprakenstelsel hanteren we voor nu alleen secundaire identifiers.

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

user
MasterIdentifier

string

De primaire identifier voor een eindgebruiker.

https://ketenid.nl/201703/1a5c9c7203901866532c2d72ce056e1d29cacc70836fe2bc3a517f3f9a53eed3d77ef370ad6dcf80b3f34ced1c547c7d2e679e8e47002355f938213b3656b206

V*

De werkingsregels is dat de primaire identifier wordt gehanteerd in de berichten.

De primaire identifier voor onderwijsdeelnemer is het ECKiD.

Er is nog geen primaire identifier voor onderwijsmedewerkers. Enkel secundaire identifiers worden gehanteerd.

In geval van een uitzonderingssituatie kan gebruik gemaakt van een secundaire identifier.

Als userMasterIdentifier gevuld is, dient userIds leeg te zijn en andersom.

userIds

array

userId

Een lijst van secundaire identifiers die gehanteerd kan worden als de primaire identifier ontbreekt.

[{userId: ‘pietjepukkelen@petteflatcollege', userIdType: 'nlEduPersonRealId’}]

V*

Zodra een secundaire identifier voor een uitzonderingssituatie gehanteerd wordt dan wordt naast het Id ook het Type gespecificeerd.

Zie de pagina Identiteiten voor de toegestane secundaire identifiers.

Release notes

0.0.1: Referenties naar onderwijsorganisatie en eindgebruiker toegevoegd om vanuit de overige API pagina’s naar te verwijzen.
0.9.0: Het Bestuurlijk Overleg heeft tijdens de bijeenkomst van 27 juni 2024 het Afsprakenstelsel Edu-V als versie 0.9.0 goedgekeurd voor implementatie.
0.9.1: Documentatie van de secundaire identifier voor een Onderwijsorganisatie aangepast met een correcte secundaire identifier.