Openbare webservice diergeneeskunderegister

Openbare webservice diergeneeskunderegister

Titel Onderwerp Versie Datum Documentnaam Auteur

Openbare webservice diergeneeskunderegister Beschrijving webservice 1.1 24-06-2015 Diris openbare webservice v1.1 CIBG / ICT unit

Inhoud 1

Revisie historie................................................................................................ 3

2

Inleiding ......................................................................................................... 4

3

ListVcpApprox ................................................................................................. 5

4

3.1

Werking ................................................................................................... 5

3.2

Interface .................................................................................................. 5

3.3

Type ListVcpApprox ................................................................................... 6

3.4

Type ArticleRegistrationExtApp ................................................................... 6

3.5

Type JudgmentProvisionExtApp ................................................................... 7

3.6

Type AddressExtApp .................................................................................. 7

3.7

Mogelijke foutsituaties ............................................................................... 8

3.7.1

Te veel zoekresultaten ......................................................................... 8

3.7.2

Niet valide zoekpad ............................................................................. 8

Toegang ......................................................................................................... 9 4.1

5

Versie 1.1 ................................................................................................ 9

Bijlage A. Beroepsgroepen ...............................................................................10


Versie 1.1

pagina 2 van 10

1 Revisie historie Datum

Versie

Omschrijving

Status

16-07-2009 16-07-2010 24-06-2015

0.1 1.0 1.1

Eerste concept Definitief Aanpassing link

Voorstel Definitief Definitief


Versie 1.1

pagina 3 van 10

2 Inleiding

Het Diergeneeskunderegister is verantwoordelijk voor de registratie van dierenartsen en paraveterinairen. Met deze registratie kan bijvoorbeeld een dierenarts zijn diergeneeskundige bevoegdheid aantonen Wat doen we? We verzorgen namens het Ministerie van Economische Zaken de inschrijving van dierenartsen en paraveterinairen in het diergeneeskunderegister. Het diergeneeskunderegister Op basis van de Wet Uitoefening Diergeneeskunde (WUD) beheren we een actueel register van meer dan 12.000 (para)veterinairen. Dit register geeft duidelijkheid en zekerheid over de bevoegdheid van een veterinair: is een bepaalde persoon geregistreerd? Zijn er beperkingen opgelegd? Iedereen kan het register per telefoon of via internet raadplegen. Iemand die een beroep uitoefent dat onder de Wet Uitoefening Diergeneeskunde valt moet zich in het Diergeneeskunderegister registreren. Voor de volgende beroepen is registratie verplicht: • Dierenarts • Dierenartsassistent-paraveterinair • Dierfysiotherapeut • Embryotransplanteur/-winner De beroepen castreur en dierenverloskundige kunnen niet meer registreren. Bestaande registraties zijn wel opvraagbaar in het register. Dit document richt zich op de technische voorziening die is gerealiseerd in het systeem om het diergeneeskunderegister te raadplegen met behulp van web services. Dit document beschrijft de ListVcpApprox webservice, de volgende aspecten worden behandeld: - Werking - Interface - Mogelijke foutsituaties - Beveiliging In dit document komen veelvuldig Engelse termen voor. Dit komt omdat het systeem gerealiseerd is met behulp van de Engelse taal. De technische beschrijving van de service (WSDL bestand) is om die reden ook volledig Engels.


Versie 1.1

pagina 4 van 10

3 ListVcpApprox Zoeken naar een veterinair op basis van een aantal criteria. 3.1

Werking

De zoekopdracht zoekt alleen naar veterinairs met een valide registratie. Dit betekent dat de einddatum niet gevuld is of dat de einddatum in de toekomst ligt en de startdatum is vandaag of in het verleden.

Voor het zoeken naar veterinairs zijn een aantal zogenaamde zoekpaden (combinaties van zoekcriteria) beschikbaar. Alleen via zoekpaden kan er gezocht worden naar veterinairs. De volgende zoekpaden zijn beschikbaar. 1. Registratienummer (RegistrationNumber) 2. Naam, Plaatsnaam (Name, City) 3. Naam, Geboortedatum (Name, DateOfBirth) Als er meerdere combinaties mogelijk zijn, worden de zoekpaden in bovenstaande volgorde afgehandeld. Bij het zoeken op plaatsnaam wordt gezocht in het woonadres en alle praktijkadressen (maximaal 3). Zoekveld Name

Initials Prefix Gender City RegistrationNumber DateOfBirth

3.2

Zoek criteria Zoeken op de geboortenaam van de veterinair. Op dit veld wordt een eenvoudige approximate match algoritme toegepast. Exacte vergelijking op de voorletters van de veterinair. Exacte vergelijking op het voorvoegsels van de veterinair. Exacte vergelijking op het geslacht van de veterinair. Exacte vergelijking op de plaatsnaam van het woon- en alle praktijkadressen van de veterinair. Exacte vergelijking op het registratienummer van de veterinair. Exacte vergelijking op de geboortedatum van de veterinair.

Interface

Operatie Richting In

Veld

ListVcpApprox Type

WebSite

enum

Name

string

Initials Prefix

string string


Versie 1.1

Opmerkingen Alleen de waarde “Diris” is toegestaan Naam of partnernaam van de veterinair Voorletters van de veterinair Voorvoegsels van de veterinair

pagina 5 van 10

Gender City

string string

