Omregistreringsavgift API

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

For å bruke grensesnittet kreves autentisering med X.509-sertifikat.

URL har følgede oppbygging:

GET https://<env>/api/omregistreringsavgift/v1/<rettighetspakke>/<kjennemerke>?omregistreringsdato=<omregDato>

• <env>: Miljø-spesifikk adresse
• <rettighetspakke>: En kode for virksomheten sitt juridiske grunnlag for datauthenting. Se Rettighetspakke
• <kjennemerke>: Kjennemerket på kjøretøyet avgiften gjelder for.
• <omregDato>: Dato avgiftsbeløpet gjelder for, default verdi er dagens dato. Skal være på ISO 8601 format åååå-mm-dd eller ååååmmdd

Versjonering

Se generelle regler for versjonering.

Eksempel på respons fra tjenesten

Her er et eksempel på et kall med curl mot tjenesten for å hente omregistreringsavgift. Du må legge sertifikat og nøkkel som parametre til curl-kommandoen.

$ curl -v --cert datakonsument.cer --key datakonsument.key "https://api-at.sits.no/api/omregistreringsavgift/v1/fnf/BA12345?omregistreringsdato=2020-01-01"

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.

XML

For svar på XML format, sett header Accept til application/xml:

$ curl -v --header "Accept: application/xml" --cert datakonsument.cer --key datakonsument.key "https://api-at.sits.no/api/omregistreringsavgift/v1/fnf/BA12345?omregistreringsdato=2020-01-01"

omregistreringsavgift.xsd

omregistreringsavgift.xml (eksempel)

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. Dersom feilmeldingen ikke er på dette formatet, kan det være forespørselen ikke har kommet fram til applikasjonen. Se den generelle informasjonen om statuskoder og feilmeldinger.

JSON

{
 "kode": "OMREGSAVGIFT-003",
 "melding": "Feil datoformat, dato må oppgis som YYYY-MM-DD eller YYYYMMDD.",
 "korrelasjonsid": "a9de0f31-ced5-4bb2-8175-f8002daf2ff2"
}

XML

Dersom Accept-header er satt til application/xml vil også eventuell feilmelding være i XML:

feil.xsd

feil_omregistreringsavgift_api.xml (eksempel)

Feilkoder

Se også felles feilkoder for alle applikasjonene.