Verkeersborden download API 2.0
API beschrijving 2.0
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.
API versie
2.0
Wijziging per 16-12-2022, ten behoeve van inrichten verbeterde opslag bij NDW.
Beschrijving outputvelden
| Veldnaam Json | Kolomnaam csv | Beschrijving | Datatype met voorbeeld |
|---|---|---|---|
| id | id | Identificatiecode die een verkeersbord binnen zijn aanleverbron (bijvoorbeeld de HR groep) uniek identificeert | Integer 23 |
| ndw_id | ndwid | Identificatiecode die een verkeersbord binnen de NDW database uniek identificeert | UUID e0ace570-8eee-45ef-8083-f6139460c52a |
| type | type | Gebeurtenistype dat het type wijziging op de verkeersbordgegevens aangeeft | Type-veld, mogelijke waardes: created, updated, deleted. Bij het actueel beeld is het het laatste event van dit bord dat verwerkt is |
| schema_version | schemaVersion | Versie-indicator van het gegevensschema dat op het event is toegepast | major.minor bv. 1.0 |
| validated | validated | Indicator of de gegevens al dan niet gevalideerd zijn | Alfanumeriek n, j |
| validated_on | validatedOn | Datum waarop de gegevens zijn gevalideerd | date 01/12/2020 |
| user_id | userId | Installateur-/onderhouder-ID | Integer 38 |
| organisation_id | organisationId | Installateur-/onderhouder-organisatie ID | Integer 143 |
| rvv_code | rvvCode | Alfanumeriek A1, A1(Zone), A2 |
|
| black_code | blackCode | Zwarte code van het RVV bord, bijvoorbeeld 50 bij snelheid Deze zit niet in de created event berichten die van de HR groep komen. Na ontvangst van berichten van de HR goep wordt dit separaat bepaald en als los event aangeboden |
Alfanumeriek 50, L |
| text_signs | textSigns | Tekst van borden onder het verkeersbord | Array met alfanumerieke waardes [“300m”, “8-19h”] |
| location.wgs84.latitude | latitude | Float 52.279 |
|
| location.wgs84.longitude | longitude | Float 4.77898 |
|
| location.rd.x | x | Float 113493 |
|
| location.rd.y | y | Float 476951 |
|
| location.placement | placement | Aan de kant van de weg (L) of boven de weg (B) | Alfanumeriek L, B |
| location.side | side | Links of rechts indien van toepassing voor het weggedeelte, anders het kompas van het verkeersbord | Alfanumeriek L, R, N Z, O, W |
| location.road.name | roadname | Alfanumeriek Waterwolftunnel |
|
| location.road.type | roadtype | Alfanumeriek 1 (A-wegen) or 2 (N-wegen) |
|
| location.road.number | roadnumber | Integer 201 |
|
| location.road.wvk_id | wvk_id | NWB Wegvak ID (dit kan ontbreken) | Integer 226354035 |
| location.county.name | countyname | Gemeentenaam | Alfanumeriek Heerlen |
| location.county.code | countycode | CBS gemeente code | Alfanumeriek GM0358 |
| location.county.townname | townname | Woonplaatsnaam | Alfanumeriek Hoensbroek |
| details.image | image | Link naar de afbeelding van het verkeersbord | Alfanumeriek https://... |
| details.first_seen | firstseen | Eerste keer dat het verkeersbord gezien is | date 02/01/2020 |
| details.last_seen | lastseen | Laatste keer dat het verkeersbord gezien is, tot nu toe | date 03/01/2020 |
| details.removed | removed | Datum dat het verkeersbord niet meer in de datastroom zit | date 01/01/2020 |
| status | Actuele status van het verkeersbord in de NDW database. | PLANNED, PLACED, REMOVED Dit veld is alleen aanwezig in de events Json, niet in het actueel beeld. |
|
| publication_timestamp | publicationTimestamp | Datum dat de laatste update bij NDW in de database is aangebracht | datetime: 2020-04-27t12:34:56.123z |
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.
Per versie 2.0 van de API zijn er meer bronnen voor events:
- De HR groep events, die in principe een volledig verkeersbord beschrijven en zoals ze ontvangen worden ook doorgeleverd worden. Bij een update ontvangen we weer het volledige bord.
- Events die bij NDW ontstaan. Per december 2022 zijn dat events van toegevoegde zwarte codes.
Zodra er door wegbeheerders verkeersborden kunnen worden opgevoerd, verwijderd of gemuteerd zullen ook hier events uit ontstaan. Deze events bevatten alleen een HR bord id als het een mutatie op een eerder door de HR geleverd bord is. De events uit mutatieacties door wegbeheerders worden gevuld met alle informatie die bij NDW van een verkeersbord bekend is.
HTTP methode
GET
URL
https://data.ndw.nu/api/rest/static-road-data/traffic-signs/v2/events
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 |
| town-code | 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://data.ndw.nu/api/rest/static-road-data/traffic-signs/v2/events - dit zal de standaard queryparameterwaarden gebruiken
GET https://data.ndw.nu/api/rest/static-road-data/traffic-signs/v2/events?offset=2022-04-27T12:34:56.123Z&limit=100&town-code=GM0321 - dit retourneert de eerste 100 events vanaf 27 april 2022 half een ‘s middags in gemeente 0321
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
- town-code 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 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.
HTTP methode
GET
URL
https://data.ndw.nu/api/rest/static-road-data/traffic-signs/v2/current-state
Query parameters
| Veldnaam | Beschrijving |
|---|---|
| town-code | 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 |
| 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 |
| 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. 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
GET https://data.ndw.nu/api/rest/static-road-data/traffic-signs/v2/current-state
Dit zal de standaard query parameterwaarden gebruiken
GET https://data.ndw.nu/api/rest/static-road-data/traffic-signs/v2/current-state?rvv-code=A1&town-code=GM0321
Levert het actueel beeld van A1 verkeersborden in gemeente 0321 in JSON formaat
GET https://data.ndw.nu/api/rest/static-road-data/traffic-signs/v2/current-state?rvv-code=A1&road-section-ids=600449860,279300060&
content-type=csv
Levert het actueel beeld van A1 verkeersborden op de wegvakken uit de wegvakkenlijst in CSV formaat
GET https://data.ndw.nu/api/rest/static-road-data/traffic-signs/v2/current-state?rvv-code=A1&town-code=GM0321--header'Accept:text/csv'
Zet de Accept header om de response als CSV formaat terug te krijgen
GET https://data.ndw.nu/api/rest/static-road-data/traffic-signs/v2/current-state?rvv-code=A1&town-code=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:
- town-code 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.