Service API Specificatie. Key2Parkeren Koppelvlak Kentekenwijziging

Transcriptie

1 Key2Parkeren Koppelvlak Kentekenwijziging

2 Product: Services: Key2Parkeren Koppelvlak Kentekenwijziging Versie: 1.0 Datum: Status: Gepubliceerd Auteur:, Public Sector Solutions, Belastingen

3 Inhoudsopgave Inhoudsopgave... 1 Versie historie... 3 Introductie... 4 Het koppelvlak Kentekenwijziging... 5 Onderdelen van het Koppelvlak... 5 Overzicht... 5 Webservices... 5 Ophalen gegevens... 6 Ophalen plaatssoorten... 6 Productspecificaties... 7 Vergunningenvraag... 8 Vergunninggebied/Parkeerzone... 9 Vergunningaanvraag selectie... 9 Kentekenwijziging Voorbeeldberichten...12 Vergunningenvraag Request opvragen actuele vergunningen o.b.v. type Response Request opvragen actuele vergunningen o.b.v. soort vergunning Response Permanente kentekenwijziging Request Response Key2Parkeren, Koppelvlak Kentekenwijziging 1.0

4 Copyright 2014, Niets uit deze uitgave mag worden verveelvoudigd, opgeslagen in een geautomatiseerd gegevensbestand of openbaar gemaakt, in enige vorm of op enige wijze, hetzij elektronisch, mechanisch, door fotokopieën, opnamen of enige andere manier, zonder schriftelijke toestemming van B.V Key2Parkeren, Koppelvlak Kentekenwijziging 1.0

5 Introductie Versie historie Versie Datum Wijzigingen Key2Parkeren, Koppelvlak Kentekenwijziging 1.0

6 Introductie Introductie De API bevat een aantal services voor het muteren van permanente kentekens in de applicatie Key2Parkeren De API bevat een aantal webservices: 1. Ophalen van gegevens die in meerdere services gevraagd worden, zoals prijs- en beschikbaarheidsinformatie of een overzicht van lopende producten 2. Permanente Kentekenwijziging, 3. Basisservice met operaties voor verwerken aanvragen, kentekenwijzigingen, verlengingen en beëindigingen Dit document specificeert de interactie tussen Key2Parkeren en Mid/Front-office door middel van de API Koppelvlak kentekenwijziging. Deze API is gebaseerd op XML. De XSD en WSDL van deze API kunnen worden opgevraagd bij de productmanager voor Key2Parkeren. Op de website wordt altijd de nieuwste versie van dit document gepubliceerd. Key2Parkeren, Koppelvlak Kentekenwijziging 1.0

7 Versie Historie Het koppelvlak Kentekenwijziging Onderdelen van het Koppelvlak Overzicht Het Koppelvlak is modulair opgebouwd en bestaat uit een aantal componenten en bijbehorende documentatie: 1 Webservices voor kentekenmutaties en het ophalen van gegevens De documentatie bestaat uit door het midoffice aan te roepen webservices, XSD s, WSDLS en deze beschrijving van het Koppelvlak. De XSD s en WSDL s kunnen worden opgevraagd bij de productmanager van Key2Parkeren Webservices Er zijn een aantal webservices: 1. Ophalen van gegevens die in meerdere services gevraagd worden 2. Kentekenwijziging, 3. Basisservice met operaties voor verwerken aanvragen, kentekenwijzigingen, verlengingen en beëindigingen De services genoemd onder 2 roept de basisservice aan.

8 Ophalen gegevens Web Service: IParkeerGegevens Target Namespace: Port parkeergegevensoap2_iparkeergegevens Service: Ppvsw005.svc Protocol: SOAP Transport protocol: SOAP over http Schema Ppvsw005.xsd Operations: 1. Plaatssoorten 2. Productspecificaties 3. Vergunningaanvraagselectie 4. Vergunningenvraag 5. Vergunninggebied Ophalen plaatssoorten Operation type: Request-response. The endpoint receives a message, and sends a correlated message. SOAP action: Niet nodig voor de kentekenwijziging Request Request Bepaling plaatssoort(en) bij vergunningsoort gebruikerscode b.v. 344 of 1900 Number (4) vergunningsoort b.v. BNK of 1BW Varchar2(4) Response Response Lijst met plaatssoorten vergunningsoort b.v. BNK Varchar2(4) plaatssoort b.v. N of 4 Varchar2(2) Omschrijving 1plaatssoort b.v. vergunninghoudersplaats Varchar2(40) Omschrijving 2 plaatssoort b.v. woonwijk Varchar2(40)

