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

De webservice GeefFuncties 2.0 stelt de gebruiker in staat de functies van een bepaalde natuurlijk persoon of rechtspersoon (functiehouder) in één of meerdere ondernemingen op te vragen, of om alle functiehouders van een bepaald onderneming op te vragen. 

Situering

Deze dienst kadert binnen het domein Onderneming van het MAGDA platform.

Verwante diensten

• /wiki/spaces/MDI/pages/1201343115

• /wiki/spaces/MDI/pages/174030851

Gegevensbronnen

De gegevens die door deze webservice beschikbaar gesteld worden worden aangeboden door VIP-VKBO. De oorspronkelijke leveranctier is KBO.

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:

• Toelating tot de dienst GeefFuncties 02.00

• Machtiging van het sectoraal comité van het Rijksregister

Batch

Is deze dienst in batchvorm beschikbaar? Zo ja, laat deze paragraaf staan met generieke informatie over batchdiensten en voeg eventueel relevante dienstspecifieke informatie toe.

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

Als vraag wordt doorgestuurd:

• het INSZ van de natuurlijk persoon als functiehouder, met eventueel een ondernemingsnummer waarbinnen de functies worden uitgeoefend

of

• het ondernemingsnummer van de rechtspersoon als functiehouder, met eventueel het ondernemingsnummer waarbinnen de functies worden uitgeoefend

of

• het ondernemingsnummer waarvan de functiehouders worden opgevraagd

• een of meerdere functiecodes

Eventueel kan de gebruiker een optioneel element meesturen met daarin een specifieke functiecode (of meerdere functiecodes) en een specifieke onderneming waarbinnen de functies door de gevraagde functiehouder (natuurlijk- of rechtspersoon) worden uitgeoefend. 

Antwoord

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

Afhankelijk van de vraagstellen verkrijgt de gebruiker als antwoord

• een lijst met de functies die de gevraagde natuurlijk- of rechtspersoon uitoefent in één of meerdere ondernemingen, of in de gevraagde onderneming

of

• een lijst met de functiehouders die een functie uitoefenen binnen een opgegeven onderneming

Werking

Opties

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

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

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. 
Hierna vindt er een functionele validatie plaats van de vraag. Nadien zal de webservice het antwoord op de vraag opbouwen. Het antwoord wordt nogmaals gevalideerd waarna het aan de afnemer ter beschikking gesteld wordt.

Responsetijden & Beschikbaarheid

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

De webservice op het MAGDA platform is 24 uur op 24 en 7 dagen op 7 beschikbaar. Deze webservice is niet afhankelijk van externe bronnen zoals Rijksregister, KSZ, … . 
Bij geplande onbeschikbaarheden worden de afnemers op de hoogte gebracht.

Logging

De opvragingen die gebeuren via deze webservice worden bewaard zoals beschreven op de pagina "MAGDA logging".