Doel: Met dit sjabloon kan u eenvoudig een nieuwe diensthandleiding aanmaken in Confluence. Gebruik de onderstaande knoppen om nieuwe componenten binnen de handleiding aan te maken. To do: - Vul de onderstaande handleidingsparagrafen in - Maak o.b.v. de specificaties van de dienst relevante subpagina's aan - Verwijder lege of niet-gebruikte paragrafen & pagina's - Let op: Gebruik de volledige naam van de dienst (Domein.DienstNaam-Versie).

De Excerpt bevat de tekst die wordt weergegeven in de overzichtspagina op domein niveau. De tekst die in dit kader staat wordt niet weergegeven in de handleiding zelf (deze pagina) en dient een korte omschrijving van de dienst te bevatten.

Situering

Dit document beschrijft het gebruik en de werking van de webservice ZoekParticipaties 2.0 zoals deze door O&V aangeboden wordt.

De dienst in dit document beschreven zal de gemachtigde afnemer van het MAGDA platform in staat stellen om gegevens op te zoeken met betrekking tot de participatie van een persoon in het onderwijs gedurende een opgegeven periode.
Het betreft een lijst van reële participaties, dus geen zaken die geannuleerd zijn of gegevens die nadien nog gecorrigeerd geweest zijn.

De gegevens die door deze webservice beschikbaar gesteld zullen worden zijn afkomstig van Onderwijs en vorming.

Deze dienst gaat via een Magda Gateway rechtstreeks naar O&V, dit zonder verdere Magda businessdienst. De service bij O&V is een dienst die voldoet aan de Magda standaarden.

De Gateway zal de service van O&V ontsluiten, authenticatie en autorisatie mogelijk maken, inschrijvingscontrole uitvoeren, filtering, logging, … .

Verwante diensten

/wiki/spaces/MP/pages/600506958 en RegistreerUitschrijving 02.00 :

Om deze webservice te kunnen gebruiken moet er eerst een inschrijving in het MAGDA inschrijvingsrepertorium voor personen aangemaakt worden. Deze inschrijvingen kunnen toegevoegd worden via de webservice RegistreerInschrijving 02.00.

Voor het verwijderen van een inschrijving kan de RegistreerUitschrijving 02.00 webservice gebruikt worden.

De informatie met betrekking tot deze webservices is terug te vinden op de sharepoint omgeving.

Gegevensbronnen

Het Agentschap voor Onderwijsdiensten (AgODi) verzamelt gegevens van uit het Vlaamse onderwijsnet. De scholen werken met een leerlingenadministratiepakket, waarin zij de gegevens van hun leerlingen bijhouden. Onderwijs voorziet hierbij een interface waarmee participatieinformatie automatisch wordt doorgestuurd vanuit de leerlingenadministratiepakketten.

In een eerste fase kunnen echter enkel participatiegegevens uit het volwasseneneonderwijs bevraagd worden.

In een latere fase zullen via deze webservice ook participatiegegevens van leerplichtonderwijs en hoger onderwijs ontsloten worden.

Meer informatie over hoe deze bronnen gebruikt worden in de opbouw van het antwoord vindt u onder Opvraging.

Gebruiksvoorwaarden

Afnemers moeten aan volgende voorwaarden voldoen om deze dienst te mogen gebruiken:

• Toelating tot de webservice ZoekParticipaties 02.01

• Toelating tot het MAGDA platform

• Machtiging van het VTC (Vlaamse Toezichts Commissie)

Batch

Geef de volledige structuur op van de naam van de bestanden die klaar gezet worden voor de gebruiker. Prefixen zijn steeds in de form [domein].[ServiceNaam]-[Versie]_[timestamp].xml. Pas zeker de bestandsnamen aan in onderstaand voorbeeld als je het hergebruikt. Gebruik geen punt in de versie. Zet de vier cijfers van de versie achter mekaar. Gebruik Camel-case! De lengte van het deel voor de _timestamp mag maximaal 48 karakters lang zijn.

Deze webservice is eveneens beschikbaar in een batch-variant (enkel XML). Voor meer informatie: Webservice In Batch bevragen.

Functionaliteiten

De webservice ZoekParticipaties 02.01 laat een afnemer toe om participaties in een gespecifieerde zoekperiode of vanaf een bepaalde datum op te vragen bij O&V. Dit gebeurt op basis van het INSZ van deze persoon en eventuele specifieke criteria m.b.t. het soort onderwijs (voorlopig zijn enkel selectiecriteria voorzien met betrekking tot volwassenenonderwijs, maar later worden deze mogelijk aan gevuld met leerplichtonderwijs en/of hoger onderwijs)

Als antwoord geeft de webservice een lijst van participaties terug die voldoen aan de opgegeven zoekcriteria

Deze webservice volgt volledig de MAGDA 2.0 standaarden.

Werking

Opvraging

Van zodra de vraag gesteld is wordt er een XSD-validatie uitgevoerd. Is de ontvangen vraag XML niet geldig tegenover het schema, dan stopt de verwerking en wordt een foutmelding aangemaakt, anders gaat de verwerking verder. Na de XSD-validatie vinden de nodige authenticatie- en autorisatiecontroles plaats.

De vraag wordt dan doorgestuurd naar de webservice van O&V waar naar de gevraagde gegevens gezocht wordt.

Worden er geen gegevens gevonden verkrijgt men een gepaste foutmelding (30001 – Geen gegevens gevonden).

Het antwoord wordt nogmaals gevalideerd waarna het aan de afnemer ter beschikking gesteld wordt. Afhankelijk van de machtigingen worden er al dan niet gegevens uit het antwoord gefilterd.

Responsetijden & Beschikbaarheid

De webservice op het MAGDA platform is 24 uur op 24 en 7 dagen op 7 beschikbaar. Deze webservice is afhankelijk van O&V als bron .

Bij geplande onbeschikbaarheden worden de afnemers op de hoogte gebracht.

Logging

De opvragingen die gebeuren via deze webserive worden bewaard zoals beschreven in het document “MAGDA logging”.

Ondersteunde talen

De afnemer verwacht vanuit een MAGDA-dienst een Nederlanstalig antwoord. Wanneer een antwoord mogelijk anderstalige informatie bevat is het relevant om dit hier mee te geven.

MAGDA ondersteunt de Nederlandse taal.

Indien in de brongegevens de Nederlandse tekst niet beschikbaar is voor een bepaald element zal de eerste vertaling van de tekst in de brongegevens gebruikt worden, onafhankelijk van de taal waarin dit gegeven beschikbaar is.