Gå til hovedinnhold

API Referanse

OpenAPI​

NVDB Fiksvegdata 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.

Registrer ny feilmelding​

Registering av ny feilmelding kan gjøres gjennom to endepunkter. Vi skiller mellom om du kan registere som anynom, eller at du identifiserer deg. Ved å identifisere deg så får du notifikasjoner under behandling av feilen din.

Mønster​

POST /api/v1/issues
Eksempel​
curl -X 'POST' \
  'https://fiksvegdata-api.atlas.vegvesen.no/api/v1/issues' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "subject": "Feil hastighet",
  "details": "Før svingen i krysset så viser det på kartet at det er 50km/t, men i virkeligheten er det 40km/t",
  "category": "MAP_ERROR",
  "location": {
    "northing": 652249.7055179164,
    "easting": 7736611.665507114,
    "municipalityNumber": 3002
  },
  "feature": {
    "nvdbId": 729541036,
    "version": 4
  },
  "roadSystemReference": "EV16 K S11D1 m1555"
}'

Hent feilmelding​

Lesing av feilmeldinger er åpent for alle. Derimot så blir innholdet som blir returnert tilgangsbegrenset. Vi operer hovedsaklig med to roller fixvgdat=saksbehandler og fixvgdat=administrator. For vedkommende som er anonym eller er autentisert så vil de få begrenset med innhold.

Mønster​

GET /api/v1/issues/64600627-8441-1a6d-8184-417d11c20000
Eksempel vanlig bruker​
{
  "id": "64600627-8441-1a6d-8184-417d11c20000",
  "submitter": null,
  "createdDate": "2022-11-04T07:13:46.422+00:00",
  "subject": "Feil emne",
  "details": "Dette er en feil",
  "category": "MAP_ERROR",
  "status": "NEW",
  "roadSystemReference": "EV6 S204D300 m673",
  "mapAuthorityReference": null,
  "feature": null,
  "isSubscribing": false,
  "location": {
    "municipality": "Alta",
    "county": "Troms og Finnmark",
    "northing": 7782663.3,
    "easting": 814092.6
  },
  "comments": [],
  "attachments": ["mitt-bilde.png"],
  "isMyIssue": false
}
Eksempel saksbehandler​
{
  "id": "64600627-8441-1a6d-8184-417d11c20000",
  "submitter": "Olanor",
  "createdDate": "2022-11-04T07:13:46.422+00:00",
  "subject": "Feil emne",
  "details": "dette er en feil i alta",
  "category": "MAP_ERROR",
  "status": "NEW",
  "roadSystemReference": "EV6 S204D300 m673",
  "mapAuthorityReference": 123456,
  "feature": null,
  "isSubscribing": false,
  "location": {
    "municipality": "Alta",
    "county": "Troms og Finnmark",
    "northing": 7782663.3,
    "easting": 814092.6
  },
  "comments": [
    {
      "id": "64600b2d-8458-1634-8184-5c1fc00e0000",
      "content": "Dette er en kommentar",
      "createdBy": "Petter Pan",
      "internal": false
    }
  ],
  "attachments": ["mitt-bilde.png"],
  "isMyIssue": false
}

Som vi kan se så vil saksbehandlere se mer informasjon enn en uathorisert bruker.

Laste opp vedlegg​

Det er mulig å knytte en eller flere filer til en sak. Etter opprettelse av en

Mønster​

POST /api/v1/issues/64600627-8441-1a6d-8184-417d11c20000/files/attach

Hent mine feilmeldinger​

Hvis du sender inn en eller flere feilmeldinger hvor du autentiserer deg så vil de knyttes til deg som bruker. Det tillater deg også å hente bare dine saker.

Mønster​

GET /api/v1/me/issues
Eksempel​
{
  "issues": [
    {
      "id": "64601c53-83bb-1f27-8183-bbe2cdd80000",
      "createdDate": "2022-10-09T08:35:46.766+00:00",
      "subject": "min feil",
      "category": "MAP_ERROR",
      "status": "REJECTED",
      "location": {
        "municipality": "Molde",
        "county": "Møre og Romsdal",
        "northing": 6980466.1,
        "easting": 99764.423
      }
    }
  ]
}

Annet​

Det finnes også mye mer knyttet til APIet, som for eksempel ansvarsfordeling og behandling av feilmeldinger. Full oversikt finnes på OpenAPI spesifikasjonen.