Functionele Dataservice Beschrijving

Functionele Dataservice Beschrijving

onderwerp

datum

Dataservice Contactgegevens

20-04-2016 versie

2.5

Versiebeheer

Versie

Datum

Opmerking



2.5

20-04-2016

1.2

9-1-2015

Het afgeleide gegeven in de Persoon /uitgebreideRechtsvorm is aangepast voor de gevallen dat het een BuitenlandseRechtspersoon / Vennootschap is. De /uitgebreideRechtsvorm wordt gevuld met de BuitenlandsevennootschapGegevens.omschrijvingRechtsvorm +"(<BuitenlandsevennootschapGegevens.land van vestiging>)", indien van toepassing aangevuld met "; volgens opgave een formeel buitenlandse vennootschap"  Als een adres was afgeschermd, bij opgave via de Indicatie Afgeschermd ("bezoeklocatie", "woonadres" etc.), dan werd er in de Dataservices helemaal niets getoond. Dit is niet conform specificaties en is nu aangepast. De dataservice toont nu het kopje van het object ("bezoeklocatie", "woonadres" etc.) en de Indicator “Afgeschermd”.  Bij de Eigenaar Persoon worden velden geleverd die nog niet of niet juist in de documentatie stonden vermeld: o Bij de Persoon is de datumAanvang toegevoegd o Bij alle Bezoek- en Post adressen is de omschrijving 'adres' vervangen door 'locatie' o het Communicatiegegeven bij de Eigenaar wordt alleen getoond als er GEEN Vestigingen zijn  Bij de Onderneming is de datumAanvang in de documentatie toegevoegd  Bij de Vestiging worden velden geleverd die nog niet of niet juist in de documentatie stonden vermeld: o Bij de Vestiging is de datumAanvang toegevoegd o Bij het Bezoekadres en Postadres is de omschrijving 'adres' vervangen door 'locatie' datumAanvang en datumEinde toegevoegd in MaatschappelijkeActiviteit

1.1

9-9-2014

Dataservice Contactgegevens inclusief Berichten Box

1.0

4-12-2013

Initiële versie op basis van Gegevenscatalogus 2.3

Pagina 1 van 12

Kamer van Koophandel

Inhoudsopgave

1 Product Dataservice Contactgegevens (incl. BBox) ............................................................................................... 3 1.1 Kenmerken.......................................................................................................................................................... 3 1.2 Referenties.......................................................................................................................................................... 3 2 Dataservice Contactgegevens ................................................................................................................................ 4 2.1 Contactgegevens Request .................................................................................................................................. 4 2.1.1 HeaderRequest................................................................................................................................................ 5 2.2 Contactgegevens Response ............................................................................................................................... 5 2.2.1 HeaderResponse............................................................................................................................................. 5 3 Inhoud Contactgegevens ........................................................................................................................................ 6 3.1 Maatschappelijke Activiteit .................................................................................................................................. 7 3.2 Eigenaar.............................................................................................................................................................. 8 3.3 Onderneming ...................................................................................................................................................... 9 3.4 Vestiging ........................................................................................................................................................... 10 4 Meldingen ............................................................................................................................................................. 11

Pagina 2 van 12


1

Product Dataservice Contactgegevens (incl. BBox) Dit document geeft een functionele beschrijving van de service voor het opvragen van een product via het kanaal Handelsregister gegevenslevering, ook wel Dataservice genoemd. Het beschrijft met welke gegevens de dataservice wordt aangeroepen en welke gegevens er worden geretourneerd. Dit document is bedoeld voor de informatie analist, (software) architect, -ontwikkelaar en tester. Het opvragen van een product bestaat uit een bevraging (request) en een antwoord (response). De afnemer geeft in het request het type product aan dat gewenst wordt. Op basis van een productsleutel geeft de afnemer aan van welk 'onderwerp' hij het product geleverd wil hebben. Dit document beschrijft het opvragen van: Type product: Dataservice Contactgegevens Productsleutel: KvK nummer N.B.: Op dit moment kan het product alleen worden opgevraagd met een KvK-nummer. In een volgende versie wordt het mogelijk om dit product op te vragen op basis van RSI-nummer, vestigingsnummer of BSN. Opvragen op BSN geldt alleen voor die klanten die door de KvK hiertoe geautoriseerd zijn. In hoofdstuk 2 wordt schematisch weergegeven waaruit het request en reponse bericht bestaat. In hoofdstuk 3 wordt schematisch weergegeven welke gegevens uit het handelsregister met dit product worden geleverd. Tot slot worden in hoofdstuk 4 de mogelijke meldingen weergegeven.

