Verkeersborden download API 4.0
API beschrijving
Deze API biedt services voor het ophalen van verkeersborden events. De API bestaat uit twee services:
- Een service voor het ophalen van alle aanwezige verkeersborden events in het systeem, per blok van maximaal 100 events.
-
Een service voor het ophalen van het actuele beeld. Het actuele beeld van de verkeersborden wordt maandelijks bijgewerkt.
- Er zijn drie mogelijk output voor de actuele beeld:
- GeoJson
- CSV
- Er zijn drie mogelijk output voor de actuele beeld:
API versie 4.0
Wijziging per 11-07-2024, ten behoeve extra velden in Verkeersbordenbestand en onderborden. Daarnaast een toevoeging van leverancier ID.
3.0 versie blijft tot en met 1 november 2024 in stand. Hierna zullen wij deze versie uit de lucht halen. Tot die tijd kun je van de URL- en Swagger methode met v3 erin gebruik maken.
Beschrijving outputvelden
| CSV | GeoJSON | Veld | Data Type | Formaat | Voorbeeld |
|---|---|---|---|---|---|
| id | id | id | string | UUID | e0ace570-8eee-45ef-8083-f6139460c52a |
| type | string | Feature (vaste waarde) | Feature | ||
| properties | object | ||||
| externalId | properties.externalId | externalId | string | (vrij formaat; leverancier id of oude HR groep id) | 23 |
| validated | properties.validated | validated | String | Enum: n, j | n |
| validatedOn | properties.validatedOn | validatedOn | Date | ISO | 2020-12-01 |
| rvvCode | properties.rvvCode | rvvCode | String | Enum: A1, A1(Zone), A2 etc | A1 |
| blackCode | properties.blackCode | blackCode | String | Verschilt per RVV code | 50 |
| zoneCode | properties.zoneCode | zoneCode | String | Enum: ZB, ZH, ZE, ZO of leeg | ZB |
| status | properties.status | status | String | Enum: PLANNED, PLACED, REMOVED | PLANNED |
| textSigns | textSigns | String | type(text) of TIJD(text)(openingHours). Meerdere onderborden gescheiden door ; | VOOR(150 m);TIJD(ma-vr 9-17)(Mo-Fr 09:00-17:00) | |
| properties.textSigns | textSigns | Array van Object | |||
| properties.textSigns[i].type | textSigns[i].type | String | Enum: VRIJ, EMIS, KEN, RICH, UIT, VOOR, TIJD | VOOR | |
| properties.textSigns[i].text | textSigns[i].text | String | 150 m | ||
| properties.textSigns[i].openingHours | textSigns[i].openingHours | String | Tijdsvenster volgens https://wiki.openstreetmap.org/wiki/Key:opening_hours (alleen voor onderbord type TIJD) | ||
| latitude | geometry.coordinates[1]* | latitude | Double | WGS84 Breedtegraad | 50.85733 |
| longitude | geometry.coordinates[0]* | longitude | Double | WGS84 Lengtegraad | 5.31724 |
| rdX | geometry.coordinates[0]* | rdX | Double | Rijksdriehoek x | 150073.8098280745 |
| rdY | geometry.coordinates[1]* | rdY | Double | Rijksdriehoek y | 318613.80684469093 |
| geometry.type | String | Point (vaste waarde) | Point | ||
| placement | properties.placement | placement | String | Enum: L, B | L |
| side | properties.side | side | String | Enum: L, R, N Z, O, W, NO, NNO etc | NO |
| bearing | properties.bearing | bearing | Integer | Tussen 0 en 359 (inclusief) | 49 |
| nenTurningDirection | properties.nenTurningDirection | nenTurningDirection | Integer | Tussen 0 en 359 (inclusief) | 45 |
| fraction | properties.fraction | fraction | Double | Tussen 0.0 en 1.0 (inclusief) | 0.42 |
| drivingDirection | properties.drivingDirection | drivingDirection | String | Enum: H, T of leeg | H |
| roadName | properties.roadName | roadName | String | Waterwolftunnel | |
| roadType | properties.roadType | roadType | Integer | Enum: 1, 2 of leeg | 1 |
| roadNumber | properties.roadNumber | roadNumber | Integer | Positief | 201 |
| roadSectionId | properties.roadSectionId | roadSectionId | Integer | Positief | 226354035 |
| nwbVersion | properties.nwbVersion | nwbVersion | Date | ISO | 2023-11-01 |
| countyName | properties.countyName | countyName | String | Heerlen | |
| countyCode | properties.countyCode | countyCode | String | GMxxxx | GM0358 |
| townName | properties.townName | townName | String | Hoensbroek | |
| bgtCode | properties.bgtCode | bgtCode | String | ||
| imageUrl | properties.imageUrl | imageUrl | String | URL | https://... |
| firstSeenOn | properties.firstSeenOn | firstSeenOn | Date | ISO | 2020-12-01 |
| lastSeenOn | properties.lastSeenOn | lastSeenOn | Date | ISO | 2020-12-01 |
| removedOn | properties.removedOn | removedOn | Date | ISO | 2020-12-01 |
| placedOn | properties.placedOn | placedOn | Date | ISO | 2020-12-01 |
| expectedPlacedOn | properties.expectedPlacedOn | expectedPlacedOn | Date | ISO | 2024-12-01 |
| expectedRemovedOn | properties.expectedRemovedOn | expectedRemovedOn | Date | ISO | 2024-12-01 |
| trafficOrderUrl | properties.trafficOrderUrl | trafficOrderUrl | String | URL | https://... |
Note 1: wgs84 of rd is verplicht. Wgs84 wordt als eerste gebruikt Note 2: side of bearing is verplicht. Bearing wordt als eerste gebruikt Note 3: roadSectionId of bgtCode is verplicht bij status PLACED Note 4: voor status REMOVED is alleen id verplicht
Services
Service GET verkeersborden events blok
Samenvatting
Haal een blok van verkeersborden events op.
Beschrijving
Dit API endpoint biedt een manier om alle gepubliceerde verkeersborden
events in blokken te verkrijgen, die worden gespecificeerd door de
limit- en offsetqueryparameters. De geretourneerde verkeersbord events
worden gesorteerd op hun publication_timestamp, oudste eerst.
Het publication_timestamp van het laatst ontvangen event kan dus worden
gebruikt om de volgende reeks events te verkrijgen met behulp van de
offsetparameter. Dit biedt een gemakkelijke manier om het ophalen van
verkeersborden events te stoppen en op een later tijdstip voort te
zetten.
Omdat de publication_timestamp van gebeurtenissen potentieel niet uniek-- is, zullen volgende verzoeken events van de gegeven offsettimestamp bevatten, om potentiële events niet te missen of over te slaan. Merk op dat dit zal resulteren in het ophalen van dubbele events die correct aan de clientzijde moeten worden afgehandeld.
HTTP methode
GET
URL
Query parameters
| Veldnaam | Beschrijving |
|---|---|
| offset | Tijdstempel dat het publicatiemoment aangeeft waaruit de verkeersborden events kunnen worden opgehaald. Deze bewerking omvat ook events met een overeenkomend publication_timestamp. Vereist: nee Type: Datetime Formaat: yyyy-MM-ddTHH:mm:ss.SSSZ Voorbeeld: 2022-04-27T12:34:56.123Z Standaardwaarde: 1970-01-01T00:00:00.000Z |
| limit | Maximumaantal geretourneerde verkeersborden (blokgrootte). Vereist: nee Type: integer Voorbeeld: 1 Standaardwaarde: 100 Minimumwaarde: 1 Maximumwaarde: 100 |
| countyCode | Gemeentecode die kan worden gebruikt om het gebied te beperken waarvandaan verkeersborden worden teruggestuurd. Alleen verkeersborden met de exact overeenkomende gemeentecode worden geretourneerd. Zie ook: CBS Gemeentelijke Indelingen Vereist: nee Type: string Voorbeeld: GM0321 Maximumlengte: 6 Standaardwaarde: leeg |
Voorbeelden
GET https://wegkenmerken.ndw.nu/api/rest/static-road-data/traffic-signs/v4/events dit zal de standaard queryparameterwaarden gebruiken
GET https://wegkenmerken.ndw.nu/api/rest/static-road-data/traffic-signs/v4/events?offset=2023-04-27T12%3A34%3A56.123Z&countyCode=GM0448 dit retourneert de eerste 100 events vanaf 27 april 2023 's middags in gemeente 0448
beschrijving outputvelden
| JSON | Veld | Data Type | Formaat | Voorbeeld |
|---|---|---|---|---|
| id | id | string | UUID | e0ace570-8eee-45ef-8083-f6139460c52a |
| externalId | externalId | string | (vrij formaat; leverancier id of oude HR groep id) | 23 |
| validated | validated | String | Enum: n, j | n |
| validatedOn | validatedOn | Date | ISO | 2020-12-01 |
| rvvCode | rvvCode | String | Enum: A1, A1(Zone), A2 etc | A1 |
| blackCode | blackCode | String | Verschilt per RVV code | 50 |
| zoneCode | zoneCode | String | Enum: ZB, ZH, ZE, ZO of leeg | ZB |
| status | status | String | Enum: PLANNED, PLACED, REMOVED | PLANNED |
| textSigns | textSigns | Array van Object | ||
| textSigns[i].type | textSigns[i].type | String | Enum: VRIJ, EMIS, KEN, RICH, UIT, VOOR, TIJD | VOOR |
| textSigns[i].text | textSigns[i].text | String | 150 m | |
| textSigns[i].openingHours | textSigns[i].openingHours | String | Tijdsvenster volgens https://wiki.openstreetmap.org/wiki/Key:opening_hours (alleen voor onderbord type TIJD) | |
| location.wgs84.latitude | latitude | Double | WGS84 Breedtegraad | 50.85733 |
| location.wgs84.longitude | longitude | Double | WGS84 Lengtegraad | 5.31724 |
| location.rd.x | rdX | Double | Rijksdriehoek x | 150073.8098280745 |
| location.rd.y | rdY | Double | Rijksdriehoek y | 318613.80684469093 |
| location.placement | placement | String | Enum: L, B | L |
| location.side | side | String | Enum: L, R, N Z, O, W, NO, NNO etc | NO |
| location.bearing | bearing | Integer | Tussen 0 en 359 (inclusief) | 49 |
| location.nenTurningDirection | nenTurningDirection | Integer | Tussen 0 en 359 (inclusief) | 45 |
| location.fraction | fraction | Double | Tussen 0.0 en 1.0 (inclusief) | 0.42 |
| location.drivingDirection | drivingDirection | String | Enum: H, T of leeg | H |
| location.road.name | roadName | String | Waterwolftunnel | |
| location.road.type | roadType | Integer | Enum: 1, 2 of leeg | 1 |
| location.road.number | roadNumber | Integer | Positief | 201 |
| location.road.roadSectionId | roadSectionId | Integer | Positief | 226354035 |
| location.road.nwbVersion | nwbVersion | Date | ISO | 2023-11-01 |
| location.county.name | countyName | String | Heerlen | |
| location.county.code | countyCode | String | GMxxxx | GM0358 |
| location.county.townName | townName | String | Hoensbroek | |
| location.bgtCode | bgtCode | String | ||
| details.imageUrl | imageUrl | String | URL | https://... |
| details.firstSeenOn | firstSeenOn | Date | ISO | 2020-12-01 |
| details.lastSeenOn | lastSeenOn | Date | ISO | 2020-12-01 |
| details.removedOn | removedOn | Date | ISO | 2020-12-01 |
| details.placedOn | placedOn | Date | ISO | 2020-12-01 |
| details.expectedPlacedOn | expectedPlacedOn | Date | ISO | 2024-12-01 |
| details.expectedRemovedOn | expectedRemovedOn | Date | ISO | 2024-12-01 |
| details.trafficOrderUrl | trafficOrderUrl | String | URL | https://... |
Response -- 200 OK
De verkeersborden events zijn met succes opgehaald sinds en inclusief de gegeven offsettimestamp, gemaximaliseerd tot de gegeven limit. De geretourneerde verkeersborden events worden gesorteerd op hun publicication_timestamp, oudste eerst.
De body heeft het content-type application/json en is een JSON-array van onderstaande JSON-objectbeschrijving.
Response -- 400 Bad Request
De client heeft een verzoek verzonden dat niet aan de specificatie
voldoet.
De body van de response bevat informatie over de aard van de fout.
Meestal is dit antwoord te wijten aan een fout aan de kant van de
client.
Voorbeelden van foutgevallen:
- offset parameter komt niet overeen met het formaat
- limit parameter komt niet overeen met de minimum of maximum grootte
- countyCode parameter is groter dan het gewenste formaat, bijvoorbeeld: GM12345 in plaats van GM1234
Response -- 500 Internal Server Error
Het verzoek is niet succesvol verwerkt vanwege een technisch probleem of
beperking.
De body van de response kan informatie bevatten over de aard van de
fout.
Als u vragen heeft over deze API en het gebruik ervan, dan kunt u contact opnemen met de NDW Servicedesk.
Bij vragen over de inhoud van de gedownloade bestanden verwijzen we u graag naar de leverancier van deze data. Deze contactgegevens staan in Toelichting open data verkeersborden en FAQ.
Service GET verkeersborden actueel beeld
Samenvatting
In het actuele beeld wordt voor elk verkeersbord de resultante van alle verwerkte events geretourneerd, tenzij het laatst ontvangen event het type "deleted" heeft. In dit geval wordt het verkeersbord niet meer opgenomen in het actuele beeld.
Het wordt eenmaal per maand (op de eerste dag van de maand) als totaal bestand op de NDW open data omgeving beschikbaar gesteld, zowel als .Json, .GeoJson als als .CSV.
Tussentijds kan door de afnemer het actuele beeld bijgewerkt worden op basis van de service "GET verkeersborden events blok". Intern werkt NDW het actueel beeld continue bij. Elke nacht wordt een volledig beeld opgeslagen, deze is te downloaden via de api zonder query parameters.
Bij gebruik van query parameters wordt niet het opgeslagen bestand gebruikt, maar wordt direct gefilterd op de data zoals die op dat moment bekend is, dus inclusief wijzigingen van die dag. Het (gefilterde) actuele beeld kan in twee formaten opgehaald worden. Standaard wordt het actueel beeld als Json formaat uitgeleverd. Door de Accept header met waarde "text/csv" of de content-type queryparameter met waarde "csv" op het request te zetten, wordt het actueel beeld als CSV formaat uitgeleverd.
Per versie 4.0 van de API zijn er extra kolommen en formatting bij gedaan.
HTTP methode
GET
URL
https://data.ndw.nu/api/rest/static-road-data/traffic-signs/v4/current-state
Query parameters
| Veldnaam | Beschrijving |
|---|---|
| countyCode | Gemeentecode die kan worden gebruikt om het gebied te beperken waarvandaan verkeersborden worden teruggestuurd. Alleen verkeersborden met de exact overeenkomende gemeentecode worden geretourneerd. Zie ook: CBS Gemeentelijke Indelingen Vereist: nee Type: string Voorbeeld: GM0321 Standaardwaarde: leeg |
| rvv-code | RVV code die gebruikt kan worden om het actuele beeld te filteren op basis van de RVV-code die de verkeersborden hebben. Alle verkeersborden met de opgegeven RVV code (exacte match), worden geretourneerd Zie ook: Reglement verkeersregels en verkeerstekens 1990 (RVV 1990) Bijlage 1. Verkeersborden Vereist: nee Type: string Voorbeeld: A1 Standaardwaarde: leeg Maximum lengte: 50 je kunt meerdere selecties doen bijv A1 en A2 |
| road-section-ids | Lijst van wegvakids waarop gefilterd kan worden in het actuele beeld. De lijst heeft geen limiet voor het aantal wegvakids dat opgegeven kan worden Alleen verkeersborden met een overeenkomend wegvakid worden geretourneerd. Zie ook: https://nationaalwegenbestand.nl/documenten - Download ‘Gebruikershandleiding_NWB_Wegen’ - Zoek voor ‘Wegvak-ID’ voor een uitleg over wegvakids Vereist: nee Formaat: lijst van integers Voorbeeld: 234252051,234252052 Standaardwaarde: leeg |
| status | Hier geef je de status van een verkeersbord aan Vereist: nee Type: String Voorbeeld: PLANNED Standaardwaarde; Leeg Mogelijke waardes: Planned, Removed, Placed |
| crs | Formatting van coordinaten Vereist: Nee Type: String Voorbeeld WGS84: http://www.opengis.net/def/crs/OGC/1.3/CRS84 Standaardwaarde; Leeg Waarde voor Rijsdriehoek: http://www.opengis.net/def/crs/EPSG/9.9.1/28992 |
| content-type | Vul met “csv” om het actueel beeld als CSV formaat in plaats van JSON uitgeleverd te krijgen. Let op dat de Accept header met de waarde “text/csv” op het request voor ditzelfde doeleinde gebruikt kan worden. Voor een uitlevering in GeoJson kun je als header de waarde "application/geo+json" gebruiken. Dit levert je output als een GeoJson aan. Als de queryparameter leeggelaten wordt of met een verkeerde waarde wordt ingevuld, die niet langer is dan de maximumlengte, zal het actueel beeld als JSON uitgeleverd worden. Vereist: nee Type: string Voorbeeld: csv Standaardwaarde: leeg Maxmimum lengte: 3 |
Voorbeelden- voor Json formaat
Tenzij anders aangegeven krijg je met de url methode standaard een GeoJson output
GET https://data.ndw.nu/api/rest/static-road-data/traffic-signs/v4/current-state
Dit zal de standaard query parameterwaarden gebruiken
GET https://wegkenmerken.ndw.nu/api/rest/static-road-data/traffic-signs/v4/current-state?countyCode=GM0096 Levert het actueel beeld van gemeente 0096
GET https://wegkenmerken.ndw.nu/api/rest/static-road-data/traffic-signs/v4/current-state?countyCode=GM0096&rvvCode=A1 Levert het actueel beeld van A01 verkeersborden in gemeente 0096.
GET https://wegkenmerken.ndw.nu/api/rest/static-road-data/traffic-signs/v4/current-state?roadSectionId=265581002 Levert het actueel beeld op van verkeersborden op wegvakid 265581002.
GET https://wegkenmerken.ndw.nu/api/rest/static-road-data/traffic-signs/v4/current-state?countyCode=GM0096&rvvCode=A1&roadSectionId=265581002 Levert het actueel beeld van A1 verkeersborden op wegvak 265581002 welke in gemeente 0096 vallen.
GET https://wegkenmerken.ndw.nu/api/rest/static-road-data/traffic-signs/v4/current-state?countyCode=GM0448&status=PLANNED Levert het actueel beeld van gemeente 0448 welke de status gepland hebben.
GET https://wegkenmerken.ndw.nu/api/rest/static-road-data/traffic-signs/v4/current-state?countyCode=GM0448&rvvCode=A1&crs=http%3A%2F%2Fwww.opengis.net%2Fdef%2Fcrs%2FOGC%2F1.3%2FCRS84 Levert actuele beeld van gemeente 0448 voor A1 borden met coordinaten in WGS84 formaat.
GET https://wegkenmerken.ndw.nu/api/rest/static-road-data/traffic-signs/v4/current-state?countyCode=GM0448&rvvCode=A1&crs=http%3A%2F%2Fwww.opengis.net%2Fdef%2Fcrs%2FEPSG%2F9.9.1%2F28992 Levert actuele beeld van gemeente 0448 voor A1 borden met coordinaten in Rijksdriehoek formaat.
Voorbeelden voor GeoJson en CSV formaat
GET https://wegkenmerken.ndw.nu/api/rest/static-road-data/traffic-signs/v4/current-state?rvvCode=A1&countyCode=GM0321--header'Accept:text/csv'
Zet de Accept header om de response als CSV formaat terug te krijgen.
GET https://wegkenmerken.ndw.nu/api/rest/static-road-data/traffic-signs/v4/current-state?rvvCode=A1&countyCode=GM0321--header'Accept:application/geo+json'
Zet de Accept header om de response als GeoJson formaat terug te krijgen.
GET https://wegkenmerken.ndw.nu/api/rest/static-road-data/traffic-signs/v4/current-state?rvvCode=A1&countyCode=GM0321--header'Accept-Encoding: gzip'--output current-state.gz
Zet de Accept-Encoding header om de response als zip formaat te downloaden en wijs een locatie aan om deze op te slaan
Response -- 200 OK
Het actuele beeld van de verkeersborden events is met succes opgehaald.
De body heeft standaard het content-type application/json en is een
JSON-array van de JSON-objectbeschrijving die terug te vinden is onder
"Request GET verkeersborden events blok - Response -- 200 OK".
Als de content-type queryparameter gevuld is met "csv" of de Accept
header is gevuld met "text/csv" wordt in plaats van JSON een
platgeslagen CSV geretourneerd.
Response -- 400 Bad Request
De client heeft een verzoek verzonden dat niet aan de specificatie
voldoet.
De body van de response bevat informatie over de aard van de fout.
Meestal is dit antwoord te wijten aan een fout aan de kant van de
client.
Voorbeelden van foutgevallen:
- countyCode parameter is groter dan het maximum aantal van 6 tekens
- rvv-code parameter is groter dan het maximum aantal van 50 tekens
- road-section-ids parameter bevat waarden die niet numeriek zijn
- content-type parameter is groter dan het maximum aantal van 3 tekens
Response -- 500 Internal Server Error
Het verzoek is niet succesvol verwerkt vanwege een technisch probleem of
beperking.
De body van de response kan informatie bevatten over de aard van de
fout.
Als u vragen heeft over deze API en het gebruik ervan, dan kunt u
contact opnemen met de servicedesk van NDW
(mail@servicedeskndw.nu)
Bij vragen over de inhoud van de gedownloade bestanden verwijzen we u
graag naar de leverancier van deze data. Deze contactgegevens staan in
Toelichting open data verkeersborden en FAQ.