Students API

Scope: werkingsgebieden funderend onderwijs en vavo

De afspraken met betrekking tot de gegevensdiensten uit de administratiesystemen zijn van toepassing op de werkingsgebieden:

• Primair onderwijs

• Gespecialiseerd onderwijs

• Voortgezet onderwijs

• Voortgezet algemeen volwassenenonderwijs (vavo)

De gegevensdiensten zijn niet ontwikkeld voor het middelbaar beroepsonderwijs. In het middelbaar beroepsonderwijs wordt gebruik gemaakt van OOAPI.

Attribuut geslacht wordt in de basis niet gedeeld

Het attribuut gender wordt alleen gedeeld met gegevensafnemers die hier een strikte noodzaak toe hebben. In de huidige configuratie van verplichte en optionele gegevensdiensten heeft enkel het Digitaal toetssysteem het recht om dit attribuut te ontvangen.

Echter niet alle applicaties die deze referentiecomponent implementeren zullen het geslacht nodig hebben. Het geslacht wordt dan ook alleen gedeeld met de applicaties die hier aantoonbaar een verwerkingsgrondslag voor hebben en deze hebben opgenomen in hun verwerkersovereenkomst. Een voorbeeld van een verwerkersgrondslag is de itemanalyse die uitgevoerd wordt als deelstap in het bepalen en vaststellen van een landelijke normering.

In de doorontwikkeling van de praktijksituatie Toetsen en Examineren zullen de referentiecomponenten worden herzien. Dit kan ertoe leiden dat de referentiecomponent Digitaal toetssyteem wordt gesplitst in bijvoorbeeld een afnameomgeving, rapportageomgeving en analyseomgeving. Dit geeft de mogelijkheid om het de demografische gegevens (waaronder geslacht) expliciet toe te wijzen aan de referentiecomponent die de gegevens ook daadwerkelijk nodig heeft.

Optioneel

Toegankelijkheid is een optioneel onderdeel van de Students API. Op basis van expliciete behoeften in ketenprocessen kunnen voorkeuren voor toegankelijkheid benut worden.

Er dient ook nader onderzocht te worden of toegankelijk op het niveau van een onderwijsdeelnemer zit of dat er ook een relatie is met een vak. Zodra dit laatste het geval is dan zal er ook gekeken moeten worden naar de Association API.

Voorstel: Landcodes

Voorstel is om niet de ISO landcodes te hanteren maar de landcodes die in het Nederlandse onderwijs vaak gebruikt worden, onder meer door DUO. Het betreft een waardelijst van de RIVG zoals weergeven in tabel 34 Landen.

• 0.0.1: De Rostering API was voorheen een onderdeel van de SIS API. Hierin waren de volgende wijzingen gedaan:

  • 0.0.1: Eerste draft van de API.

  • 0.0.2: Objecten en YAML files zijn toegevoegd t.b.v. de 80 procent specificatie.

  • 0.0.3: De technische specificatie is verder uitgewerkt. Ook is de feedback uit de werkgroepen verwerkt in een volgende versie:

    • GET all endpoints zijn toegevoegd voor alle objecten.

    • Query parameter edu_org_id is toegevoegd aan alle endpoints als implementatie van regie op gegevens en de M2M identificatie en authenticatie.

    • Object Teacher is hernoemd naar Employee inclusief het attribuut role. In dezelfde lijn is ook teacherReference hernoemd naar employeeReference

    • De waardelijst studyYear is verduidelijkt.

    • Het attribuut class van de Student is een separaat bericht geworden inclusief employees.

    • De status- en foutcodes zijn toegevoegd aan de documentatie en de YAML.

    • In de YAML is aangegeven welke referentiecomponent de endpoints aanbiedt als Producer.

    • De YAML is geactualiseerd op basis van de bovenstaande wijzigingen.

  • 0.0.4: Objecten geactualiseerd op basis van herziening rollen en referentiecomponenten in het architectuurkader.

  • 0.0.5: Terminologie in YAML bijgewerkt.

  • 0.0.6: Gegevensdiensten van SIS API opgesplitst in:

    • Onderwijsorganisatie

    • Adresgegevens fijndistributie

    • Onderwijsaanbod

• 0.0.2: De Students API is opgesteld op basis van een herziening van de SIS API. In deze herziening is aansluiting gezocht bij de best practices uit bestaande standaarden en een uiteenzetting van ontwerpeisen vanuit de flexibilisering van het onderwijs.

• 0.0.3: Filteropties voor de GET for School endpoints toegevoegd.

• 0.0.4: HuisnummerToevoeging stond niet correct in de YAML. De naam van de voorkeur voor toegankelijkheid ontbrak in de YAML. Beide punten zijn gecorrigeerd.

• 0.0.5: De volgende wijzigingen zijn gedaan:

  • Wijzigingen in de architectuur:

    • Attribuut schemaVersion is verwijderd uit de objecten.

    • Query parameter schemaVersion is verwijderd uit de koppelvlakken.

    • Query parameter edu_org_id is verwijderd uit de koppelvlakken waar consent voor nodig is.

    • Query parameters orgMasterId, orgId en orgIdType zijn toegevoegd om informatie over een onderwijsaanbieder op te vragen.

• 0.0.6: De separate endpoints voor de diverse scopes zijn gecombineerd in een enkel endpoint. Ook is een endpoint toegevoegd om een onderwijsmedewerker op te vragen op basis van een userId en een userIdType.

• 0.0.7: preferredFirstName attribuut toegevoegd aan object Student en name verwijderd uit object DeliveryAdress.

• 0.0.8: Toelichting bij attribuut gender toegevoegd waaruit blijkt dat dit attribuut in de basis niet wordt gedeeld.

• 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: Wijzigingen naar aanleiding van RFC’s:

  • Op basis van RFC002 is de scope aangepast met een prefix eduv.. Dit stelt leveranciers in staat om onderscheid te maken tussen gegevensuitwisselingen met leveranciers binnen en buiten het Edu-V afsprakenstelsel.

  • De parameters voor paginering zijn uit de koppelvlakspecificatie verwijderd. Binnen het afsprakenstelsel zijn de afspraken hierover beschreven op de pagina paginering, sorteren en rate limiting.

  • De Vestigingserkenning is als secundaire identifier voor een onderwijsaanbieder verwijderd uit de koppelvlakspecificatie.