1.1

1.2

Kenmerken

Kenmerk

Opmerking

Opdrachtgever Project

V&M Handelsregister Gegevenslevering Dataservices

Referenties

Referentie

Beschrijving

Gegevenscatalogus v2.5

Beschrijving van de handelsregister gegevens die met KvK producten/diensten worden geleverd. De technische vertaling van de gegevenscatalogus in XML.

Gegevenscatalogus v2.5 XSD

Pagina 3 van 12


2

Dataservice Contactgegevens

Dit hoofdstuk geeft schematisch weer waaruit het request en response bericht bestaat. Een bevraging (request) voor een product heeft als resultaat een antwoord (response). Dit antwoord bestaat uit meldingen en de inhoud (gegevens uit het handelsregister). De meldingen kunnen waarschuwingen, informatie en/of foutmeldingen bevatten. Indien de bevraging (request) juist is en het product kan geproduceerd worden, dan bevat het response bericht het bestelde product, de inhoud. Van elk object met een formele historie wordt het registratietijdstip meegeleverd. In de Gegevenscatalogus staat aangeven bij welke objecten en gegevensgroepen een formele historie wordt geregistreerd. De inhoud is gemodelleerd volgens de Gegevenscatalogus. Voor een beschrijving van deze objecten, gegevensgroepen, enzovoort, wordt daarom verwezen naar de Gegevenscatalogus (zie hoofdstuk Referenties).

Name: Package: Version: Author:

Dataservice Contactgegevens Dataservice Contactgegevens (incl. BBox) 2.5 Kamer van Koophandel

HeaderRequest

HeaderResponse

«interface» Contactgegev ens Request + +

«interface» Contactgegev ens Response

productnaam: TypeProduct = DSCNTG productversie: string [0..1]

«resulteert in»

+

+fout 0..* +waarschuwing 0..*

peilmoment: Tijdstip

::HeaderRequest - klantreferentie: Tekst50 [0..1]

MeldingType -

code: string omschrijving: string referentie: string [0..1]

+informatie 0..*

«productSleutel» + kvkNummer: Numeriek8 A

A

+inhoud

0..1

Inhoud Contactgegev ens Response

2.1

Contactgegevens Request

Dit hoofdstuk beschrijft de parameters van het request.

Naam

Type

kvkNummer

Numeriek8

productnaam

TypeProduct

productversie

string

Pagina 4 van 12

Waarde

Toelichting

Het Kamer van Koophandel nummer (KvKNummer). Het door de kamer toegekende unieke nummer voor de {{MaatschappelijkeActiviteit}}. DSCNTG

De naam van het product. De afnemer geeft hiermee aan welk product zij wil bevragen. De versie van het product. Van producten kunnen meerdere versies bestaan. De afnemer geeft aan welke versie van het product gewenst wordt. Wanneer de versie niet wordt opgegeven, dan wordt de laatste versie van het product geleverd.


2.1.1

HeaderRequest

Dit hoofdstuk geeft een overzicht van de attributen van de header van het request bericht.

2.2

Naam

Type

klantreferentie

Char

Waarde

Beschrijving

Een door de afnemer vrij in te vullen referentie. Deze referentie verschijnt (eventueel) op de factuur. De KvK gebruikt dit gegeven verder niet.

Contactgegevens Response

Dit hoofdstuk beschrijft de parameters van het response.

2.2.1

Naam

Type

peilmoment

Tijdstip

Waarde

Toelichting

Het peilmoment geeft de datum aan waarop voor het laatst registraties in het Handelsregister zijn vewerkt. De in het product opgenomen gegevens stonden op dit peilmoment als zodanig in het Handelsregister.

HeaderResponse

Dit hoofdstuk geeft een overzicht van de attributen van de header van het response bericht.

Naam

Type

fout

MeldingType

waarschuwing

MeldingType

informatie

MeldingType

Pagina 5 van 12

Waarde

Beschrijving

De fout die is opgetreden gedurende het verwerken van de vraag. Een waarschuwing die betrekking heeft op het geleverde product Een informatieve melding die betrekking heeft op het geleverde product


3

