Uitwisseling Leerlinggegevens en Resultaten versie 2.2.1

Berichten

Een bericht is hetgeen verzonden wordt van het ene naar het andere ict-systeem met daarin de informatie die overgedragen moet worden.

In UWLR zijn een aantal basisstructuren gedefinieerd waarop de inhoud van de berichten zijn samengesteld. Afhankelijk van het scenario (het doel) en de stap in het protocol wordt de uiteindelijke gegevensstructuur van het bericht bepaald.

  1. Structuurverzoekbericht

    Protocol
    Getrapte overdracht

    Dit is het verzoek om alle groepgegevens van een school binnen het protocol Getrapte overdracht. Deze berichtstructuur is gelijk aan de aanroep voor een volledig set van leerlinggegevens en definieert ook de school waarvan men de gegevens wil hebben. Het kent daarnaast een ander omringende structuur.

  2. Leerlingenverzoekbericht

    Protocol
    Getrapte overdracht

    Dit is het verzoek om leerlinggegevens binnen het protocol Getrapte overdracht. Deze structuur is gelijk aan de aanroep voor een volledig set van leerlinggegevens en definieert ook de school waarvan men de gegevens wil hebben. Er wordt daarbij een specificatie van de gevraagde groepen aan toegevoegd. Het kent daarnaast een ander omringende structuur.

  3. Leerkrachtenverzoekbericht

    Protocol
    Getrapte overdracht

    Dit is het verzoek om leerkrachtgegevens binnen het protocol Getrapte overdracht. Deze structuur is gelijk aan de aanroep voor een volledig set van leerlinggegevens en definieert ook de school waarvan men de gegevens wil hebben. Er wordt daarbij een specificatie van de gevraagde groepen aan toegevoegd. Het kent daarnaast een ander omringende structuur.

  4. Toetsstructuur

    Dit is de gegevensstructuur voor de toetsdefinities. De toetsdefinities worden door de EA bepaald.

  5. Vocabulaire-structuur

    Protocol
    Vocabulaire-gebruik

    Vocabulaires worden geïmplementeerd middels een VDEX-XML. Dit is een door het IMS vastgelegd formaat. Er zijn diverse soorten VDEX-structuren. Voor deze afspraak zijn de volgende van belang:

    • Een “platte” lijst met termen. Deze wordt aangeduid met het attribuut profileType="flatTokenTerms" op het root element.
    • Een hiërarchische lijst met termen. Deze wordt aangeduid met het attribuut profileType="hierarchicalTokenTerms" op het root element. Een dergelijke hiërarchische lijst is in het kader van deze afspraak bijvoorbeeld nuttig bij toetsen en de daar onderliggende toetsonderdelen.
  6. Structuur voor foutafhandeling SOAP-verkeer

    Protocol
    Alles-in-één-overdracht
    Getrapte overdracht

    Het LAS wordt geacht de verschillende foutsituaties zoals in de toelichting beschreven te onderscheiden en de juiste foutcode te retourneren.

    Binnen deze afspraak wordt het <faultcode>-element gebruikt om de soort fout met behulp van een code aan te duiden (volgens de extensie zoals vastgelegd in SOAP 1.1). In het <faultstring>-element moet een zo duidelijk mogelijke tekstuele foutboodschap worden geplaatst met meer details over de opgetreden fout. De exacte invulling hiervan wordt aan het LAS overgelaten. Andere SOAP-foutberichtelementen (zoals het <details>-element) mogen optioneel gebruikt worden voor het doorgeven van aanvullende informatie.