API-dokumentasjon

Oppdatert API-dokumentasjon for versjon 3

Bruk heller dokumentasjon for versjon 3 av NVDB api https://nvdbapiles-v3.atlas.vegvesen.no/dokumentasjon

De sidene du besøker akkurat kan fungere godt for å få et overblikk over NVDB datamodell, men er utdatert på en del tekniske detaljer.

Gammel dokumentasjon - Hent vegobjekter

GET https://nvdbapiles-v2.atlas.vegvesen.no/vegobjekter

[
    {
        "navn": "Skjerm",
        "href": "https://www.utv.vegvesen.no/nvdb/api/v2/vegobjekter/3"
    },
    {
        "navn": "Rekkverk",
        "href": "https://www.utv.vegvesen.no/nvdb/api/v2/vegobjekter/5"
    },
    {
        "navn": "Gjerde",
        "href": "https://www.utv.vegvesen.no/nvdb/api/v2/vegobjekter/7"
    },
    ...
]

Hent vegobjekter av en gitt vegobjekttype

GET https://nvdbapiles-v2.atlas.vegvesen.no/vegobjekter/<vegobjekttype.id>/

Et kall mot tjenesten returnerer en liste av vegobjekter. vegobjekttype.id tilsvarer vegobjekttypens unike id i datakatalogen.

Det er kun mulig å spørre etter vegobjekter av én type i samme spørring.

Velg respons

Bruk parametere til å angi hvilke informasjonselementer responsen skal inneholde.

Navn Verdi Beskrivelse
inkluder
  • metadata
  • egenskaper
  • relasjoner
  • lokasjon
  • vegsegmenter
  • geometri
  • alle
  • minimum
 En kommaseparert liste over hvilke informasjonselementer som skal returneres i tillegg til vegobjektenes id.
srid srid Angir hvilket geografisk referansesystem geometrien skal returneres i. Default: 32633
geometritoleranse
  • 10
  • 20
  • 30
 Angir om det skal returneres en forenklet geometri. Dersom parameteren utelates, returneres full geometri for vegobjektene. Nummeret angir distansetoleranse for generering av forenklet geometri. Default: full geometri Vær oppmerksom på at standardverdiene kan erstattes av mer egnede verdier uten at denne dokumentasjonen er helt oppdatert.
segmentering
  • true
  • false
 Angir om strekningsobjekter skal segmenteres etter søkeområdet. Advarsel: versjon 1 av APIet gav utelukkende ut usegmenterte objekter. Default: true
inkludergeometri
  • egenskap
  • utledet
  • lokasjon
  • ingen
 Når denne parameteren er fraværende vil hvert vegobjekt ha opptil tre geometrier; under attributter, lokasjon og geometri-feltet direkte på objektet. Noen objekter kan ha veldig stor geometri, som gjør at responsen fra API-et blir veldig stor. Dersom man ikke har bruk for alle geometriene kan man bruke denne parameteren til å fjerne noen av dem. egenskap inkluderer objektets egengeometri under vegobjekt.egenskaper, om denne eksisterer. utledet inkluderer vegobjekt.geometri. lokasjon inkluderer geometri under vegobjekt.lokasjon. ingen medfører at ingen av geometriene er med i responsen. Dette parametret virker som et filter, så den geometri-egenskapen referert til må være inkludert med `inkluder`-parametret.

vegobjekt.geometri

Et vegobjekt har opptil to geometrier, egengeometri og stedfestet geometri. Egengeoemtrien er plassert under vegobjekt.egenskaper om den finnes, stedfestet geometri er plassert under vegobjekt.lokasjon.

I tillegg til de nevnte feltene på vegobjekt-responsen returneres også vegobjekt.geometri (dersom man har inkluder=geometri eller alle), slik at man alltid finner geometrien for vegobjektet ett sted. Dette feltet er egengeometri dersom objektet har det, hvis ikke har feltet stedfestet geometri. Ved hvilken av disse som er tilfelle finner man ut ved å se på vegobjekt.geometri.egengeometri.

Avgrens søkeresultatet

For å avgrense søkeresultatet, støttes følgende parametere:

Søkeparameter Beskrivelse
Områdefilter Angir hvilke områder og vegnett søket skal gjennomføres innenfor.
Egenskapsfilter Angir at resultatsettet kun skal inneholde vegobjekter med spesifiserte egenskapsverdier.
Overlappfilter Angir at vegobjektene skal overlappe med spesifiserte vegobjekttyper.
Paginering Angir hvor mange vegobjekter som skal returneres i hver spørring mot APIet.

