Titel | Technische specificatie digitale identiteiten |
Status | IN ONTWIKKELING ROSA-ARCHITECTUURSCAN BESLUITVORMING IMPLEMENTATIE IN BEHEER |
Versie | 0.0.1 |
Datum | 5 Maart 2024 |
Auteur | Architectenraad Edu-V |
Acties |
|
In de bericht- en koppelvlakspecificaties wordt veelvuldig verwezen naar onderwijsorganisaties, 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 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 | 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 OnderwijsaanbiederCode. 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: ‘09QQ00', organisationIdType: 'VE_CODE’}] | 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. Op deze pagina is ook de ENUM weergegeven van de primaire en secundaire identifiers. |
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 | string | 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. |
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.