Verkeersborden download API

API beschrijving

Deze API biedt services voor het ophalen van verkeersborden events

API versie

1.0.0

Request 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 offsetquery-parameters. 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 offset-parameter. 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.

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.

HTTP methode

GET

URL

https://data.ndw.nu/api/rest/static-road-data/traffic-signs/v1/events

Query parameters

Veldnaam Beschrijving Datatype

offset

Tijdstempel dat het publicatiemoment aangeeft opgehaald.
Deze bewerking omvat ook events met een overeenkomend publicication_timestamp.
Vereist: nee

Datetime:
formaat:
yyyy-MM-ddTHH:mm:ss.SSSZ
Voorbeeld:
2020-04-27T12:34:56.123Z
Standaardwaarde:
1970-01-01T00:00:00.000Z

limit

Maximumaantal geretourneerde verkeersborden (blokgrootte).
Moet tussen 1 en 100 zijn
Vereist: nee

Integer
Voorbeeld: 1
Standaardwaarde: 100

Voorbeelden

GET https://data.ndw.nu/api/rest/static-road-data/traffic-signs/v1/events?offset= 2020-04-27T12:34:56.123Z&limit=100

GET https://data.ndw.nu/api/rest/static-road-data/traffic-signs/v1/events - dit zal de standaard queryparameterwaarden gebruiken

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.

Veldnaam Beschrijving Datatype met voorbeeld

id

Identificatiecode die een verkeersbord uniek identificeert

Integer
23

type

Gebeurtenistype dat het type wijziging op de verkeersbordgegevens aangeeft

Type-veld, mogelijke waardes: created, updated, deleted

schema_version

Versie-indicator van het gegevensschema dat op het event is toegepast

<major>.<minor> bv. 1.0

publication_timestamp

Het moment waarop het verkeersborden event werd gepubliceerd in UTC (ISO8601)

Datetime:
2020-04-27T12:34:56.123Z

validated

Indicator of de gegevens al dan niet gevalideerd zijn

Alfanumeriek
n, j

validated_on

Datum waarop de gegevens zijn gevalideerd

Date
01/12/2020

user_id

Installateur-/onderhouder-ID

Integer
38

organisation_id

Installateur-/onderhouder-organisatie ID

Integer
143

rvv_code

Alfanumeriek
A1, A1(Zone), A2

text_signs

Tekst van borden onder het verkeersbord

Array met alfanumerieke waardes
[“300m”, “8-19h”]

location.wgs84.latitude

Float
52.279

location.wgs84.longitude

Float
4.77898

location.rd.x

Float
113493

location.rd.y

Float
476951

location.placement

Aan de kant van de weg (L) of boven de weg (B)

Alfanumeriek
L, B

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

Alfanumeriek
Waterwolftunnel

location.road.type

Alfanumeriek
1 (A-wegen) or 2 (N-wegen)

location.road.number

Integer
201

location.road.wvk_id

Wegvak ID

Integer
226354035

location.county.name

Alfanumeriek
Aalsmeer

location.county.code

Alfanumeriek
GM0358

location.county.townname

Alfanumeriek
Aalsmeer

details.image

Link naar de afbeelding van het verkeersbord

Alfanumeriek
https://...

details.first_seen

Eerste keer dat het verkeersbord gezien is

Date
02/01/2020

details.last_seen

Laatste keer dat het verkeersbord gezien is, tot nu toe

Date
03/01/2020

details.removed

Datum waarop het verkeersbord is verwijderd

Date
01/01/2020

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

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.