Eksempel: Hent bomstasjoner

Som standard returneres en liste av vegobjekter. Vegobjektene er innkapslet i en konvolutt, som også inneholder metadata om spørringen. I de andre responseksemplene er konvolutten utelatt.

GET https://nvdbapiles-v2.atlas.vegvesen.no/vegobjekter/45?antall=10

{
    "vegobjekter": [
        {
            "id": 89204552,
            "href": "https://nvdbapiles-v2.atlas.vegvesen.no/45/89204552"
        },
        {
            "id": 291045342,
            "href": "https://nvdbapiles-v2.atlas.vegvesen.no/45/291045342"
        },
        ...
    ],
    "metadata": {
        "returnert": 10,
        "neste": {
            "start": "Nzk4MTM3Nzc=",
            "href": "https://nvdbapiles-v2.atlas.vegvesen.no/vegobjekter/45?antall=10&start=Nzk4MTM3Nzc="
        }
    }
}

Det er satt en grense for hvor mange vegobjekter som kan hentes i samme spørring. Les om paginering for å se hvordan alle vegobjekter hentes ved å bruke flere spørringer.

Eksempel: Hent bomstasjoner med metadata og egenskaper

GET https://nvdbapiles-v2.atlas.vegvesen.no/vegobjekter/45?inkluder=metadata,egenskaper

{
    "objekter": [
        {
            "id": 79632559,
            "href": "https://www.utv.vegvesen.no/nvdb/api/v2/vegobjekter/45/79632559",
            "metadata": {
                "type": {
                    "id": 45,
                    "navn": "Bomstasjon"
                },
                "versjon": 6,
                "startdato": "2015-11-19",
                "sist_modifisert": "2016-01-09 01:05:50"
            },
            "egenskaper": [
                {
                    "id": 9409,
                    "navn": "Tidsdifferensiert takst",
                    "datatype": 30,
                    "datatype_tekst": "FlerverdiAttributt, Tekst",
                    "verdi": "Nei",
                    "enum_id": 13256
                },
                {
                    "id": 9412,
                    "navn": "Timesregel",
                    "datatype": 30,
                    "datatype_tekst": "FlerverdiAttributt, Tekst",
                    "verdi": "Ja",
                    "enum_id": 13257
                },
                {
                    "id": 9413,
                    "navn": "Vedtatt til år",
                    "datatype": 2,
                    "datatype_tekst": "Tall",
                    "verdi": 2030
                },
                ...
            ]
        },
        ...
    ],
    "metadata": {

    }
}

Eksempel: Be om segmenterte data

Et vegobjekt kan strekke seg over over flere veger og områder. Som standard returneres segmenterte/avgrensede vegobjekter. Dette medfører at et søk etter fartsgrenser i Trondheim kommune, inneholder utelukkende deler av fartsgrensen som befinner seg i denne kommunen.

Dersom parameteren segmentering settes til false, returneres alle delene av vegobjektene. Inkludert deler som f.eks. strekker seg utenfor kommunen. Dette er den gamle oppførselen til API v1.

GET https://nvdbapiles-v2.atlas.vegvesen.no/vegobjekter/67?kommune=1421&segmentering=false&inkluder=lokasjon

APIet støtter segmentering på følgende felter:

Hent statistikk

GET https://nvdbapiles-v2.atlas.vegvesen.no/vegobjekter/<vegobjekttype_id>/statistikk/

Ved hjelp av de samme filterene som for selve søket får man statistikk angående resultatet ved en egen forespørsel.

Segmentering støttes også her og default oppførsel er påslått.

Følgende parametere støttes ikke på et statistikkall:

Eksempel: Antall og lengde for tunnelløp

GET https://nvdbapiles-v2.atlas.vegvesen.no/vegobjekter/67/statistikk/

{
    "antall": 1371,
    "strekningslengde": 1247690
}
Felt Beskrivelse
antall Angir hvor mange vegobjekter søket resulterte i.
strekningslengde Angir den totalt strekningslengden basert på disse objektenes stedfesting.

Hent et spesifikt vegobjekt

GET https://nvdbapiles-v2.atlas.vegvesen.no/vegobjekter/<vegobjekttype.id>/<vegobjekt.id>