Geslacht van de veterinair Plaats van het praktijkadres van de veterinair Registratienummer van de inschrijving. Wanneer dit veld gevuld is moet het van het type decimal zijn. Geboortedatum van de veterinair. Wanneer dit veld gevuld is moet het van het type datetime zijn. Formaat yyyy-mm-dd

RegistrationNumber

string

DateOfBirth

string

ListVcpApprox []

ListVcpApprox

Uit

3.3

Geen of meerdere resultaten van de zoek criteria

Type ListVcpApprox

Veld VcpNumber BirthSurname Prefix

Type decimal string string

PartnerName

string

PartnerNamePrefix

string

Initial Gender WorkAddress1

string string AddressExtApp

WorkAddress2

AddressExtApp

WorkAddress3

AddressExtApp

ArticleRegistration[]

ArticleRegistrationExtApp

JudgmentProvision[]

JudgmentProvisionExtApp

Opmerkingen Veterinair nummer Geboortenaam van de veterinair Tussenvoegsel wat behoord bij de geboortenaam van de veterinair. Naam van de partner van de veterinair Tussenvoegsel van de partner van de veterinair Voorletters van de veterinair Geslacht van de veterinair Gegevens van praktijkadres 1 van het type AddressExtApp Gegevens van praktijkadres 2 van het type AddressExtApp Gegevens van praktijkadres 3 van het type AddressExtApp 0-N aantal registraties van het type ArticleRegistrationExtApp 0-N aantal bevoegdheidsbeperkingen behorend bij een registratie van het type JudgmentProvisionExtApp

Wanneer meerdere registraties gevonden zijn dan wordt 1 veterinair entiteit geretourneerd. Voor elke registratie kunnen meerdere bevoegdheidsbeperkingen worden geretourneerd. 3.4

Type ArticleRegistrationExtApp

Field ArticleRegistrationNumber

Type Decimal

ProfessionalGroupCode

String


Versie 1.1

Opmerkingen Het registratienummer, identificerend voor deze entiteit. De beroepsgroep van de

pagina 6 van 10

ArticleRegistrationStartDate ArticleRegistrationEndDate

DateTime DateTime

registratie van de veterinair. Zie hoofdstuk 8 Bijlage A. Beroepsgroepen voor een overzicht van de mogelijk waarden. Begindatum van de registratie Einddatum van de registratie

Alleen geldige registraties worden geretourneerd door deze zoekopdracht. Dit betekent dat de einddatum niet gevuld is of dat de einddatum in de toekomst ligt en de startdatum is vandaag of in het verleden. 3.5

Type JudgmentProvisionExtApp

Field ArticleNumber

Type Decimal

StartDate

DateTime

EndDate

DateTime

PublicDescription

String

Public

Bool

Opmerkingen Het registratienummer, de referentie naar entiteit ArticleRegistrationExtApp. Begindatum van deze bevoegdheidsbeperking Einddatim van deze bevoegdheidsbeperking Omschrijving van de bevoegdheidsbeperking Of de bevoegdheidsbeperking openbaar is. Deze waarde is altijd ‘true’

Alleen geldige bevoegdheidsbeperkingen worden geretourneerd door deze zoekopdracht. Dit betekent dat de einddatum niet gevuld is of dat de einddatum in de toekomst ligt en de startdatum is vandaag of in het verleden en dat het bevoegdheidsbeperkingen zijn met het kenmerk publiek. 3.6

Type AddressExtApp

Field StreetName HouseNumber

Type String String

HouseNumberAddition PostalCode City ForeignAddress CountryCode

String String String String Decimal

Opmerkingen Straatnaam Huisnummer en eventueel huisletters Aanvulling op het huisnummer Postcode Plaatsnaam Buitenlandsadres Landcode

Een persoon heeft altijd een woonadres (LivingAddress) en kan minimaal 0 en maximaal 3 praktijkadressen (WorkAddress) hebben.


Versie 1.1

pagina 7 van 10

3.7

Mogelijke foutsituaties

3.7.1 Te veel zoekresultaten Het aantal zoekresultaten van de zoekopdracht is beperkt tot 50. Wanneer er meer dan 50 zoekresultaten gevonden worden zal de service 51 zoekresultaten retourneren. Op deze manier wordt voorkomen dat er foutafhandeling mechanismen moeten worden gebouwd wanneer er meer dan 50 zoekresultaten zijn. Zodra het geretourneerde aantal meer dan 50 is dan heeft de service te veel resultaten gevonden. 3.7.2 Niet valide zoekpad Wanneer het zoekpad niet voldoet aan de eisen genoemd in 3.1 Werking zal de service stoppen met een soap exception. In de soap exception is terug te vinden dat de opgetreden fout een “Incorrect search path” is.


Versie 1.1

pagina 8 van 10

4 Toegang 4.1

Versie 1.1

Toegangspad voor de productie omgeving. http://webservices.cibg.nl/Diris/Openbaar.asmx

Door de manier waarop de beide webservices zijn gehost, kan alleen de operatie ListVcpApprox aangeroepen worden. Op de website van het CIBG is de WSDL definitie op te halen (http://webservices.cibg.nl/Diris/Openbaar.asmx?wsdl).


Versie 1.1

pagina 9 van 10

5 Bijlage A. Beroepsgroepen 01

Dierenartsen

02

Dierenartsassistenten-paraveterinairen

03

Dierfysiotherapeuten

04

Embryotransplanteurs/-winners

05

Veeverloskundigen

06

Castreurs


Versie 1.1

pagina 10 van 10

Openbare webservice diergeneeskunderegister

Recommend Documents