Boligsparing for ungdom 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:boligsparingforungdom

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: Boligsparing for ungdom API.

Grensesnittbeskrivelse

URL-en har følgede oppbygging:

GET https://{env}/api/innrapportert/boligsparingforungdom/{inntektsaar}/{personidentifikator}

• env: Miljø-spesifikk adresse
• inntektsaar: Inntektsåret man spør om informasjon for, i formatet YYYY.
• personidentifikator: Hvilket fødselsnummer eller D-nummer man spør om informasjon for.

Open Api Specification

Teknisk spesifikasjon av API’et er publisert på SwaggerHub: Boligsparing for ungdom API

Versjonering

Se Om versjonering for 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

{
  "personidentifikator": "12345678901",
  "inntektsaar": "2019",
  "aaretsRenter": 100.00
}

XML

Dersom man ønsker XML i stedet for JSON kan dette spesifiseres med header Accept satt til application/xml:

<?xml version='1.0' encoding='UTF-8'?>
<boligsparingForUngdom xmlns="no:skatteetaten:datasamarbeid:boligsparingforungdom:v1">
   <personidentifikator>25120800194</personidentifikator>
   <inntektsaar>2015</inntektsaar>
   <aaretsRenter>534.00</aaretsRenter>
</boligsparingForUngdom>

Feilmeldinger (HTTP status ikke 200)

Hvis statuskode ikke er 200 eller 201, 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 nedenfor.

JSON

{
  "kode": "BSU-005",
  "melding": "Du er ikke autorisert for bruk av dette endepunktet.",
  "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.