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 webservice ZoekOnderneming-02.00 laat de gebruiker toe rechtstreeks bij KBO ondernemingen en vestigingen op te zoeken op basis van naam of adres.

Situering

Geef een kadering voor deze dienst. Past deze bijvoorbeeld binnen een bepaald project? Welke datastromen zijn onderliggend aanwezig? Uitgebreide beschrijving over verwante diensten hoort hier eveneens thuis.

Verwante diensten

• GeefOnderneming 2.0 : voor het ophalen van de gegevens van ondernemingen en vestigingseenheden bij KBO, dit op basis van het ondernemingsnummer of vestigingseenheidnummer.

• /wiki/spaces/MDI/pages/903938785

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.

De gegevens zijn afkomsting uit de federale “Kruispuntbank voor ondernemingen” (KBO), d.i. de centrale Belgische Bedrijvendatabank waar de Belgische economische actoren (Rechtspersonen, Werkgevers,

Handelaars, BTW-plichtigen…) eenmalig worden geregistreerd. KBO wordt gehost door FOD Economie

(Federale Overheidsdienst Economie, K.M.O., Middenstand en Energie).

Om de gegevens bij KBO op te halen wordt gebruik gemaakt van de KBO Consult webservice release 29.

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 het gebruik van de webservice ZoekOnderneming 2.0

Batch

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

Functionaliteiten

De webservice ZoekOnderneming 2.0 laat de afnemer van het MAGDA platform om op basis van verschillende criteria ondernemingen en vestigingseenheden op te zoeken bij KBO.

Vraag

Voor meer informatie in verband met de mogelijke criteria in de vraagstelling, raadpleeg de pagina "Beschrijving Vraag".

Antwoord

Concreet worden deze elementen teruggeven in het antwoord:

• Het ondernemingsnummer

• Aanduiding onderneming of vestiging

• Het soort onderneming

• De status van de onderneming

• De maatschappelijke naam in één taal

• Het maatschappelijk adres

• De rechtsvorm

Werking

Aandachtspunten

• Naar aanleiding van KBO Release 29 eind november 2015 is beslist om de ZoekOnderneming 2.0 aan te passen zodanig deze compatibel wordt met de KBO webservice release 29. Zie de pagina "Verschillen tegenover vorige versie" voor meer informatie hierover.

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

Van zodra de vraag gesteld is wordt er een XSD-validatie uitgevoerd. Is de ontvangen vraag 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.

Bij succesvolle xsd validatie en andere controles wordt de vraag omgezet naar en KBO-xml en wordt de vraag uiteindelijk aan KBO voorgelegd. KBO voert de nodige validaties en autorisaties uit. Indien bij KBO hier een fout optreedt wordt de verwerking stop gezet en verkrijgt de afnemer een foutmelding.

Zijn de autorisatie en andere validatieslangs de kant van KBO  succesvol, dan verkrijgt MAGDA de gegevens van KBO, zet deze om in een antwoord xml en geeft ze door aan de afnemer.

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.

De webservice op het MAGDA platform is 24 uur op 24 en 7 dagen op 7 beschikbaar.

Logging

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