Inhoud Contactgegevens Onderstaand diagram toont de structuur en verband van de gegevens die worden geleverd bij het opvragen van het product. De inhoud van het product wordt beschreven door te starten met een UML (Unified Modelling Language) raamwerk, waarmee de gehele inhoud van het product in een overzicht wordt gepresenteerd. Daarna worden de verschillende onderdelen van het product in meer detail beschreven door één op één gebruik te maken van het onderliggende HRInformatiemodel (gegevenscatalogus). Dit betekent dat de onderliggende klassediagrammen niet speciaal voor dit product zijn gemodelleerd, maar dat er hergebruik wordt gemaakt van de bestaande klassediagrammen van de Gegevenscatalogus. Zo wordt de consistentie met het onderliggende HR-Informatiemodel gewaarborgd over de producten heen. Het vet gedrukte element in het schema is het start punt (root element) van het product.


Inhoud Contactgegevens Response Inhoud Contactgegevens 2.5 Kamer van Koophandel

Eigenaar

+Persoon 1 heeft als eigenaar +MaatschappeljikeActiviteit 0..1 Maatschappelij ke Activ iteit

Onderneming Manifesteert zich als 1 +MaatschappelijkeActiviteit

0..1 +Onderneming 1 +Onderneming

1 +MaatschappelijkeActiviteit wordt uitgeoefend in +NietCommercieleVestiging 0..* Vestiging wordt uitgeoefend in 0..* +CommercieleVestiging

Pagina 6 van 12


3.1

Maatschappelijke Activiteit

Onderstaand diagram toont de gegevens en de samenhang van gegevens van de Maatschappelijke activiteit.


Maatschappelijke Activiteit Maatschappelijke Activiteit 2.5 Kamer van Koophandel «objecttype» Maatschappelij keActiv iteit

-

«authentiek» datumAanvang: DatumIncompleet datumEinde: DatumIncompleet [0..1]

-

«Identificatie, authentiek, trigger» kvkNummer: Numeriek8

-

«afleiding» /naam: Tekst500

-

«niet authentiek» nonMailing: Indicatie

heeft een 0..1 «gegevensgroep» Berichtenboxadres

-

Pagina 7 van 12

«authentiek» Berichtenboxadres: Tekst45


3.2

Eigenaar

Onderstaand diagram toont de gegevens en de samenhang van gegevens van de Eigenaar van de maatschappelijke Activiteit.


«objecttype» Persoon

Eigenaar Eigenaar 2.5 Kamer van Koophandel

-

«afleiding» /uitgebreideRechtsvorm: Tekst500 /vol ledigeNaam: Tekst500

«objecttype» Natuurlij kPersoon

-

«authentiek» geboortedatum: DatumIncompleet

«Identifi catie, authentiek, trigger» - natuurlijkPersoonId: NatuurlijkPersoonId

«objecttype» NaamPersoon -

«objecttype» NietNatuurlij kPersoon

naam: Tekst500 [0..1]

+Contains

-

«authentiek» datumAanvang: DatumIncompleet

-

«Identificatie, authentiek, trigger» rsin: Numeriek9

«objecttype» BuitenlandseVennootschap

«objecttype» BinnenlandseNietNatuurlij kPersoon

heeft woonadres «objecttype» Rechtspersoon

1

0..1

«gegevensgroep» Locatie-Natuurlij kPersoon

«gegevensgroep» Locatie-NaamPersoon

+Bezoeklocatie 0..1

+Postlocatie 0..1

+Postlocatie 0..1

+Bezoeklocatie 0..1

«gegevensgroep» Locatie-BuitenlandseNNP

«gegevensgroep» Locatie-Rechtspersoon

«gegevensgroep» Locatie

-

«gegevensgroep» Communicatiegegev enRechtspersoon

«niet authentiek» afgeschermd: Indicatie toevoegingAdres: Tekst100 [0..1]

0..1

«afleiding» - /volledigAdres: Tekst500 0..*

0..*

«gegevensgroep» Nummer

Tot en met

Van 0..1

0..1 -

«gegevensgroep» Adres

communicatieNummer: Alfanumeriek15 soortCommunicatieNummer: SoortCommunicatieNummer toegangscode: Tekst10 0..* «gegevensgroep» EmailAdres

«gegevensgroep» BuitenlandsAdres

«gegevensgroep» BinnenlandsAdres -

huisletter: Letter [0..1] huisnummer: Numeriek5 [0..1] huisnummerToevoeging: Tekst5 [0..1] plaats: Tekst80 postbusnummer: Numeriek5 [0..1] postcode: Postcode straatnaam: Tekst80 [0..1]

-

