Feilhåndtering
APIet har som mål å feile så raskt som mulig for å assistere brukeren. I den grad det er mulig vil alle kall til endepunkter returnere en liste med beskrivende feilobjekter. Dette vil supplere HTTP-statuskoden.
[ {
"code" : 4013,
"message" : "Ukjent parameter: vegreferanse",
"help_url" : "https://nvdbapiles-v3.atlas.vegvesen.no/dokumentasjon/openapi/#/Vegobjekter"
} ]
HTTP-statuskoder
Følgende HTTP-statuskoder kan inntreffe:
HTTP Status | Feilkode | Beskrivelse |
---|---|---|
422 | 4000 | Noe er galt med brukerens input. |
415 | 4001 | Denne mediatypen er ikke støttet. |
422 | 4002 | Feil i spesifisering av heltallsverdi. |
422 | 4003 | Feil i spesifisering av heltallslisteverdi. |
422 | 4004 | Manglende obligatorisk felt. |
422 | 4005 | Feil i spesifisering av tekstverdi. |
422 | 4006 | Feil i spesifisering av tekstlisteverdi. |
422 | 4007 | Feil i spesifisering av datoverdi. |
422 | 4008 | Feil i spesifisering av boolsk verdi. |
422 | 4009 | Konflikterende feltverdier spesifisert. |
422 | 4010 | Feil i spesifisering av flyttallsverdi. |
422 | 4011 | Feil i spesifisering av flyttallistesverdi. |
404 | 4012 | Objekt ble ikke funnet. |
422 | 4013 | Ukjent felt spesifisert. |
422 | 4014 | Dette feltet kan kun forekomme én gang. |
404 | 4015 | Ingen søkeresultater funnet. |
410 | 4016 | Objektet ble ikke funnet, men ser ut til å ha eksistert. |
403 | 4030 | Ikke tilgang. |
429 | 4290 | Antallet forspørsler fra samme IP-adresse har oversteget maksimalt antall forespørsler for en tidsenhet. |
500 | 5000 | Uventet feil har oppstått. |
500 | 5001 | Feil med kommunikasjon med databaser. |
500 | 5002 | Typeregisteret mangler. |
503 | 5003 | Behandling av forspørsel tok for lang tid. |
I tillegg vil feilresponser ha header X-REQUEST-ID som du kan bruke om du kontakter oss om feilen, slik at det er lettere å hjelpe deg.
Feilmeldinger
Responser med HTTP-statuskodene over har som regel en payload med én eller flere beskrivende feilmeldinger, f.eks.:
<errors>
<error>
<code>4000</code>
<message>Syntaksfeil i avansert spørring.</message>
<message_detailed>Kurvatur, stigning (825) has no attribute with id 9316 in expression: 9316>2</message_detailed>
<help_url>https://nvdbapiles-v3.atlas.vegvesen.no/dokumentasjon/#avansertefilter</help_url>
</error>
</errors>
Tekstene i <message>
-elementene vil normalt være på norsk. Detaljert beskrivelse kommer med en nærmere
beskrivelse på hva det var som fikk det til å feile. Det kommer også med en help_url
til dokumentasjon som
skal hjelpe til med å rette problemet.