9 Productspecificaties Operation type: Request-response. The endpoint receives a message, and sends a correlated message. SOAP action: Niet nodig voor de kentekenwijziging Request Opvragen product specificaties *BSN/NAW volgens StUF-EF. Indien de aanvrager al bekend is in het systeem, dan volstaat het BSN, anders zijn ook de NAW gegevens nodig voor bepaling van het vergunning gebied en het vastleggen van het subject in de database gebruikerscode Number(4) productcategorie B.v. A of V of 20 Varchar2(6) Vergunning soort b.v. BNK of 1BW Varchar2(4) Ingangsdatum vergunning yyyymmdd Number(8) Response Vergunning soort b.v. BNK of 1BW Varchar2(4) productcategorie B.v. A of V of 20 Varchar2(6) Parkeerzone b.v of Number(6) Beschikbaar op adres True of False boolean Beschikbaar in gebied True of False boolean Te betalen bedrag Volgens StUF-EF (dus in centen) AI Machtiging aanwezig True of False boolean Einddatum periode Einddatum eerste geldigheidsperiode Number(8)

10 Vergunningenvraag Operation type: Request-response. The endpoint receives a message, and sends a correlated message. SOAP action: Request Haalt de actuele vergunningen van een aanvrager op. Actuele vergunningen zijn vergunningen met de status BL, LV of WB waarvoor geldt dat deinde > systeemdatum EN die een vergunningregel hebben waarvoor geldt dat dingangperiode <= systeemdatum < deindeperiode (=een actuele vergunningregel) en iregel = P Request BSN Number(10) Gebruikerscode gebruikerscode voor de gemeente. Number(4) Indicatie type vergunning Indicatie bewoners of zakelijk B = bewoners en Z = zakelijk als vergunning soort leeg Varchar2(1) Vergunning soort Als Indicatie type is leeg Varchar2(4) Vergunningen kunnen opgevraagd worden op type (bewoners of zakelijk) of op soort vergunning Response Lijst met lopende vergunningen met de volgende elementen Vergunningnummer b.v Number(9) Code Parkeerzone b.v of Number(6) Omschrijving parkeerzone b.v. Havenkwartier of Delfgaauw Varchar2(50) Vergunning soort b.v. BNK Varchar2(4) Omschrijving soort vergunning b.v. Bewoners kwartaal Varchar2(40) Kenteken 1 b.v. 99-XX-XX of 99-XXX-9 enz. Varchar2(8) Kenteken 2 Kenteken 3 Varchar2(8) Varchar2(8) Kenteken tekst b.v. 4-DEXTER, HH 14DG 1 of Plasman BV Varchar2(20) Indicatie TKR mogelijk True of False boolean Einddatum geldigheid actuele periode yyyymmdd Toegestaan aantal dagen TKR TKR = tijdelijke kenteken registratie b.v. 5 Toegestaan aantal TKR per kalenderjaar b.v. 3 Aantal geregistreerde TKR lopend jaar b.v. 2 Eindtijd geldigheid actuele periode Betaalstatus vergunning hhmm 0 = niet betaald, 1 = betaling onderweg en 3 = betaling verwerkt Actuele Vergunningen worden opgehaald.