land: Tekst40 postcodeWoonplaats: Tekst200 regio: Tekst150 [0..1] straatHuisnummer: Tekst200

adres: Tekst200

0..*

«gegevensgroep» Domeinnaam -

naam: Tekst300

0..*

«gegevensgroep» Communicatiegegev en

0..1 «gegevensgroep» BAGIdentificatie

-

«authentiek» identi ficatieAdresseerbaarObject: Tekst16 [0..1] identi ficatieNummeraanduidi ng: Tekst16 [0..1]

Pagina 8 van 12


3.3

Onderneming

Onderstaand diagram toont de gegevens en de samenhang van gegevens van de onderneming.


Onderneming Onderneming 2.5 Kamer van Koophandel

«objecttype» Onderneming

-

Pagina 9 van 12

«authentiek» datumAanvang: DatumIncompleet


3.4

Vestiging

Onderstaand diagram toont de gegevens en de samenhang van gegevens van de vestiging van de maatschappelijke activiteit. Name: Package: Version: Author:

Vestiging Vestiging 2.5 Kamer van Koophandel

+Bezoeklocatie 1 (authentiek)

«gegevensgroep» Locatie-Vestiging

+Postlocatie 1 (authentiek)

«objecttype» Vestiging

«objecttype» NietCommercieleVestiging

«authentiek» - datumAanvang: DatumIncompleet -

«afleiding» /eersteHandelsnaam: Tekst500

«objecttype» CommercieleVestiging

«Identificatie, authentiek, trigger» - vestigingsnummer: Numeriek12 «gegevensgroep» Locatie

0..1

«niet authentiek» - afgeschermd: Indicatie - toevoegingAdres: Tekst100 [0..1] -

«gegevensgroep» Communicatiegegev en-Vestiging

«afleiding» /volledigAdres: Tekst500 0..*

«gegevensgroep» Communicatiegegev en

0..*

Van

Tot en met

0..1

0..1

0..*

«gegevensgroep» Adres

«gegevensgroep» EmailAdres -

«gegevensgroep» BinnenlandsAdres -

huisletter: Letter [0..1] huisnummer: Numeriek5 [0..1] huisnummerToevoeging: Tekst5 [0..1] plaats: Tekst80 postbusnummer: Numeriek5 [0..1] postcode: Postcode straatnaam: Tekst80 [0..1]

«gegevensgroep» BuitenlandsAdres -

adres: Tekst200

«gegevensgroep» Domeinnaam -

land: Tekst40 postcodeWoonplaats: Tekst200 regio: Tekst150 [0..1] straatHuisnummer: Tekst200

naam: Tekst300

0..*

0..* «gegevensgroep» Nummer -

communicatieNummer: Alfanumeriek15 soortCommunicatieNummer: SoortCommunicatieNummer toegangscode: Tekst10

0..1 «gegevensgroep» BAGIdentificatie

-

«authentiek» identificatieAdresseerbaarObject: Tekst16 [0..1] identificatieNummeraanduiding: Tekst16 [0..1]

Pagina 10 van 12


4

Meldingen In dit hoofdstuk staan de mogelijke meldingen beschreven die met het opvragen van dit product/dienst kunnen optreden. Een melding kan als fout, waarschuwing of als aanvullende informatie dienen. Afhankelijk van de context wordt dit bepaald. Het is aan de afnemer om de consequentie van de melding in zijn informatievoorziening te verwerken. Name: Package: Version: Author:

Meldingen Meldingen 2.5 Kamer van Koophandel

IPD0000 Het product is succesv ol geproduceerd

IPD1000 Eén of meerdere inschrij v ingen (Kv Knummers) zij n niet beschikbaar. Het product kan niet w orden samengesteld.

IPD0001 Het gev raagde artikel <productNaam> bestaat niet.

IPD1002 De gegev ens zij n tij delij k niet lev erbaar omdat deze in behandeling zij n. Probeer het later nog eens.

IPD0002 De gev raagde v ersie v an het product <productNaam> bestaat niet. IPD0003 Het klantnummer is onbekend.

IPD0004 Het Kv K nummer is niet v alide

IPD0005 Op basis v an het Kv K-nummer kan het product niet w orden gelev erd.

IPD1005 De gegev ens v an deze opv raging zij n niet lev erbaar in de door u gebruikte v ersie. Voor informatie ov er nieuw e v ersie(s) kunt u contact opnemen met uw AccountManager.

IPD9998 Algemene inv oer parameter fout

IPD9999 Algemene technische fout

