Gå til hovedinnhold

API-referanse

OpenAPI​

NVDB Stesfesting tilbyr en OpenAPI - Spesifikasjon som alltid vil være oppdatert og i henhold til eksisterende funksjonalitet som er tilknyttet versjonen til tjenesten. Dette betyr at vi anbefaler utviklere å benytte verktøy som generer klientkoden for deg. Viser til verktøy som Orval eller OpenAPI-Generator for å gjøre integrasjon enklere.

Miljøer​

NVDB Stedfesting er tilgjengelig i tre ulike miljøer hos Statens vegvesen:

MiljøFormålBasis-URL
UTVUtviklinghttps://nvdbstedfesting.utv.atlas.vegvesen.no/
ATMAkseptansetestinghttps://nvdbstedfesting.test.atlas.vegvesen.no/
PRODProduksjonhttps://nvdbstedfesting.atlas.vegvesen.no/

Stedfest​

Dette kommando-endepunktet beregner gyldig stedfesting for vegobjekter med geometriegenskap(er). Responsen kan brukes direkte på de samme vegobjektene i et endringssett.

Dersom requesten ikke angir relevante veger (vegkategori, vegfase og vegnummer) for stedfestingen, beregnes stedfestingen til nærmeste vegnett med vegkategori E, R, F eller K.

Dersom requesten ikke angir parametere for sidepososisjon, kjørefelt, konnekteringslenker og beholde trafikantgruppe vil disse settes automatisk til false.

Dette endepunktet gir synkron respons. Responstiden er korrelert med antall vegobjekter i payloaden.

Mønster​

POST /api/v1/stedfest
Eksempel​
curl -X 'POST' \
  'https://nvdbstedfesting.utv.atlas.vegvesen.no/api/v1/stedfest' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "parametere": {
    "maksimalAvstandTilVeg": 10,
    "veger": [
      {
        "kategori": "K",
        "fase": "V",
        "nummer": 4900
      }
    ],
    "typeVeger": [
      "ENKEL_BILVEG"
    ],
    "beregnSideposisjon": false,
    "beregnKjørefelt": true,
    "konnekteringslenker": false,
    "beholdTrafikantgruppe": false,
    "forankring": {
      "srid": 5973,
      "startWkt": "POINT (270301.2328106925 7042034.742957044)"
    },
    "trafikantgruppe": "K"
  },
  "vegobjekter": [
    {
      "typeId": 95,
      "tempId": "skiltpunkt#1",
      "gyldighetsperiode": {
        "startdato": "2022-06-28",
        "sluttdato": "2022-10-30"
      },
      "geometri": {
        "srid": 5973,
        "wkt": "POINT (270301.2328106925 7042034.742957044)"
      }
    }
  ]
}

Resultat​

Uavhengig av om vegobjektene lot seg stedfeste eller ikke, vil HTTP-statuskode alltid være 200 OK.

Eksempel - Vellykket stedfesting​
{
  "vegobjekter": [
    {
      "tempId": "skiltpunkt#1",
      "stedfesting": {
        "oversikt": {
          "lengde": 0
        },
        "punkt": [
          {
            "nvdbId": 42122,
            "posisjon": 0.70913284,
            "retning": "MED",
            "sideposisjon": null,
            "kjørefelt": ["1", "2"],
            "geometri": {
              "srid": 5973,
              "wkt": "POINT (270299.915 7042034.534)"
            },
            "veg": {
              "kategori": "K",
              "fase": "V",
              "nummer": 4900
            }
          }
        ],
        "linje": []
      },
      "feil": [],
      "advarsler": [],
      "notabener": []
    }
  ]
}
Eksempel - Valideringsfeil​
{
  "vegobjekter": [
    {
      "tempId": "fartsgrense#1",
      "stedfesting": null,
      "feil": [
        {
          "melding": "Vegobjektet er av type 105, og kan ikke stedfestes med utstrekningstype POINT",
          "kode": "UGYLDIG_GEOMETRI"
        },
        {
          "melding": "Kan ikke beregne strekningsstedfesting med bare ett ankerpunkt",
          "kode": "STEDFESTING_MISLYKTES"
        }
      ],
      "advarsler": [],
      "notabener": []
    }
  ]
}

Posisjon​

Dette endepunktet henter veglenkesekvensen med vegsystemreferanse for det angitte punktet som blir sendt inn. Avhengig av hvilket koordinatsystem du benytter så tillater vi spørringer med (Breddegrad og Lengdegrad) eller (Nord og Øst). Samtidig kan du legge ved styringsparametere som maks avstand til veg eller tidspunkt for å nevne noen. Referer til OpenAPI-spesifkasjonen for full oversikt over alternativer.

Mønster​

GET api/v1/posisjon?nord=7030867.505&øst=267530.62885699776

Eksempel vellykket​

{
  "vegsystemreferanse": {
    "vegsystem": {
      "id": 1014035347,
      "versjon": 1,
      "vegkategori": "P",
      "fase": "V",
      "nummer": 99978
    },
    "kortform": "PV99978 S1D1 m106"
  },
  "veglenkesekvens": {
    "veglenkesekvensid": 3349650,
    "relativPosisjon": 0.89207261,
    "kortform": "0.89207261@3349650"
  },
  "geometri": {
    "srid": 5973,
    "wkt": "POINT Z(267529.091 7030868.535 137.899)"
  },
  "avstand": 1.85,
  "kommune": 5001
}

Eksempel feil koordinater​

{
  "success": false,
  "message": "Fant ingen veglenkesekvenser i nærheten av søkepunkt: 267530.62885699776, 2.2030867505E7. Det er for lang avstand til nærmeste veg."
}

Rute​

Dette endepunktet henter en sammenhengede rute av veglenkesekvenser med vegsystemreferanse mellom de angitte punktetene som blir sendt inn. Samtidig kan du legge ved styringsparametere som maks avstand til veg eller omkrets for å nevne noen. Referer til OpenAPI-spesifkasjonen for full oversikt over alternativer.

Mønster​

GET api/v1/rute?start=226761.786,6564469.3787&slutt=226855.034,6564472.225

Eksempel vellykket​

{
  "ruteSegmenter": [
    {
      "nvdbId": 1149047,
      "fra": 0,
      "til": 0.11286206,
      "retning": "MED",
      "sideposisjon": null,
      "kjørefelt": ["1"],
      "geometri": {
        "srid": 5973,
        "wkt": "LINESTRING (226780.857 6564471.365, 226761.738 6564470.088)"
      }
    },
    {
      "nvdbId": 1157086,
      "fra": 0,
      "til": 1,
      "retning": "MED",
      "sideposisjon": null,
      "kjørefelt": ["1"],
      "geometri": {
        "srid": 5973,
        "wkt": "LINESTRING (226818.136 6564473.808, 226811.28 6564473.48, 226808.99 6564473.26, 226793.25 6564472.26, 226780.857 6564471.365)"
      }
    },
    {
      "nvdbId": 1149046,
      "fra": 0.84714012,
      "til": 1,
      "retning": "MED",
      "sideposisjon": null,
      "kjørefelt": ["2"],
      "geometri": {
        "srid": 5973,
        "wkt": "LINESTRING (226854.977 6564475.157, 226831.9 6564474.7, 226818.136 6564473.808)"
      }
    }
  ]
}

Eksempel feil koordinater​

{
  "success": false,
  "message": "Fant ingen rute med de gitte parameterne"
}