Dersom du ikke vet hvilken vegobjekttype et vegobjekt er, kan du bruke hjelperesurssen nedenfor, som videresender deg til korrekt URL.

GET https://nvdbapiles-v2.atlas.vegvesen.no/vegobjekt?id=<vegobjektid>

Velg respons

Et kall mot tjenesten returnerer det ønskede objektet med alle informasjonsfelter. Hvilke informasjonselementer som inkluderes for objektet kan begrenses og responsen kan også inneholde en liste objekter dersom dybdeparameteren brukes.

Navn Verdi Beskrivelse
dybde
  • 1
  • 2
  • ...
  • n
  • full
 Parameteren brukes til å spesifisere antall slektsledd døtre man vil hente ut. Når denne parameteren angis vil responsen alltid inneholde en liste.
  • full Hent hele hierarkiet for dette objektet.
  • 1 Hent kun dette objektet.
  • n > 1 Henter n nivåer inntil bunnen av treet treffes.
Default: 1
inkluder
  • metadata
  • egenskaper
  • relasjoner
  • lokasjon
  • vegsegmenter
  • geometri
  • alle
 En kommaseparert liste over hvilke informasjonselementer som skal returneres i tillegg til vegobjektets id. Default: alle, bortsett fra vegsegmenter

Eksempel: Hent et spesifikt tunnelløp

GET https://nvdbapiles-v2.atlas.vegvesen.no/vegobjekter/67/89204552

{
    "id": 89204552,
    "href": "https://nvdbapiles-v2.atlas.vegvesen.no/vegobjekter/67/89204552",
    "metadata": {
        "type": {
            "id": 67,
            "navn": "Tunnelløp"
        },
        "versjon": 3,
        "startdato": "2014-01-17",
        "sist_modifisert": "2015-06-26 10:40:41"
    },
    "egenskaper": [
        {
            "id": 8356,
            "navn": "Åpningsår",
            "datatype": 2,
            "datatype_tekst": "Tall",
            "verdi": 1965
        },
        {
            "id": 1317,
            "navn": "Lengde",
            "datatype": 2,
            "datatype_tekst": "Tall",
            "verdi": 33,
            "enhet": {
                "id": 1,
                "navn": "Meter",
                "kortnavn": "m"
            }
        },
        {
            "id": 1130,
            "navn": "Type tunnelløp",
            "datatype": 30,
            "datatype_tekst": "FlerverdiAttributt, Tekst",
            "verdi": "Berg",
            "enum_id": 3386
        },
        ...
    ],
    "geometri": {
        "wkt": "LINESTRING Z (528704.0498 7478545.60938 20.23, 528697 7478542.09375 21.9, 528692.7002 7478540.29688 22, 528688.7002 7478538.5 22.1, 528684.90039 7478536.90625 22.1, 528681.2002 7478535.19922 22.2, 528674 7478532.28125 21)",
        "srid": 32633,
        "egengeometri": false
    },
    "lokasjon": {
        "kommuner": [
            1845
        ],
        "fylker": [
            18
        ],
        "regioner": [
            5
        ],
        "vegavdelinger": [
            18
        ],
        "kontraktsområder": [
            {
                "nummer": 5002,
                "navn": "5002 Salten 2014-2019"
            },
            {
                "nummer": 1806,
                "navn": "1806 BODØ 2015-2020"
            }
        ],
        "riksvegruter": [
            {
                "nummer": "8A",
                "navn": "RUTE8A",
                "periode": "2010-2019"
            },
            {
                "nummer": "8A",
                "navn": "RUTE8A",
                "periode": "2014-2023"
            }
        ],
        "vegreferanser": [
            {
                "fylke": 18,
                "kommune": 0,
                "kategori": "E",
                "status": "V",
                "nummer": 6,
                "hp": 23,
                "fra_meter": 17084,
                "til_meter": 17117,
                "kortform": "1800 Ev6 hp23 m17084-17117"
            }
        ],
        "stedfestinger": [
            {
                "veglenkeid": 885141,
                "fra_posisjon": 0.519944958676788,
                "til_posisjon": 0.523005143295034,
                "kortform": "0.519944958676788-0.523005143295034@885141",
                "retning": "MED"
            }
        ],
        "geometri": {
            "wkt": "LINESTRING Z (528704.0498 7478545.60938 20.23, 528697 7478542.09375 21.9, 528692.7002 7478540.29688 22, 528688.7002 7478538.5 22.1, 528684.90039 7478536.90625 22.1, 528681.2002 7478535.19922 22.2, 528674 7478532.28125 21)",
            "srid": 32633
        },
        "strekningslengde": 33
    },
    "relasjoner": {
        "foreldre": [
            {
                "type": {
                    "id": 581,
                    "navn": "Tunnel"
                },
                "vegobjekter": [
                    89204551
                ]
            }
        ],
        "barn": [
            {
                "type": {
                    "id": 89,
                    "navn": "Signalanlegg"
                },
                "vegobjekter": [
                    481662525
                ]
            },
            {
                "type": {
                    "id": 69,
                    "navn": "Tunnelportal"
                },
                "vegobjekter": [
                    272110916,
                    272110918
                ]
            },
            ...
        ]
    }
}