IPD0006 Het v estigingsnummer is niet v alide. IPD0007 Op basis v an het v estigingsnummer kan het product niet w orden gelev erd. IPD0008 Het burgerserv icenummer is niet v alide IPD0009 Op basis v an het burgerserv icenummer kan het product niet w orden gelev erd. IPD0010 Het RSI-nummer is niet v alide

IPD0011 Op basis v an het RSI-nummer kan het product niet w orden gelev erd.

Code & Omschrijving

Type melding

Beschrijving

IPD0000 Het product is succesvol geproduceerd

Informatie

Gedurende het produceren (gegevens verzamelen, opmaken en verpakken) van de bestelling zijn er geen verstoringen opgetreden.

IPD0001 Het gevraagde artikel <productNaam> bestaat niet.

Foutmelding

Er wordt een artikel besteld (artikelcode) dat niet bekend is bij de KvK (artikelcode bestaat niet).

IPD0002 De gevraagde versie van het product <productNaam> bestaat niet.

Foutmelding

Er wordt een versie van het artikel besteld dat niet (meer) door de KvK wordt geleverd.

Pagina 11 van 12


IPD0003 Het klantnummer is onbekend.

Foutmelding

Er is een bestelling geplaatst door een onbekende afnemer. - Onbekend WWW profiel (controleer LDAP/CF beheer) - Er is een fout opgetreden bij de operatie OphalenDebiteur (Generiek boekingsservice)

IPD0004 Het KvK nummer is niet valide

Foutmelding

Het opgegeven KvKnummer voldoet niet aan zijn formaat. - 8 posities lang - Voldoet niet aan 11-proef

IPD0005 Op basis van het KvKnummer kan het product niet worden geleverd.

Foutmelding

Er is geen Onderneming of Maatschappelijke activiteit gevonden van het betreffende KvKnummer. - KvKnummer bevindt zich niet in de IPD componenten cache

IPD0006 Het vestigingsnummer is niet valide.

Foutmelding

Het opgegeven vestigingsnummer voldoet niet aan zijn formaat. - 12 posities lang

IPD0007 Op basis van het vestigingsnummer kan het product niet worden geleverd.

Foutmelding

Er is geen Vestiging gevonden van het betreffende vestigingsnummer. - De Vestiging bevindt zich niet in de IPD componenten cache

IPD0008 Het burgerservicenummer is niet valide

Foutmelding

Het opgegeven burgerservicenummer voldoet niet aan zijn formaat. - 9 posities lang

IPD0009 Op basis van het burgerservicenummer kan het product niet worden geleverd.

Foutmelding

Er is geen Natuurlijk Persoon gevonden van het betreffende burgerservicenummer. - Natuurlijk Persoon bevindt zich niet in de IPD componenten cache

IPD0010 Het RSI-nummer is niet valide

Foutmelding

Het opgegeven RSI-nummer voldoet niet aan zijn formaat. - 9 posities lang

IPD0011 Op basis van het RSInummer kan het product niet worden geleverd.

Foutmelding

Er is geen Niet Natuurlijk Persoon gevonden van het betreffende RSI-nummer. - Niet Natuurlijk Persoon bevindt zich niet in de IPD componenten cache

IPD1000 Eén of meerdere Foutmelding inschrijvingen (KvKnummers) zijn niet beschikbaar. Het product kan niet worden samengesteld. IPD1002 De gegevens zijn tijdelijk niet Waarschuwing leverbaar omdat deze in behandeling zijn. Probeer het later nog eens. IPD1005 De gegevens van deze Foutmelding opvraging zijn niet leverbaar in de door u gebruikte versie. Voor informatie over nieuwe versie(s) kunt u contact opnemen met uw AccountManager.

Er is een aantekening (noodprocedure) op een KvKnummer dat in het product wordt gebruikt.

IPD9998 Algemene invoer parameter fout

Foutmelding

Het artikel dat wordt besteld wordt met ongeldige of onvolledige parameters opgevraagd.

IPD9999 Algemene technische fout

Foutmelding

Het produceren van het artikel is gefaald door een technische fout.

Pagina 12 van 12

Er is een blokkade (algemeen) op een KvKnummer dat in het product wordt gebruikt. Een nieuw gegeven of een nieuwe enumeratie of waarde van een opgevraagd veld kan in de, door de gebruiker gehanteerde, versie niet worden geleverd en wordt daarom herleid naar deze IPD1005 foutmelding.


Functionele Dataservice Beschrijving

Recommend Documents