Progress API
- Koen Voermans
Titel | Progress API |
Status | In ontwikkeling ROSA-Architectuurscan BEsluitvorming implementatie in beheer |
Versie | Documentatie: 0.0.5 |
schemaVersion: 0.0.5 | |
Datum | 27 September 2024 |
Auteur | Werkgroep Evalueren leervoortgang en resultaten |
Acties |
|
De Progress API wordt gebruikt om informatie over leermateriaalgebruik te delen in het Afsprakenstelsel Edu-V. Deze API wordt aangeboden als onderdeel van de gegevensdienst leermateriaalgebruik met de Gebruiksomgeving digitaal leermateriaal als Verzender.
De technische specificatie bestaat uit:
Samenvatting
Gegevensdienst | Leermateriaalgebruik |
Scopes |
|
Berichten | |
Verzender |
|
Ontvanger |
|
Endpoints | Leermiddelendashboard
|
Bericht: SimpleProgress (Leermateriaalgebruik)
In dit bericht wordt aangegeven of de onderwijsdeelnemer het leermateriaal heeft gestart of afgerond. Daarnaast kan de Aanbieder een signaal meesturen naar het Leermiddelendashboard. Dit signaal bestaat uit een indicator voor follow-up (pleaseFollowUp), een beschrijving (additionalInfo) en een deeplink (detailUrl) naar de rapportage in de Gebruiksomgeving digitaal leermateriaal.
Veld | Type | Format | Omschrijving | Voorbeeld | O/V | Vullingsregel |
id | string | uuid | Unieke identifier voor dit bericht over leermateriaalgebruik |
| V | Indien de status wijzigt wordt hetzelfde id gehanteerd. |
student | object | userReference | De onderwijsdeelnemer waarvoor leermateriaalgebruik wordt gemeld. |
| V | |
school | object | schoolreference | De onderwijsaanbieder waarde onderwijsdeelnemer het leermateriaal heeft gebruikt |
| V | |
assignable | string | string | Referentie naar de Assignable Unit (Leermateriaal) waarvoor het voortgangsgeven wordt gedeeld. |
| V | Voor meer info zie Course API |
courseId | string | string | Referentie naar de Course waarvoor het voortgangsgegeven wordt gedeeld. |
| V | Voor meer info zie Course API |
status | string | ENUM | Status van het leermateriaalgebruik geeft aan of het Leermateriaal door de onderwijsdeelnemer is gestart of afgerond. | not-started started completed abandoned | V | not-started wordt alleen gestuurd om de status van started te annuleren bij een foutcorrectie |
timestamp | string | datetime | Tijdstempel van actie die als trigger heeft gediend voor het event | 2017-07-21T17:32:28Z | V |
|
additionalInfo | string | string | Korte omschrijving van een signalering die getoond wordt bij het leermateriaalgebruik | Good Attention | O | De omschrijving is kort en kan zo gemakkelijk getoond worden bij het voortgangs-gegeven in de UI van het Leermiddelendashboard. |
detailsUrl | string | url | Deeplink naar een detailrapportage in de Gebruiksomgeving digitaal leermateriaal met meer informatie voor de onderwijsdeelnemer of onderwijsmedewerker. | O |
| |
pleaseFollowUp | boolean | boolean | Indicator of dit Leermateriaalgebruik aandacht betreft van de onderwijsmedewerker | True False | O |
|
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 API specifieke status- en foutcodes.
Technisch: API specificatie
Release notes
0.0.1: Berichtdefinities overgenomen en Progress API YAML uitgewerkt.
0.0.2: Referentie naar een eindgebruiker gewijzigd en ook edu_org_id toegevoegd als query parameter voor Regie op gegevens.
0.0.3: Er zijn wijzigingen uit de architectuur verwerkt:
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.4: Typo’s in de YAML.
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.