Det er mulig å spesifisere geometri-srid for dette endepunktet.

Hent egenskaper

GET https://nvdbapiles-v2.atlas.vegvesen.no/vegobjekter/581/79608124/egenskaper

[
    {
        "id": 8945,
        "navn": "Lengde, skiltet",
        "datatype": 2,
        "datatype_tekst": "Tall",
        "verdi": 120,
        "enhet": {
            "id": 1,
            "navn": "Meter",
            "kortnavn": "m"
        }
    },
    {
        "id": 8150,
        "navn": "Sum lengde alle løp",
        "datatype": 2,
        "datatype_tekst": "Tall",
        "verdi": 120,
        "enhet": {
            "id": 1,
            "navn": "Meter",
            "kortnavn": "m"
        }
    },
    {
        "id": 5225,
        "navn": "Navn",
        "datatype": 1,
        "datatype_tekst": "Tekst",
        "verdi": "Vikatunnelen"
    },
    ...
]

Hent en spesifikk egenskap

Det er også mulig å slå opp spesifikk egenskap direkte.

GET https://nvdbapiles-v2.atlas.vegvesen.no/vegobjekter/581/79608124/egenskaper/3947

{
    "id": 3947,
    "navn": "Antall parallelle hovedløp",
    "datatype": 31,
    "datatype_tekst": "Flerverdiattributt, Tall",
    "verdi": 1,
    "enum_id": 5011,
    "enhet": {
        "id": 12,
        "navn": "Stykker",
        "kortnavn": "stk"
    }
}

Hent endringer

Det er mulig å hente ut en liste over vegobjekter som er endret etter en gitt dato.

GET https://nvdbapiles-v2.atlas.vegvesen.no//vegobjekter/<vegobjekttype.id>/endringer

Parametere

Navn Verdi Beskrivelse
type endret slettet Ved å sette type kan du få enten en liste over endrede objekter (denne vil inkludere objektet i sin nyeste form) eller en liste med slettede objekter. I det siste tilfellet vil kun objektets id være tilgjengelig. Obligatorisk
etter Tid Her kan du styre tidsterskelen. Obligatorisk
antall Nummer Antall per respons

De objektene som returneres med type=endret er de som har sist_modifisert etter oppgitt dato. sist_modifisert blir beregnet ved lesing fra NVDB. Per oktober 2017 blir sist_modifisert av og til oppdatert selv om det ikke er synlige forskjeller mellom ny og gammel versjon. I fremtiden vil sist_modifisert kun oppdateres dersom det er forskjeller i det objektet som returneres i responsen.

Vær oppmerksom på at også dette endepunktet benytter paginering. I responsksemplene er konvolutten med metadata utelatt.

Områdefilter og egenskapsfilter er ikke støttet for dette endepunktet.

Eksempel for ?type=endret&etter=”2014-01-01”

[
    {
        "type": "ENDRET",
        "vegobjekt": {
            ...
        }
    }
]

Eksempel for ?type=slettet&etter=”2014-01-01 15:30”

[
    {
        "type": "SLETTET",
        "vegobjekt": 1235415
    }
]

Angivelse av tid

Tidsparameteren kan angis på flere måter:

"2015-05-27T05:00:00+02:00" ISO 8601-streng
"2015-05-27 05:00:00" Alias for "2015-05-27T05:00:00+02:00"
"2015-05-27 05:00" Alias for "2015-05-27T05:00:00+02:00"
"2015-05-27" Alias for "2015-05-27T00:00:00+02:00"