Service API Specificatie. Key2Parkeren Koppelvlak Kentekenwijziging

Service API Specificatie Key2Parkeren Koppelvlak Kentekenwijziging

Product:

Key2Parkeren

Services:

Koppelvlak Kentekenwijziging

Versie:

1.0

Datum:

10-10-2014

Status:

Gepubliceerd

Auteur:

Centric Netherlands, Public Sector Solutions, Belastingen

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 .................................................................................................................. 10 Voorbeeldberichten ...................................................................................................................12 Vergunningenvraag ............................................................................................................... 12 Request opvragen actuele vergunningen o.b.v. type .......................................................... 12 Response........................................................................................................................... 12 Request opvragen actuele vergunningen o.b.v. soort vergunning ...................................... 12 Response........................................................................................................................... 13 Permanente kentekenwijziging .............................................................................................. 14 Request ............................................................................................................................. 14 Response........................................................................................................................... 14

Key2Parkeren, Koppelvlak Kentekenwijziging 1.0 Centric Netherlands B.V. Gepubliceerd, 29-11-2014

Copyright 2014, Centric Netherlands B.V. 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 Centric Netherlands B.V


Service API Specificatie Introductie

Versie historie Versie 1.0

Datum 2014-11-29


Wijzigingen

Service API Specificatie 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.


Service API Specificatie 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.

Key2Parkeren, Koppelvlak Kentekenwijziging 1.0 / Service API Specification Centric Netherlands B.V. Gepubliceerd, 29-11-2014

Service API Specificatie

Ophalen gegevens

Web Service: IParkeerGegevens Target Namespace: http://www.centric.eu/key2parkeren/ 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: http://www.centric.eu/key2parkeren/IParkeergegevens/PlaatssoortenRequest 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)

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)

Response Response Lijst met plaatssoorten

Key2Parkeren, Koppelvlak Kentekenwijziging 1.0 / Service API Specification B.V. Gepubliceerd, 29-11-2014

Centric Netherlands


Productspecificaties Operation type: Request-response. The endpoint receives a message, and sends a correlated message. SOAP action: http://www.centric.eu/key2parkeren/IParkeergegevens/ProductspecificatiesRequest 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)

Vergunning soort

b.v. BNK of 1BW

Varchar2(4)

productcategorie

B.v. A of V of 20

Varchar2(6)

Parkeerzone

b.v. 1100 of 300100

Number(6)

Beschikbaar op adres

True of False

boolean

Beschikbaar in gebied

True of False

boolean

Response

Te betalen bedrag

Volgens StUF-EF (dus in centen)

AI Machtiging aanwezig

True of False

boolean

Einddatum periode

Einddatum eerste geldigheidsperiode

Number(8)


Centric Netherlands


Vergunningenvraag Operation type: Request-response. The endpoint receives a message, and sends a correlated message. SOAP action: http://www.centric.eu/key2parkeren/IParkeergegevens/Vergunningaanvraagselectie 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. 23901

Number(9)

Code Parkeerzone

b.v. 1100 of 300100

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

Varchar2(8)

Kenteken 3

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

hhmm

Betaalstatus vergunning

0 = niet betaald, 1 = betaling onderweg en 3 = betaling verwerkt

Actuele Vergunningen worden opgehaald. Key2Parkeren, Koppelvlak Kentekenwijziging 1.0 / Service API Specification B.V. Gepubliceerd, 29-11-2014

Centric Netherlands


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: http://www.centric.eu/key2parkeren/IParkeergegevens/VergunninggebiedRequest 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. 1900

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

Vergunningnummer

b.v. 45612

Number(9)

Status vergunning

b.v. LV of AB

Varchar2(2)

Zaaknummer Key2Parkeren

b.v. 7181

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. 7363785

Number(10)

Response Key2Parkeren


Centric Netherlands


Kentekenwijziging

Web Service: IKentekenwijziging Target Namespace: http://www.centric.eu/key2parkeren/ 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: http://www.centric.eu/key2parkeren/IKentekenwijziging/KentekenwijzigingRequest 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-00012

Varchar2(255)

Aanvraagdatum

yyyymmdd

Number(8)

BSN Gebruikerscode

Number(10) gebruikerscode voor de gemeente.

Number(4)

Midoffice referentienummer BetalingID

Ogone/Ideal betalingskenmerk

Bedrag

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)


Centric Netherlands


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)


Centric Netherlands


Voorbeeldberichten Vergunningenvraag Request opvragen actuele vergunningen o.b.v. type <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:key="http://www.centric.eu/key2parkeren"> <soapenv:Header/> <soapenv:Body> 043012180 1 B

Response <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> 231983 5000 WH82 BNK Bewonersvergunning kwartaal 38-ZBD-1 true 20150101 5 2 0 0 1

Request opvragen actuele vergunningen o.b.v. soort vergunning <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:key="http://www.centric.eu/key2parkeren"> <soapenv:Header/> <soapenv:Body> 063013654 1 BKW


Centric Netherlands


Response <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> 315 100100 Parkeergebied Centrum BKW Bewonersvergunning kwartaal WW-22-AA true 20130101 5 2 0 0 3 317 100100 Parkeergebied Centrum BKW Bewonersvergunning kwartaal ZZ-00-BB true 20150401 5 2 0 0 3 344 100100 Parkeergebied Centrum BKW Bewonersvergunning kwartaal JJ-11-JJ false 20150101 5 2 2 0 1


Centric Netherlands


Permanente kentekenwijziging Request <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:key="http://www.centric.eu/key2parkeren"> <soapenv:Header/> <soapenv:Body> KTW-0012 20140227 083014657 1 279 HU-IJ-89 31-ZXT-9 P

Response <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> 31-ZXT-9 279


Centric Netherlands

Service API Specificatie. Key2Parkeren Koppelvlak Kentekenwijziging

Recommend Documents