Titel | Results API | ||||||||||||||||||||||||
Status |
| ||||||||||||||||||||||||
Versie | Documentatie: 1.0.9.20 | ||||||||||||||||||||||||
schemaVersion: 1.0.9.20 | |||||||||||||||||||||||||
Datum11 November 2024 | 13 maart 2025 | ||||||||||||||||||||||||
Auteur | Werkgroep Toetsen en examineren | ||||||||||||||||||||||||
Acties |
|
...
0.0.1: Eerste draft van de API.
0.0.2: Berichtdefinities 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:
Query parameter edu_org_id is toegevoegd aan alle endpoints als implementatie van regie op gegevens en de M2M identificatie en authenticatie.
Het transactiepatroon melding bevestiging is toegepast voor het uitwisselen van het Result berichten. Dit heeft geresulteerd in PUT endpoint voor de meldingen voor de relevante referentiecomponent Cijferadministratie.
BasispoortIDs zijn toegevoegd als opties voor Onderwijsdeelnemer, Onderwijsmedewerker en School.
De status- en foutcodes zijn toegevoegd aan de documentatie en aan 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: Het bericht Score is toegevoegd. Tevens zijn er een bundel van toetsresultaten en een bundel van toetsscores toegevoegd. In de YAML zijn deze berichten geïmplementeerd in PUT (enkele score/resultaat) en POST (meerdere scores/resultaten) endpoints.
0.0.5: GET endpoints om een resultaat of een score op basis van id op te vragen bij het Digitaal toetssysteem zijn aan de YAML toegevoegd. Dit stelt een cijferadministratie in staat om bij onduidelijkheid over de status van een resultaat of een score de laatste gegevens op te vragen.
0.0.6: De status- en foutcodes zijn toegevoegd aan de documentatie en aan de YAML.
0.0.7: De berichtdefinities zijn gewijzigd: de vier berichten score en resultaat (individueel en gebundeld) zijn gecombineerd tot 1 bericht met scores en resultaten van een toetsdeelnemer zoals door de werkgroep gewenst. Verwijzing naar cijferadministratie is weggepoetst.
0.0.8: Correcties en verduidelijkingen aangebracht n.a.v. reviewcommentaren van de werkgroep. Naar aanleiding van bespreking zijn de volgende wijzigingen aangebracht:
Het object AssessmentScoresAndResults is uitgebreid met schoolPeriod, assessmentSystem en school,
Het object Assessment (Toetsdefinitie) is uitgebreid met toetsonderdelen in parts
Het object ScoreScale (Scoreschaal) is vervangen door definitie van meerdere scoreschalen in attribuut scoreScales binnen AssessmentScoresAndResults .
Het object StudenttScoresAndResults is uitgebreid met attributen dateCreated en dateLastModified,
Individuele score (in object Score) is uitgebreid met attribuut scoreMaximum en verwijzing naar betreffende toetsonderdeel (assessmentId) en scoreschaal (scoreScaleId).
Individueel resultaat (in object Result) is uitgebreid met verwijzing naar betreffende toetsonderdeel (assessmentId).
Resultaattypen uitgebreid met DLE.
Attribuut index (volgnummer) toegevoegd aan object AssessmentPart.
0.0.9: Wijzigen in de architectuur zijn verwerkt:
Attribuut schemaVersion is verwijderd uit de berichtspecificaties.
Query parameter schemaVersion is verwijderd uit de koppelvlakken.
Query parameter edu_org_id is verwijderd uit de koppelvlakken waar consent voor nodig is.
Primaire en secundaire identifiers voor onderwijsaanbieders en eindgebruikers bijgewerkt.
0.0.10: Leermiddelendashboard toegevoegd als Ontvanger van leerresultaten.
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.
; daarmee is de scope nueduv.result
. Dit stelt leveranciers in staat om onderscheid te maken tussen gegevensuitwisselingen met leveranciers binnen en buiten het Edu-V afsprakenstelsel.Het veld ‘id’ binnen object Assessment en AssessmentPart consistent in de specs gemaakt: het hoeft geen uuid te zijn, kan ook toetscode uit OSO toetscodelijst zijn. Wel altijd maximaal 36 karakters (= lengte van uuid).
De Vestigingserkenning is als secundaire identifier voor een onderwijsaanbieder verwijderd uit de koppelvlakspecificatie.
De velden ‘subjects’ en ‘studyLevelId' binnen object Assessment toegevoegd. Ook resultaattype 'percentiel’ toegevoegd aan enumeratie ResultType_enum.
Correctie van YAML: datatype name naar string binnen AssessmentPart (was integer).
Voorbeelden van arrays in de tabellen consistent gemaakt.
0.9.2: Wijzigingen naar aanleiding van RFC’s:
De statuscode 201 (Created) is toegevoegd voor correcte synchrone verwerking (RFC0023).
De enumeratie van de employee identifier types in het schema (YAML) gecorrigeerd en daarmee in lijn gebracht met de specificatie in Identiteiten voor onderwijsdeelnemers, d.w.z. NEPPI is vervangen door NEPRI en ECK iD is vervangen door LAS-key (RFC0024).
De vier voorbeeldfoutcodes in de specificatie zijn toegevoegd aan de algemene lijst van Status- en foutcodes (RFC0025).
Het veld employees in object AssessmentScoresAndResults is optioneel gemaakt en dus is de kardinaliteit gewijzigd in 0..*.
1.0.0: Na succesvolle implementatie in najaarsrelease in beheer genomen.