Sikkerhet
Denne tjenesten støtter kun bruk av maskinporten. Se Sikkerhetsmekanismer for informasjon om de ulike sikkerhetsløsningene.
Bruk med Maskinporten
Følgende scope skal benyttes ved autentisering i Maskinporten:
skatteetaten:omregistreringsavgift
Delegering
Tilgang til denne tjenesten kan delegeres i Altinn, f.eks. dersom leverandør benyttes for den tekniske oppkoblingen. Søk opp følgende tjeneste i Altinn for å delegere tilgangen: Omregistreringsavgift API.
Grensesnittbeskrivelse
URL har følgede oppbygging:
GET https://{env}/api/omregistreringsavgift/v1/{rettighetspakke}/{kjennemerke}?omregistreringsdato={omregDato}
env
: Miljø-spesifikk adresserettighetspakke
: Rettighetspakkenfnf
er eneste rettighetspakken for denne tjenesten.kjennemerke
: Kjennemerket på kjøretøyet avgiften gjelder for.omregDato
: Dato avgiftsbeløpet gjelder for. Skal være på ISO 8601 format åååå-mm-dd eller ååååmmdd. Feltet er ikke påkrevd og benytter dagens dato som default verdi.
Open Api Specification
Teknisk spesifikasjon av API’et er publisert på SwaggerHub: Omregistreringsavgift API
Versjonering
Se generelle regler for versjonering.
Eksempel på respons fra tjenesten
Suksess (HTTP status 200)
Dersom kallet lykkes får man HTTP status 200 og data i JSON eller XML format. Dersom man ikke spesifiserer ønsket format får man JSON.
JSON
{
"omregistreringsavgift": 3982,
"kjennemerke": "YQ96449",
"datoOmregistreringsavgift": "2021-05-16"
}
XML
Dersom man ønsker XML i stedet for JSON kan dette spesifiseres med header Accept
satt til application/xml
:
<gjeldendeOmregistreringsavgift xmlns="urn:no:skatteetaten:fastsetting:motorvogn:omregistreringsavgift:gjeldende:v1">
<omregistreringsavgift>3982</omregistreringsavgift>
<kjennemerke>YQ96449</kjennemerke>
<datoOmregistreringsavgift>2021-05-16</datoOmregistreringsavgift>
</gjeldendeOmregistreringsavgift>
Feilmeldinger (HTTP status ikke 200)
Hvis statuskode ikke er 200, men man får svar fra applikasjonen, så kommer en feilmelding på følgende format. I enkelte tilfeller kan forespørsler stoppes i infrastrukturen før den når applikasjonen. I disse tilfellene kan det forekomme feilmeldinger som ikke følger formatet oppgitt ovenfor.
JSON
{
"kode": "OMREGSAVGIFT-002",
"melding": "Uventet feil i bakenforliggende applikasjon, prøv igjen senere.",
"korrelasjonsid": "456420a2-6689-4cda-8102-8be499a892dd"
}
Feilkoder
Tabellen under viser en oversikt over hvilke typer feil applikasjonen kan gi. Feilmeldingen vil kunne variere selv om samme feilkode returneres. Dette er for å kunne gi en så presis beskrivelse av feilen som mulig. Ved vedvarende feil vennligst ta kontakt med brukerstøtte med applikasjon og korrelasjonsid fra feilmelding.
Feilkode | HTTP Statuskode | Feilområde |
---|---|---|
OMREGSAVGIFT-001 | 500 | Uventet feil på tjenesten. |
OMREGSAVGIFT-002 | 500 | Uventet feil i et bakenforliggende system. |
OMREGSAVGIFT-003 | 404 | Ukjent url benyttet. |
OMREGSAVGIFT-004 | 401 | Feil i forbindelse med autentisering. |
OMREGSAVGIFT-005 | 403 | Feil i forbindelse med autorisering. |
OMREGSAVGIFT-006 | 400 | Feil i forbindelse med validering av inputdata. |
OMREGSAVGIFT-007 | 404 | Omregistreringsavgift ikke funnet. Kjennemerke er ukjent eller oppgitt dato er utenfor definerte avgiftssatser. |
OMREGSAVGIFT-008 | 406 | Feil tilknyttet dataformat. Kun json eller xml er støttet. |