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

Deze dienst maakt deel uit van een set LED diensten die via het MAGDA platform beschikbaar zijn. Het betreft hier een pure MAGDA Gateway op een bij LED beschikbare MAGDA 2.0 compliant businessdienst.

Het doel van het LED project is het bouwen van een authentieke gegevensdatabank met informatie over leer- en ervaringsbewijzen. Deze databank zal gevoed kunnen worden door (al dan niet) authentieke bronnen die op de centrale databank zijn aangesloten en kunnen worden bevraagd door gemachtigde belanghebbenden. De nood aan een dergelijke databank kwam onder meer naar boven in het beleidsdomein O&V in het kader van de financiering van het leerplichtonderwijs.

Verwante diensten

RegistreerBewijs

Dienst enkel beschikbaar voor de instanties die een LED bewijs uitreiken. Deze dienst laat deze instanties toe een bewijs te registreren in de LED.

AnnuleerBewijs

Dienst enkel beschikbaar voor de instanties die een LED bewijs uitreiken. Deze dienst laat deze instanties toe een bewijs te annuleren in de LED.

RegistreerMutatieBewijs

Dienst enkel beschikbaar voor de LED zelf. Deze dienst laat LED toe een gemuteerd LED bewijs te registreren op het MAGDA platform voor verder verdeling naar de gemachtigde afnemers.

Gegevensbronnen

Van waar komen de gegevens in deze dienst? NOOT: Verwijder indien er geen externe gegevensbronnen zijn of deze mededeling niet relevant is onderstaande informatiebel.  Maak een koppeling op het woord Opvraging naar het anker lager op de pagina (#opvraging). Deze koppeling kan niet aangemaakt worden in de template.

De gegevens worden opgevraagd/opgeslagen bij volgende (authentieke) gegevensbron(nen):

• LED – Leer- en Ervaringsdatabank

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

Gebruiksvoorwaarden

Heeft de afnemer speciale toelatingen / machtigingen nodig voor consumeren van deze dienst?

Om gebruik te kunnen maken van deze dienst dient men een machtiging te hebben die toegang geeft tot deze gegevens en een aansluitingsprocedure te doorlopen.

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

Ruimte voor een korte beschrijving van de functionaliteiten van deze dienst voor zover die relevant zijn?

Vraag

Het INSZ van de persoon waarvoor de bewijzen worden opgevraagd. Dit moet het actuele INSZ zijn. Indien dit niet het geval is dan zal de vraag niet succesvol zijn.

Antwoord

Welke gegevens geeft de bron effectief terug? Wat als er geen antwoord is? Wat als er iets misgaat?

De inhoud van het antwoord van de dienst bestaat uit

• Eén of meerdere bewijzen in geval van een succesvolle vraag

• Eén of meerdere uitzonderingen (bijvoorbeeld als er geen bewijzen werden gevonden)

• Combinatie van bewijzen en uitzonderingen. (Bijvoorbeeld bij batch-verwerking waar een aantal bewijzen worden verkregen, maar voor een andere vraag geen inschrijving aanwezig is)

Werking

Externe documentatie: Taxonomie

Vanuit LED werd een taxonomiedocument ter beschikking gesteld. Dit document is beschikbaar op de MAGDA Gebruikersomgeving op deze pagina.

De beschrijving van de taxonomie is gebaseerd op afspraken en overeenkomsten gemaakt door de werkgroep taxonomie en bekrachtigd in de stuurgroep van 30 juni 2009.

De taxonomie is opgedeeld in dimensies en mogelijke waarden binnen deze dimensies. Zij omvat een aantal dimensies waarvoor reeds een aantal waarden zijn vastgelegd waarbij volgende regels in acht werden genomen:

• Binnen één dimensie vindt men eenzelfde “soort van informatie” terug

• Duidelijke omschrijving voor elke opgenomen dimensie

• (Eenzelfde term kan uitzonderlijk in 2 dimensies voorkomen)

• Toegelaten combinaties binnen 2 of meer dimensies: De taxonomie beschrijft welke regels (mogelijke combinaties van waarden) er toegelaten zijn

• Afleidbare gegevens en afleidingsregels

Aandachtspunten

Waar moet de afnemer specifiek aandacht aan spenderen? Zijn er eerst andere handelingen vereist alvorens via deze dienst een gepast antwoord te verkrijgen?

Geen aandachtspunten.

Opties

Volgende configuratieparameters kunnen ingesteld worden in functie van de machtigingen en de wensen van de afnemer:

Zijn er specifieke parameters die ingesteld kunnen worden?

• Configuratieparameters op het MAGDA platform zijn voor deze dienst niet van toepassing

Opvraging

Hoe bouwt deze dienst haar antwoord op?

De opvraag moet gebeuren op basis van het actuele INSZ van de persoon.

Na de nodige autorisatie- en XSD-validaties wordt het bericht verstuurd naar de achterliggende LED-service.

De van LED ontvangen gegevens worden gevalideerd tegenover de XSD en ter beschikking gesteld van de afnemer.

Voor een actuele lijst met leveranciers, welke kwalificatiebewijzen binnen LED bewaard worden, en andere inhoudelijke informatie wordt verwezen naar de website van LED: http://www.leerenervaringsbewijzendatabank.be

Responsetijden & Beschikbaarheid

Welke responstijden worden voor deze dienst als "normaal" beschouwd? Hoe zit het met beschikbaarheid voor deze dienst? Verwijder de algemene informatiebel hieronder indien deze niet relevant zou zijn.

Logging

De opvragingen die gebeuren via deze webservice worden bewaard zoals beschreven op de pagina "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.