API-definities voor Logistieke proces rondom de Doorstroomtoets in het PO bij afsprakenset "Logistiek Proces Doorstroomtoets po" De OAS3-definities (Defs) in YAML-bestand "doorstroomtoets-openapi.yaml" in de folder "swagger" zijn bedoeld voor de REST API t.b.v. Logisieke proces rondom de Doorstroomtoets PO (voor schooljaar 2023-2024), zie hiervoor de documentatie (https://app.swaggerhub.com/apis-docs/Kennisnet/Doorstroomtoets/1.0.1#) en het YAML-bestand (https://raw.githubusercontent.com/edustandaard/doorstroomtoets/main/swagger/doorstroom-openapi.yaml).
Deze uitwisseling omvat 3 interacties die schematisch worden gepresenteerd in de drie onderstaande sequencediagrammen.
sequenceDiagram
participant Toetssysteem
participant LAS
LAS->>Toetssysteem: hier is een Deelnemerslijst
activate Toetssysteem
Note left of Toetssysteem: endpoint /registreren (POST)
Toetssysteem-->>LAS: 202 - Bedankt, ik ga dit verwerken!
deactivate Toetssysteem
sequenceDiagram
loop voor elke leerling
Toetssysteem->>LAS: hier is het Leerlingresultaat
activate LAS
Note right of LAS: endpoint /leerlingresultaat (POST)
LAS-->>Toetssysteem: 202 - Bedankt, ik ga dit verwerken!
deactivate LAS
end
sequenceDiagram
participant Toetssysteem
participant LAS
LAS-->>Toetssysteem: geef mij dit leerlingrapport
activate Toetssysteem
Note left of Toetssysteem: endpoint /leerlingrapport (GET)
Toetssysteem->>LAS: 200 - Hier heb je m!
deactivate Toetssysteem
De meest recente versie is 1.0.1 waarbij de naamswijziging van Calamiteitentoets naar OCW Doorstroomtoets is doorgevoerd samen met correcties conform de specs als: maximum lengte van voorletters van leerling is 6, attribuut versie binnen Doorstroomtoets is optioneel, attribuut toetsdefinitie verwijst naar enumeratie Toetssoort_enum en attributen met datumtijd zijn nu expliciet gedefinieerd als ISO 6801 date and time. Verder zijn enkele voorbeeldwaarden gecorrigeerd.
Iedere publicatie van dit YAML-bestand voor de doorstroomtoetsketen is een getagde versie en is beschikbaar onder releases: https://github.com/edustandaard/doorstroomtoets/releases. Daar zijn tevens hulpmiddelen beschikbaar om getagde versies te vergelijken. Er kan maximaal worden teruggekeken naar en vergeleken met de eerste versie 1.0 (voor schooljaar 2023-2024).
Indien er problemen of verbetersuggesties zijn specifiek over de YAML dan graag indienen onder issues: https://github.com/edustandaard/doorstroomtoets/issues.