Openbare webservice diergeneeskunderegister

Transcriptie

1 Titel Onderwerp Beschrijving webservice Versie 1.1 Datum Documentnaam Diris openbare webservice v1.1 Auteur CIBG / ICT unit

2 Inhoud 1 Revisie historie Inleiding ListVcpApprox Werking Interface Type ListVcpApprox Type ArticleRegistrationExtApp Type JudgmentProvisionExtApp Type AddressExtApp Mogelijke foutsituaties Te veel zoekresultaten Niet valide zoekpad Toegang Versie Bijlage A. Beroepsgroepen...10 Versie 1.1 pagina 2 van 10

3 1 Revisie historie Datum Versie Omschrijving Status Eerste concept Voorstel Definitief Definitief Aanpassing link Definitief Versie 1.1 pagina 3 van 10

4 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. Het Op basis van de Wet Uitoefening Diergeneeskunde (WUD) beheren we een actueel register van meer dan (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 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

5 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 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. 3.2 Interface Operatie ListVcpApprox Richting Veld Type Opmerkingen In WebSite enum Alleen de waarde Diris is toegestaan Name string Naam of partnernaam van de veterinair Initials string Voorletters van de veterinair Prefix string Voorvoegsels van de veterinair Versie 1.1 pagina 5 van 10

6 Uit Gender string Geslacht van de veterinair City string Plaats van het praktijkadres van de veterinair RegistrationNumber string Registratienummer van de inschrijving. Wanneer dit veld gevuld is moet het van het type decimal zijn. DateOfBirth string Geboortedatum van de veterinair. Wanneer dit veld gevuld is moet het van het type datetime zijn. Formaat yyyy-mm-dd ListVcpApprox [] ListVcpApprox Geen of meerdere resultaten van de zoek criteria 3.3 Type ListVcpApprox Veld Type Opmerkingen VcpNumber decimal Veterinair nummer BirthSurname string Geboortenaam van de veterinair Prefix string Tussenvoegsel wat behoord bij de geboortenaam van de veterinair. PartnerName string Naam van de partner van de veterinair PartnerNamePrefix string Tussenvoegsel van de partner van de veterinair Initial string Voorletters van de veterinair Gender string Geslacht van de veterinair WorkAddress1 AddressExtApp Gegevens van praktijkadres 1 van het type AddressExtApp WorkAddress2 AddressExtApp Gegevens van praktijkadres 2 van het type AddressExtApp WorkAddress3 AddressExtApp Gegevens van praktijkadres 3 van het type AddressExtApp ArticleRegistration[] ArticleRegistrationExtApp 0-N aantal registraties van het type ArticleRegistrationExtApp JudgmentProvision[] JudgmentProvisionExtApp 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 Type Opmerkingen ArticleRegistrationNumber Decimal Het registratienummer, identificerend voor deze entiteit. ProfessionalGroupCode String De beroepsgroep van de Versie 1.1 pagina 6 van 10

7 registratie van de veterinair. Zie hoofdstuk 8 Bijlage A. Beroepsgroepen voor een overzicht van de mogelijk waarden. ArticleRegistrationStartDate DateTime Begindatum van de registratie ArticleRegistrationEndDate DateTime 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 Type Opmerkingen ArticleNumber Decimal Het registratienummer, de referentie naar entiteit ArticleRegistrationExtApp. StartDate DateTime Begindatum van deze bevoegdheidsbeperking EndDate DateTime Einddatim van deze bevoegdheidsbeperking PublicDescription String Omschrijving van de bevoegdheidsbeperking Public Bool 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 Type Opmerkingen StreetName String Straatnaam HouseNumber String Huisnummer en eventueel huisletters HouseNumberAddition String Aanvulling op het huisnummer PostalCode String Postcode City String Plaatsnaam ForeignAddress String Buitenlandsadres CountryCode Decimal 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

8 3.7 Mogelijke foutsituaties 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 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

9 4 Toegang 4.1 Versie 1.1 Toegangspad voor de productie omgeving. 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 ( Versie 1.1 pagina 9 van 10

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