11 Informatie die in het antwoord teruggegeven wordt kan voor verschillende doeleinden gebruikt worden. Vergunninggebied/Parkeerzone Operation type: Request-response. The endpoint receives a message, and sends a correlated message. SOAP action: Niet nodig voor de kentekenwijziging Request bepalen parkeerzone BSN/NAW volgens StUF-EF als de persoon al bekend is volstaat het BSN Gebruikerscode gebruikerscode voor de gemeente., b.v Number(4) Het antwoord geeft de code van de parkeerzone terug Response Key2Parkeren Code parkeerzone Parkeerzone( leeg wanneer aanvrager niet in een zone) Number(6) Vergunningaanvraag selectie Niet nodig voor de kentekenwijziging Request Vergunningaanvraag selectie Gebruikerscode b.v. 344 Number (4) Midoffice referentienummer b.v. ERdAg5 Varchar2 Response Key2Parkeren Vergunningnummer b.v Number(9) Status vergunning b.v. LV of AB Varchar2(2) Zaaknummer Key2Parkeren b.v Number(10) Geldig VANAF Yyyymmdd gevuld als status LV of WB Number(8) Geldig TOT Yyyymmdd gevuld als status LV of WB Number(8) Subjectnummer aanvrager b.v Number(10)

12 Kentekenwijziging Web Service: IKentekenwijziging Target Namespace: Port BasicHttpBinding_IKentekenwijziging Service:Ppvsw030.svc Protocol: SOAP Transport protocol: SOAP over http Schema Ppvsw030.xsd Operations: 1. Kentekenwijziging Operation type: Request-response. The endpoint receives a message, and sends a correlated message. SOAP action: Deze service kan worden gebruikt voor het wijzigen van een permanent kenteken Als er een vergunning is gekozen waarvan het permanente kenteken moet worden gewijzigd volgt een request waarin de wijziging staat. Een permanente kentekenwijziging gaat per direct in. In Key2Parkeren wordt GEEN zaak vastgelegd. Request Aanvraagnummer b.v. KTW Varchar2(255) Aanvraagdatum yyyymmdd Number(8) BSN Number(10) Gebruikerscode gebruikerscode voor de gemeente. Number(4) Midoffice referentienummer BetalingID Bedrag Ogone/Ideal betalingskenmerk Betaald bedrag in centen Vergunningnummer De te wijzigen vergunning Number(9) Kenteken oud NL kenteken met koppelstreepjes b.v. 99-XX-XX Varchar2(8) Kenteken nieuw NL kenteken Varchar2(8) Ingangsdatum Systeemdatum (zie verwerking in Key2Parkeren) Number(8) Type kenteken nieuw Indicatie type: B=bedrijf,L=Lease,P=particulier Varchar2(1)

13 Na wijzigen van het permanente kenteken volgt een response uit Key2Parkeren met een bevestiging van het nieuwe kenteken response Nieuw kenteken NL kenteken Varchar2(8) Vergunningnummer vergunning nummer Number(9)

14 Voorbeeldberichten Vergunningenvraag Request opvragen actuele vergunningen o.b.v. type <soapenv:envelope xmlns:soapenv=" xmlns:key=" <soapenv:header/> <soapenv:body> <key:vergunningenvraag> <!--Optional:--> <key:bsn> </key:bsn> <key:kgbr>1</key:kgbr> <key:ibewzak>b</key:ibewzak> </key:vergunningenvraag> </soapenv:body> </soapenv:envelope> Response <s:envelope xmlns:s=" <s:body xmlns:xsi=" xmlns:xsd=" <Vergunningen xmlns=" <Vergunningantwoord> <Rvergunning>231983</Rvergunning> <Kgebied>5000</Kgebied> <Ogebied>WH82</Ogebied> <Ksrtvergunning>BNK</Ksrtvergunning> <Osrtvergunning>Bewonersvergunning kwartaal</osrtvergunning> <Kenteken>38-ZBD-1</Kenteken> <Tkr_mogelijk>true</Tkr_mogelijk> <Deindeperiode> </Deindeperiode> <Adagen_duur_tkr>5</Adagen_duur_tkr> <A_tkr_kalender_jr>2</A_tkr_kalender_jr> <A_num_tkr>0</A_num_tkr> <Teindeperiode>0</Teindeperiode> <Kbetaling>1</Kbetaling> </Vergunningantwoord> </Vergunningen> </s:body> </s:envelope> Request opvragen actuele vergunningen o.b.v. soort vergunning <soapenv:envelope xmlns:soapenv=" xmlns:key=" <soapenv:header/> <soapenv:body> <key:vergunningenvraag> <!--Optional:--> <key:bsn> </key:bsn> <key:kgbr>1</key:kgbr> <key:ksrtvergunning>bkw</key:ksrtvergunning> </key:vergunningenvraag> </soapenv:body> </soapenv:envelope>

