Results API
Titel | Results API |
Status | In ontwikkeling ROSA-Architectuurscan BEsluitvorming implementatie in beheer |
Versie | Documentatie: 2.0.0 |
schemaVersion: 2.0.0 | |
Datum | 21 Maart 2025 |
Auteur | Werkgroep Toetsen en examineren |
Acties |
|
De Results API wordt gebruikt om leerresultaten te delen in het Afsprakenstelsel Edu-V. Deze API wordt aangeboden als onderdeel van de gegevensdienst Leerresultaten met het Digitaal toetssysteem of de Gebruiksomgeving digitale leermiddelen als Verzender.
Scope: werkingsgebieden funderend onderwijs en vavo
De afspraken met betrekking tot het administreren van leerresultaten 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 Onderwijs Koppelingen Examinering.
De technische specificatie bestaat uit:
Samenvatting
Gegevensdienst |
|
Scopes |
|
Entiteiten | |
Verzender |
|
Ontvanger |
|
Endpoints | Administratiesysteem leerresultaten
Leermiddelendashboard
|
POST /results
Operatie met endpoint POST /results in het koppelvak van Administratiesysteem leerresultaten of Leermiddelendashboard wordt door het Digitaal toetssysteeem aangeroepen:
Operatie en endpoint | POST /results |
---|---|
OperatieID | postResults |
Samenvatting | Het verzoek om bij het ontvangende systeem de toetsscores & -resultaten te verwerken voor een individuele onderwijsdeelnemer of groep van onderwijsdeelnemers. |
Beschrijving | Lijst van score & resultaat items per onderwijsdeelnemer, met het verzoek nieuwe scores/resultaten te creëren of bestaande scores/resultaten te wijzigen. Het bericht is ingericht op groepsgewijze aanlevering of aanlevering van individuele onderwijsdeelnemer. Bij de lijst is algemene informatie gevoegd zoals toets/examen, afnamemoment en opmerkingen. |
Tags | Administratiesysteem leerresultaten |
Parameters bij request | - |
Object in request body | Object AssessmentScoresAndResults, met onderliggende objecten StudentScoresAndResults, Assessment en ScoreScale. |
Antwoorden (statuscodes) | 201 (Created): “Het verzoek is geaccepteerd de verwerking heeft plaatsgevonden; dit heeft tot de creatie van een resource geleid.“ 202 (Accepted): “Het verzoek is geaccepteerd voor verwerking, maar de verwerking heeft nog niet plaatsgevonden; in feite zou de verwerkingen nog niet gestart kunnen zijn. De verwerking zal later wel of niet plaatsvinden, waarbij het verzoek bij de verwerking eventueel zou kunnen worden afgewezen.“ In deze eerste versie kunnen ontvangende systemen alleen terugkoppeling geven op bericht niveau. Ofwel, een bericht is volledig geaccepteerd (202 of 201), of een bericht is volledig geweigerd (400). Fouten die door middel van HTTP-resultaatcodes 400, 401 en 403 kunnen worden teruggeven, hebben dus alleen betrekking op het bericht. Niet op de individuele resultaten. |
Antwoorden (foutcodes) | 400 (Bad request) 401 (Unauthorized) 403 (Forbidden) |
Object AssessmentScoresAndResults
Het gegevensobject AssessmentScoresAndResults (Toetsscores en -resultaten) inclusief onderliggende objecten StudentScoresAndResults (Deelnemerscores en -resultaten) met bijbehorende gegevensgroepen omvat de gegevens over de scores en resultaten door individuele onderwijsdeelnemers behaald bij een bepaalde toetsafname, en wordt in onderstaande figuur weergegeven.
In bovenstaand figuur wordt het gegevensobject AssessmentScoresAndResults weergegeven. Dit object heeft stereotype <Entiteittype> om aan te geven dat dit een entiteit is. Dit object omvat de gegevenselementen id tot en met toolName zoals in het blok getoond met kardinaliteit over verplichting en hoeveel keren dit element mag voorkomen. Bij ontbrekende kardinaliteit is dit exact 1 (verplicht 1 keer).
Deze elementen zijn attributen of gegevensgroepen. Een attribuut is een gegevensveld met een waarde, ieder attribuut heeft een datatype. Wanneer dit datatype een lijst van waarden (enumeratie) is dan wordt deze enumeratie (stereotype <Enumeratie>) getoond. De relatie tussen een object en betreffende enumeratie is schematisch gerepresenteerd door een pijl van object naar enumeratie.
Bijvoorbeeld attribuut id is een gegevensveld van type CharacterString en attribuut status is gegevensveld van type enumeratie StatusType_enum (en in het figuur is dan ook een pijl getekend naar deze enumeratie).
Een gegevensgroep is een element met deelelementen gedefinieerd door een object. Ieder object is van type groep (stereotype <Groep>) of entiteit stereotype <Entiteittype> wanneer dit object een entiteit is. De relatie tussen een object en betreffende gegevensgroep is schematisch gerepresenteerd door een pijl van object naar deelobject.
Bijvoorbeeld het element school is een gegevensgroep van type SchoolReference (en in het figuur is dan ook een pijl getekend naar het object SchoolReference).
In het gegevensobject AssessmentScoresAndResults bevinden zich de gegevens zoals in navolgende tabel gespecificeerd.
In de kolom “O/V” in navolgende tabellen wordt aangegeven of het element (veld/object/array) optioneel (O) of verplicht (V) is; bij vermelding V* in deze kolom is de verplichting conditioneel en wordt de voorwaarde uit de vullingsregel duidelijk gemaakt.
Veld | Type | Format | Omschrijving | Voorbeeld | O/V | Vullingsregel |
id | string | uuid | Unieke identifier voor dit object . | ad80f160- cd06-48dd-af15-84263e173082 | V | Indien de status van dit object wijzigt wordt hetzelfde id gehanteerd. |
additionalInfo | string | string | Additionele informatie of opmerking over de afname | HAVO-normering Betrapt op spieken Internet viel uit | O | Dit veld kan bijvoorbeeld gebruikt worden om onderscheid te maken in toetsresultaten van dezelfde onderwijsdeelnemer met een normering op HAVO en VWO niveau. Ook kan het veld gebruikt worden om een reden op te geven waarom de afname is afgebroken. |
assessment- | string | datetime | Tijdstempel van moment waarop de toetsafname gestart of afgesloten is. | 2017-07-21T17:32:28Z | V |
|
assessment-Definition | object | Assessment | Definitie van toets en eventuele toetsonderdelen bestaande uit identifier en naam van toets en toetsonderdelen. |
| V | Deze toetsdefinitie is gespecificeerd in het object Assessment. De toetsdefinitie hoeft niet bekend te zijn bij de ontvanger. Vanuit individuele score of resultaat kan worden verwezen naar de toets of een toetsonderdeel uit deze toetsdefinitie. |
employees | array | object EmployeeReference | Lijst van verwijzingen naar onderwijsmedewerkers die het Toetsresultaat van de onderwijsdeelnemers mogen administreren in het ontvangende systeem. | [{ “userMasterIdentifier”: “ABC456”, “userIds”: [ { “userId”: “XYZ456”, “userIdType”: “ASI” } ] }] | V* | In vo is voor uitwisseling naar Administratiesysteem leerresultaten (zoals Magister of Somtoday) minimaal 1 onderwijsmedewerker verplicht om de resultaten in het ontvangende systeem te kunnen doorzetten. Een verwijzing naar een onderwijsmedewerker is gespecificeerd in een object Waarde van |
reviewUrl | string | url | Een URL naar de details over alle scores en resultaten van dit object in het Digitaal toetssysteem. Door het volgen van deze URL kan aanvullende informatie over de resultaten worden ingezien. | https://toetssysteem.nl/review123abc | O | Het moet een complete en geldige URL zijn. In andere (internationale) standaarden wordt dit veld ook wel deeplink of submission review url genoemd. |
school | object | object SchoolReference | Verwijzing naar de onderwijsorganisatie waar de onderwijsdeelnemers de opleiding volgen waarvoor ze deelnemen aan de toetsafname. | [{ “organisationMasterIdentifier”: “ABC123”, “organisationIds”: [ { “organisationId”: “XYZ123”, “organisationIdType”: “AS_ID” } ] }] | V | Deze verplichte verwijzing naar de school/organisatie is gespecificeerd in een object Waarde van |
schoolPeriod | string | string | Een referentie naar een Schoolperiode (SchoolPeriod) waarop de scores en resultaten betrekking hebben. | 2024-2025 | V | Binnen po en vo wordt hier alleen het bekende, vaste formaat “eejj-eejj“ voor schooljaar gebruikt (e staat voor eeuw, j staat voor jaar). |
scoreScale-Definitions | array | ScoreScale | Definitie van de scoreschalen die van toepassing zijn op de scores en resultaten. |
| O | Deze scoreschaal is gespecificeerd in het object ScoreScale. Vanuit individuele score kan worden verwezen naar een of meer scoreschalen. |
studentScores-AndResults | array | StudentScoresAndResults | De scores en resultaten van een individuele onderwijsdeelnemer. |
| O | Deze lijst van objecten StudentScoresAndResults bevat per object de scores en -resultaten van een onderwijsdeelnemer. Deze lijst mag ontbreken als alle scores en resultaten van alle onderwijsdeelnemers ontbreken, bijvoorbeeld door calamiteit. |
timestamp | string | datetime | Tijdstempel waarop het bericht is samengesteld. | 2017-07-21T17:32:28Z | V |
|
toolName | string | string | De naam van het systeem (de tool) waaruit de scores en resultaten zijn verzonden. | Toetssysteem A | O |
|
Object Assessment
Het gegevensobject Assessment (Toetsdefinitie) omvat de definitiegegevens van een toets eventueel met toetsonderdelen, en wordt in onderstaand figuur weergegeven.
In het gegevensobject Assessment bevinden zich de gegevens zoals in navolgende tabel gespecificeerd.
Veld | Type | Format | Omschrijving | Voorbeeld | O/V | Vullingsregel |
id | string | string | Unieke identifier voor de toets | 6c92d082- 0d03-4194-b352-988b2e6f9ae6 TV_GRA-01 | V | Dit id hoeft niet bekend te zijn bij de ontvanger. Dit id van maximaal 36 karakters kan een toetscode zijn uit de OSO toetscodelijst of een leverancier-eigen uuid. |
name | string | string | Naam van de toets die bij de score of het resultaat kan worden getoond, bijvoorbeeld in de administratie om de toetsresultaten aan een resultaatkolom toe te wijzen | Schoolexamen | V | De naam van de toets is herkenbaar voor de medewerkers. |
version | string | string | Versie van de toets | 2 | O | Voor verwijzing naar de versie van de toets, met name bedoeld voor methodetoetsen. Bij kleine wijzigingen in de normering blijft het id van de methodetoets gelijk en is er een nieuwe versie; die versie wordt geduid in dit veld. |
subjects | array | [ subjectPrefix, subjectName ] | Vakken of leergebieden van de toets | [ | O | Deze optionele lijst van vakken/leergebieden van objecten Dit object |
studyLevelId | string
| uuid | Code als verwijzing naar het onderwijsniveau van de toets | 82ca4442-246c-44b3-a562-7b101793feb4 | O | Waarde is de referentie naar het betreffende onderwijsniveau in Object StudyLevel (zoals in Education API) en gevuld met waarden uit Waardelijst Onderwijsniveaus, gebaseerd op de niveaus van SLO (deze is hier te vinden). Binnen po worden alleen de enkelvoudige onderwijsniveaus gebruikt, zoals referentie naar “Groep 1” of “Groep 8”. |
parts | array | [ id, name, index ] | De onderdelen van de toets voor duiding van een score of resultaat | [ | O | Deze lijst bestaat uit objecten Een toets hoeft geen onderdelen te hebben, dus deze lijst is optioneel. |
| string | string | Unieke identifier voor het toetsonderdeel | part3 | V | Het id van maximaal 36 karakters kan een toetscode zijn uit de OSO toetscodelijst of een leverancier-eigen uuid. |
| string | string | Naam van het toetsonderdeel die bij de score of het resultaat kan worden getoond, bijvoorbeeld in de administratie om de toetsresultaten aan een resultaatkolom toe te wijzen | Module 3 | V | De naam van het toetsonderdeel is herkenbaar binnen de toets. |
| integer | integer | Het volgnummer van het toetsonderdeel om toetsonderdelen in volgorde van voorkeur te kunnen tonen | 3 | V | Getal groter gelijk aan 1. Er mogen geen |
Object ScoreScale
Het gegevensobject ScoreScale (Scoreschaal) omvat de definitiegegevens van een scoreschaal, en wordt in onderstaand figuur weergegeven.
In het gegevensobject ScoreScale bevinden zich de gegevens zoals in navolgende tabel gespecificeerd.
Veld | Type | Format | Omschrijving | Voorbeeld | O/V | Vullingsregel |
id | string | uuid | Unieke identifier voor de scoreschaal. | 6c92d082- 0d03-4194-b352-988b2e6f9ae7 | V | Deze identifier hoeft niet bekend te zijn bij de ontvanger. |
name | string | string | Naam van de scoreschaal die wordt/is gebruikt om scores in resultaten om te zetten. | OVG-schaal | V | De naam van de scoreschaal is herkenbaar voor de medewerkers. |
scoreScaleEntries | array | [ LHS , RHS ] | De items van scoreschaal in combi LHS en RHS die de scoreschaal definiëren. Een item uit de lijst geeft voor een waarde of interval van waarden (LHS) aan welke resultaatwaarde (RHS) daarvoor geldt. | [{ “0.0-5.4”, “Onvoldoende”},{“5.5-10.0”, “Voldoende”}] [{“0-54”, “5”}, {“55-64”, “6”}, {“65-74”, “7”}, {“75-84”, “8”}, {“85-99”, “9”}, {“100”, “10”}] | V | Deze lijst is verplicht binnen dit object. Een item uit de lijst bestaat uit het object
|
| string | string | Waarde of interval van waarden voor score levert de resultaatwaarde zoals in | 100 0.0-5.4 75-84 | V | De waarde is een enkele getalswaarde ('x') of een bereik van twee getallen ('y-z'). In geval van enkelvoudige is de waarde x de ondergrens van het interval. Bij het bereik zijn de getallen y en z de onder- respectievelijk bovengrens van het interval. Intervallen zijn inclusief de grenswaarden. Let op, deze waarde en de beide getallen van het interval moeten voldoen aan het betreffende scoretype (van de toe te passen scorewaarde). |
| string | string | De resultaatwaarde die voor waarde/interval in | 10 Onvoldoende 8 | V |
|
Object StudentScoresAndResults
Het gegevensobject StudentScoresAndResults bestaat uit een gegevensblok met de scores en resultaten van een individuele onderwijsdeelnemer, en wordt in onderstaand figuur weergegeven.
In het object StudentScoresAndResults bevinden zich de gegevens zoals in navolgende tabel gespecificeerd.
Veld | Type | Format | Omschrijving | Voorbeeld | O/V | Vullingsregel |
id | string | uuid | Unieke identifier voor dit item met individuele scores en resultaten | 14d807e9-8684-4a84-bc08-d48cd20eb733 | V | Indien de status of het resultaat wijzigt wordt hetzelfde id gehanteerd. |
additionalInfo | string | string | Additionele informatie of opmerking over deze scores en resultaten van deze deelnemer | HAVO-normering Betrapt op spieken Fraude Niet aanwezig | O | Dit veld kan bijvoorbeeld gebruikt worden om onderscheid te maken in toetsresultaten van dezelfde onderwijsdeelnemer met een normering op HAVO en VWO niveau. Ook kan het veld gebruikt worden om een reden op te geven waarom er een resultaat ontbreekt. |
missing | boolean | {True,False} | Geeft aan of scores en resultaten ontbreken | True, False | V* | Verplicht als |
results | array | object | Een of meerdere resultaat-items die zijn behaald door een individuele deelnemer bij deze afname. | O |
| |
reviewUrl | string | url | Een URL naar de details over deze scores en resultaten van deze deelnemer in het Digitaal toetssysteem. Door het volgen van deze URL kan aanvullende informatie over de resultaten worden ingezien. | https://toetssysteem.nl/deelnemer123abc/review123abc | O | Het moet een complete en geldige URL zijn. In andere (internationale) standaarden wordt dit veld ook wel deeplink of submission review url genoemd. |
scores | array | object | Een of meerdere score-items die zijn behaald door een individuele deelnemer bij deze afname. | O |
| |
status | string | ENUM | De status van dit deelnemer scores/resultaten item | in progress | O | Dit veld is additioneel toegevoegd en kan gebruikt worden om toetsresultaten in verschillende stadia door te sturen. Defaultwaarde is final |
student | object | StudentReference | Verwijzing naar de onderwijsdeelnemer die de scores en resultaten heeft behaald bij de betreffende toetsafname. | [{ “userMasterIdentifier”: “ABC123”, “userIds”: [ { “userId”: “XYZ123”, “userIdType”: “ASI” } ] }] | V | De verplichte verwijzing naar een onderwijsdeelnemer is gespecificeerd in een object |
dateCreated | string | datetime | Datum en tijdstip waarop de entiteit (dit object StudentScoresAndResults) is aangemaakt. | 2024-07-21T17:32:28Z | V | Let op, dit is dus niet datumtijdstip van afname! |
dateLastModified | string | datetime | Datum en tijdstip waarop één of meerdere van de hierboven genoemde attributen het laatst zijn gewijzigd | 2024-08-11T15:31:12Z | V |
|
Object ResultEntry
Het gegevensobject ResultEntry (Resultaat item) omvat de gegevens van een resultaat, en wordt in onderstaand figuur weergegeven.
In het gegevensobject ResultEntry bevinden zich de gegevens zoals in navolgende tabel gespecificeerd.
Veld | Type | Format | Omschrijving | Voorbeeld | O/V | Vullingsregel |
resultValue | string | string | De resultaatwaarde zoals behaald door de toetsdeelnemer. | Onvoldoende 5.1 | V | Bevat de waarde van het scoregetal en deze waarde moet voldoen aan de typering in |
resultType | string | string | Type van resultaatwaarde (In veld resultValue) | OVG Grade0.0-10.0 | V | De waarde komt uit waardelijst ResultTypes. |
assessmentId | string | string | Verwijzing naar betreffende toets in toetsdefinitie (assessment) waartoe het resultaat behoort. | d262b545-12b1-4383-baa5-0fc825e133ac | V | Let op, verwijst naar de toets die is gespecificeerd in de toetsdefinitie in |
assessmentPartId | string | string | Verwijzing naar betreffende toetsonderdeel in toetsdefinitie (assessment) waartoe het resultaat behoort. | part3 | O | Let op, verwijst naar een bestaand toetsonderdeel binnen de toets zoals geïdentificeerd in veld |
Waardelijst ResultTypes (ResultTypes_enum) heeft de toegestane waarden, met bijbehorende naam, definitie, waardebereik en werkingsgebied voor het veld resultType binnen object ResultEntry zoals weergegeven in onderstaande tabel.
Waarde | Naam | Definitie | Waardebereik | Werkings-gebied |
---|---|---|---|---|
AE | AE | Niveauaanduiding volgens schaal A tot en met E, waarbij de vaardigheid van de leerling wordt vergeleken met alle leerlingen (van hetzelfde leerjaar) in Nederland. Toelichting Niveau A+ betekent dat de leerling tot de 10% hoogst scorende leerlingen behoort. | {A+,A,B,C,D,E} | PO |
AVI | AVI | Niveauaanduiding voor leesvaardigheid. Toelichting Voorbeeld AVI-E6 betekent leesvaardigheid van 'eind groep 6’. | {AVI-Start, | PO |
CAE | Gecorrigeerde AE | Gecorrigeerd niveauaanduiding volgens schaal A tot en met E, wanneer de afgenomen toets van een ander leerjaar is dan de leerling, en/of als de afnamedatum in een andere afnameperiode valt dan die bij de toets hoort. Toelichting | {A+,A,B,C,D,E} | PO |
CIV | Gecorrigeerde IV | Gecorrigeerd niveauaanduiding volgens schaal I tot en met V, wanneer de afgenomen toets van een ander leerjaar is dan de leerling, en/of als de afnamedatum in een andere afnameperiode valt dan die bij de toets hoort . Toelichting | {I+,I,II,III,IV,V,V-} | PO |
DLE | DLE | Geeft aan hoeveel maanden onderwijs een gemiddelde leerling nodig heeft om hetzelfde niveau te bereiken. DLE is de afkorting van Didactische Leeftijd Equivalent. Toelichting Voorbeeld Eind groep drie heeft een leerling tien maanden onderwijs gevolgd en is de DL 10. Heeft de leerling DLE 12 behaald dan loopt het twee maanden voor op het gemiddelde. DLE “<x” (resp. “>y“ ) geeft aan dat niveau lager dan x (resp. hoger dan y) is getoetst maar omdat de doelgroep van de toets vanaf DL x (tot en met DL y) is, is geen exactere duiding van het niveau mogelijk. | Geheel getal uit [0,100], eventueel voorafgegaan door < of > | PO |
Education-Level | Onderwijs-niveau | Onderwijsniveau Toelichting | {PrO, VMBO-BB, VMBO-KB, VMBO-GL/TL, HAVO, VWO} | PO en VO |
Functioning-Level | Functionerings-niveau | Het functioneringsniveau (FN) geeft aan met welke gemiddelde leerling in het reguliere basisonderwijs de vaardigheid van de getoetste leerling te vergelijken is. Toelichting Voor IEP LVS toetsen geeft dit aan dat op basis van de behaalde ontwikkelscore de leerling de leerdoelen van een bepaald niveau beheerst (SLO-leerdoelen en Referentiekader); bij a spreken we over de leerdoelen van het eerste helft van het schooljaar en bij b spreken we over de leerdoelen van de tweede helft), De ontwikkelscore is gelijk of hoger dan de drempelwaarde. Voorbeeld 1 FN “M4” is dus te vergelijken met het landelijk gemiddelde niveau van ‘midden groep 4’. Voorbeeld 2 FN “M4E4” betekent dat het vaardigheidsniveau van de getoetste leerling tussen het landelijk gemiddelde niveau voor medio groep 4 en eind groep 4 ligt. Voorbeeld 3 FN “>E5” geeft aan dat het resultaat hoger dan de E5 is maar er is geen exactere duiding van het niveau mogelijk. Voorbeeld 4 FN “4a” geeft aan de de leerling de leerdoelen van dat niveau beheerst en kan hij/zij gaan werken aan de leerdoelen van het volgende niveau (4b). Dit type is gelijk aan OSO-referentiescore FN. | Voor Cito toetsen: {<M3, M3, M3E3, E3, E3M4, M4 tot en met E7, E7M8, M8, >M8} en eventueel Mx of Ex voorafgegaan door < of >. Voor IEP LVS toetsen: {3a, 3b, 4a, 4b, 5a, 5b, 6a, 6b, 7a, 7b, 8a, 8b} | PO |
Grade0-10 | Schoolcijfer 0-10 | Resultaat is een schoolcijfer (geheel getal van 0 tot en met 10). | Geheel getal uit [0,10] | PO en VO |
Grade0.0-10.0 | Schoolcijfer 0.0-10.0 | Resultaat is een schoolcijfer (decimaal getal van 0.0 tot en met 10.0). | Getal (1 decimaal) uit [0.0,10.0] | PO en VO |
IV | IV | Niveauaanduiding volgens schaal I tot en met V, waarbij de vaardigheid van de leerling wordt vergeleken met alle leerlingen (van hetzelfde leerjaar) in Nederland. Toelichting Niveau I+ betekent dat de leerling tot de 10% hoogst scorende leerlingen behoort; Niveau V- betekent dat de leerling tot de 10% laagst scorende leerlingen behoort. | {I+,I,II,III,IV,V,V-} | PO |
LA | Leer-achterstand | Het gegeven dat met behulp van de waarde van DL en van DLE volgens de formule ‘LA = 1- (DLE/DL)’ kan worden uitgerekend. Toelichting Voorbeeld Het DL van een kind is 22. Als de behaalde DLE 18 is, dan is de leerachterstand 1 - (18 / 22) = 0,18 (afgerond). | Decimaal getal uit [-1.00,1.00] | PO |
LGH | Laag-Gemiddeld-Hoog | Geeft aan of leerling “lager dan gemiddeld”, “gemiddeld” of “hoger dan gemiddeld” heeft gepresteerd. | {Laag,Gemiddeld,Hoog} | PO en VO |
OVG | Onvoldoende-Voldoende-Goed | Geeft aan in welke mate de leerling de leerstof of vaardigheid beheerst: onvoldoende, voldoende of goed. | {Onvoldoende, Voldoende, Goed} | PO en VO |
PassOrFail | Geslaagd/Gezakt | Geeft aan of leerling geslaagd of gezakt is (PassOrFail). | {Geslaagd, Gezakt} | VO |
Percentiel | Percentiel-score | Score volgens de indeling in gelijke percentielen; het is de maat die aangeeft hoe een score zich verhoudt tot de scores van een groep. | Getal uit [0,100] | PO en VO |
RnERK | Referentie-niveau ERK | Het Referentieniveau Europees ReferentieKader (ERK) is de indeling door de Raad van Europa voor de beheersing van diverse taalvaardigheden: spreken, schrijven, luisteren & lezen. Toelichting Het niveau “<A1” betekent ‘Lager dan A1' of 'Op weg naar A1’. Dit type is gelijk aan OSO-referentiescore ERK. | {<A1,A1,A2, B1,B2, C1,C2} | PO en VO |
RnTR | Referentie-niveau Taal en Rekenen | De referentieniveaus Taal en Rekenen (volgens Meijerink) zijn landelijke standaarden die beschrijven welk niveau leerlingen op specifieke momenten in hun onderwijsloopbaan moeten behalen op het gebied van taal en rekenen. Toelichting Dit type is gelijk aan OSO-referentiescore RNTRM. | {<1F,1F,<1S,1S, <2F,2F,2S, <3F,3F,3S, 4F,4S} | PO en VO |
Object ScoreEntry
Het gegevensobject ScoreEntry (Score-item) omvat de gegevens van een score, en wordt in onderstaand figuur weergegeven.
In het gegevensobject ScoreEntry bevinden zich de gegevens zoals in navolgende tabel gespecificeerd.
Veld | Type | Format | Omschrijving | Voorbeeld | O/V | Vullingsregel |
scoreValue | string | string | De scorewaarde zoals behaald door de toetsdeelnemer. | 64 | V | Bevat de waarde van het scoregetal en deze waarde moet voldoen aan de typering in scoreType. |
scoreType | string | string | Type van scorewaarde (In veld scoreValue) | zie Waardelijst ScoreTypes | V | De waarde komt uit waardelijst ScoreTypes. |
scoreMaximum | integer | integer | De maximaal te behalen scorewaarde (in veld scoreValue) | 100 | O | Waarde voldoet aan scoreType en de scoreValue is kleiner of gelijk aan deze waarde. Waarde is vaak een geheel getal (aantal) groter dan 0. |
assessmentId | string | string | Verwijzing naar betreffende toets in toetsdefinitie (assessment) waartoe de score behoort. | d262b545-12b1-4383-baa5-0fc825e133ac | V | Let op, verwijst naar de toets zoals gespecificeerd in de toetsdefinitie in |
assessmentPartId | string | string | Verwijzing naar betreffende toetsonderdeel in toetsdefinitie (assessment) waartoe de score behoort. | part3 | O | Let op, verwijst naar een bestaand toetsonderdeel binnen de toets zoals geïdentificeerd in veld |
scoreScaleIds | array | string | De verwijzingen naar de betreffende scoreschalen voor omzettingen van score naar resultaat. | [6c92d082- 0d03-4194-b352-988b2e6f9ae7, 7c92d083- 0d04-4195-b353-988b2e6f9ae8] | O | Iedere verwijzing moet zijn gedefinieerd in scoreScales (in object |
Waardelijst ScoreTypes (ScoreTypes_enum) heeft de toegestane waarden, met bijbehorende naam, definitie, waardebereik en werkingsgebied voor het veld scoreType binnen object ScoreEntry zoals weergegeven in onderstaande tabel.
Waarde | Naam | Definitie | Waardebereik | Werkings-gebied |
---|---|---|---|---|
NumberItems | Aantal gemaakte items | Aantal door leerling gemaakte opgaven/items. | Geheel getal uit [0,n] | PO en VO |
Number-Incorrect | Aantal fout gemaakt | Aantal fout gemaakte opgaven/items door leerling. | Geheel getal uit [0,n] | PO en VO |
Number-Correct | Aantal goed gemaakt | Aantal goed gemaakte opgaven/items door leerling. | Geheel getal uit [0,n] | PO en VO |
Percentage-Correct | Percentage goed | Percentage goed gemaakte opgaven door leerling. Toelichting | Getal (geheel of decimaal) uit [0,n] | PO en VO |
DurationIn-Seconds | Tijdsduur (in seconden) | Totaal aantal seconden dat de toetsafname voor de leerling heeft geduurd. | Geheel getal uit [0,n] | PO en VO |
ScorePoints | Scorepunten | Aantal door leerling behaalde punten na nakijk/correctie. Toelichting | Geheel getal uit [0,n] | PO en VO |
SkillScore | Vaardigheids-score | Het getal dat aangeeft wat een leerling kan op een leergebied; getal is de gemeten eenheid op de vaardigheidsschaal (ook wel Ontwikkelscore genoemd). Toelichting | Getal (geheel of decimaal; positief of negatief) uit eenheden van de vaardigheidsschaal. | PO en VO |
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 Results API specifieke status- en foutcodes.
Mogelijke voorziene foutsituaties zijn:
8001: De identifier van de onderwijsdeelnemer is onbekend.
8002: De identifier van de onderwijsmedewerker is onbekend.
8003: Een in het bericht opgenomen score is ongeldig gegeven de bijbehorende typering
8004: Een in het bericht opgenomen resultaat is ongeldig gegeven de bijbehorende typering
Technisch: API specificatie
Release notes
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.
2.0.0: Wijzigingen naar aanleiding van RFC’s:
Vullingsregel voor veld
schoolPeriod
toegevoegd (schooljaar volgens formaat “eejj-eejj“).Vullingsregel veld
employees
gewijzigd (alleen verplicht in vo voor administratiesystemen).Veld
version
(toetsversie) toegevoegd aan objectAssessment
.Vullingsregel in po voor veld
studyLevelId
binnen objectAssessment
toegevoegd (alleen enkelvoudige niveaus gebruiken).De objecten
ResultEntry
enScoreEntry
in eigen paragraaf beschreven.Veld
assessmentPartId
(toetsonderdeelcode) optioneel toegevoegd aan objectenResultEntry
enScoreEntry
(en veldassessmentId
hierbij verplicht gemaakt).In waardelijsten
ResultTypes
enScoreTypes
zijn tabellen aangevuld of verduidelijkt, voornamelijk in de kolommen “Definitie” en “Waardebereik”. ResultaattypenAE
,CAE
,IV
,CIV
,FunctioningLevel
,EducationLevel
,LGH
,AVI
,LA
toegevoegd.Veld
scoreScaleId
binnen objectScoreEntry
nu meervoudig: veld heet nuscoreScaleIds
.Technische API specificatie (OAS) aangepast volgens bovenstaande, inclusief correctie van
scoreScaleEntries
binnen objectScoreScale
(nu array, was enkelvoudig object) en correctie van de verplichting van de veldendateCreated
endateLastModified
binnen objectStudentScoresAndResults
.Figuren en tekstuele formuleringen in tabellen gecorrigeerd en/of verduidelijkt.
Merk op dat door de wijzigingen m.b.t. scoreScaleIds
en scoreScaleEntries
(meervoudig gemaakt) en het verplichten van enkele velden (o.a. assessmentId
binnen ResultEntry
en ScoreEntry)
, deze nieuwste versie niet backwards compatible is t.o.v. voorgaande versie 1.0.0. Deze versie heeft hierom het versienummer 2.0.0 gekregen.