Uitwisseling Leerlinggegevens en Resultaten versie 2.2.1

Over deze viewer

Basisstructuur van de afspraak

De afspraak UWLR kent vier hoofdonderdelen:

scenario's
Een scenario is een uitwisselingsmoment waarover in deze documentatie afspraken zijn gemaakt.
protocollen
In een scenario staat beschreven welke protocollen gelden voor de berichtenuitwisseling.
berichten
In elk protocol worden één of meerdere berichten verstuurd tussen de systemen en wordt bepaald welke dat zijn.
profielen
Op een bericht kan een profiel van toepassing zijn dat aangeeft welke velden in een bericht ingevuld mogen of moeten zijn bij de uitwisseling in een bepaald scenario.

Andere onderdelen in de afspraak

Naast de vier hoofdonderdelen bevat de afspraak ook over andere onderdelen voorschriften en informatie:

systemen
De systemen die door UWLR worden getypeerd en waartussen de berichtenuitwisseling plaatsvindt.
bestanden
De bestanden zijn de basis, de inhoud, voor de berichten. De berichten vormen de structuur inclusief de inhoud die uiteindelijk volgens een protocol worden uitgewisseld. Bestanden zijn terug te vinden onder het menu 'berichten'.
webservices
Dit zijn de WSDL's die systemen in staat stellen om berichten te ontvangen en te versturen. De protocollen bepalen welke webservices voorgeschreven worden om de uitwisseling volgens dat protocol mogelijk te maken.
vocabulaires
De afspraak maakt het gebruik van vocabulaires mogelijk. Deze worden dan gekoppeld aan een specifiek veld in een bericht. De inhoud van zo'n veld moet overeenkomen met een waarde in de vocabulaire. Per scenario wordt vastgesteld of en welke vocabulaires gelden.
standaarden
UWLR maakt gebruik van verschillende standaarden of verwijst naar andere standaarden die geadviseerd of noodzakelijk zijn om goed te kunnen uitwisselen. Waar dit van toepassing is, zal die standaard daar genoemd worden.

Navigeren door de documentatie

De hoofdroute is om via de beschikbare scenario's te zien welke protocollen er worden voorgeschreven en welke randvoorwaarden er gelden evenals de van toepassing zijnde profielen. Per protocol zijn de berichten bepaald en elk bericht geeft de structuur en elementen weer volgens het geldende profiel.

Via het menu zijn direct overzichten te vinden van de protocollen, berichten en profielen die door de afspraak worden gedefinieerd. In het overzicht van systemen zijn de ict-systemen te vinden waarvoor de UWLR-afspraak uitwisselingen standaardiseert. Per systeem staan vervolgens de protocol-onderdelen weergegeven die uitgevoerd moeten worden en de voorwaarden die gelden.

De andere onderdelen in de afspraak zijn als volgt terug te vinden: De bestanden zijn te vinden onder 'berichten' in het menu. Webservices maken onderdeel uit van de protocollen en zijn daar te vinden. Geldende vocabulaires worden genoemd bij het betreffende scenario. Daar waar gebruik wordt gemaakt van andere standaarden, wordt het op die plaats weergegeven.