15 Response <s:envelope xmlns:s=" <s:body xmlns:xsi=" xmlns:xsd=" <Vergunningen xmlns=" <Vergunningantwoord> <Rvergunning>315</Rvergunning> <Kgebied>100100</Kgebied> <Ogebied>Parkeergebied Centrum</Ogebied> <Ksrtvergunning>BKW</Ksrtvergunning> <Osrtvergunning>Bewonersvergunning kwartaal</osrtvergunning> <Kenteken>WW-22-AA</Kenteken> <Tkr_mogelijk>true</Tkr_mogelijk> <Deindeperiode> </Deindeperiode> <Adagen_duur_tkr>5</Adagen_duur_tkr> <A_tkr_kalender_jr>2</A_tkr_kalender_jr> <A_num_tkr>0</A_num_tkr> <Teindeperiode>0</Teindeperiode> <Kbetaling>3</Kbetaling> </Vergunningantwoord> <Vergunningantwoord> <Rvergunning>317</Rvergunning> <Kgebied>100100</Kgebied> <Ogebied>Parkeergebied Centrum</Ogebied> <Ksrtvergunning>BKW</Ksrtvergunning> <Osrtvergunning>Bewonersvergunning kwartaal</osrtvergunning> <Kenteken>ZZ-00-BB</Kenteken> <Tkr_mogelijk>true</Tkr_mogelijk> <Deindeperiode> </Deindeperiode> <Adagen_duur_tkr>5</Adagen_duur_tkr> <A_tkr_kalender_jr>2</A_tkr_kalender_jr> <A_num_tkr>0</A_num_tkr> <Teindeperiode>0</Teindeperiode> <Kbetaling>3</Kbetaling> </Vergunningantwoord> <Vergunningantwoord> <Rvergunning>344</Rvergunning> <Kgebied>100100</Kgebied> <Ogebied>Parkeergebied Centrum</Ogebied> <Ksrtvergunning>BKW</Ksrtvergunning> <Osrtvergunning>Bewonersvergunning kwartaal</osrtvergunning> <Kenteken>JJ-11-JJ</Kenteken> <Tkr_mogelijk>false</Tkr_mogelijk> <Deindeperiode> </Deindeperiode> <Adagen_duur_tkr>5</Adagen_duur_tkr> <A_tkr_kalender_jr>2</A_tkr_kalender_jr> <A_num_tkr>2</A_num_tkr> <Teindeperiode>0</Teindeperiode> <Kbetaling>1</Kbetaling> </Vergunningantwoord> </Vergunningen> </s:body> </s:envelope>

16 Permanente kentekenwijziging Request <soapenv:envelope xmlns:soapenv=" xmlns:key=" <soapenv:header/> <soapenv:body> <key:kentekenwijzigingaanvraag> <!--Optional:--> <key:algemeen> <!--Optional:--> <key:aanvraagnummer>ktw-0012</key:aanvraagnummer> <key:aanvraagdatum> </key:aanvraagdatum> <!--Optional:--> <key:bsn> </key:bsn> <key:kgbr>1</key:kgbr> </key:algemeen> <key:rvergunning>279</key:rvergunning> <!--Optional:--> <key:kenteken_oud>hu-ij-89</key:kenteken_oud> <!--Optional:--> <key:kenteken_nieuw>31-zxt-9</key:kenteken_nieuw> <key:ikenteken_nieuw>p</key:ikenteken_nieuw> </key:kentekenwijzigingaanvraag> </soapenv:body> </soapenv:envelope> Response <s:envelope xmlns:s=" <s:body xmlns:xsi=" xmlns:xsd=" <Kentekenwijziging xmlns=" <Kenteken_nieuw>31-ZXT-9</Kenteken_nieuw> <Rvergunning>279</Rvergunning> </Kentekenwijziging> </s:body> </s:envelope>