Støttetjeneste - Tilgjengeligdata API

Grensesnittbeskrivelse

Se Sikkerhetsmekanismer for informasjon om hva som kreves for å få tilgang til grensesnittet.

Grensesnittet nås på :

GET https://<env>/api/skatt/tilgjengeligdata/<personidentifikator>/<ressursid>

• <env>: Miljø-spesifikk adresse
• <personidentifikator>: Hvilket fødselsnummer eller D-nummer man spør om informasjon for.

Gyldige ressursidentifikatorer

Du må spesifisere en ressursid for å få svar fra tjenesten. Under er en liste over ressurser tjenesten støtter for øyeblikket.

• skattegrunnlag
• skatteoppgjoer

Du kan bruke hvilken av ressursidene man ønsker. Tjenestene vil returnere den samme responsen uavhengig av valg av ressursid.

Versjonering

Se Om versjonering for generelle regler for versjonering.

Semantikk for versjonering vil bli slik (hvis et behov dukker opp og versjonering etableres):

Eksempel på respons fra tjenesten

Her er et eksempel på en spørring med curl mot tjenesten. 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/skatt/tilgjengeligdata/12345678901/skattegrunnlag

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": "05014300122",
  "ressursId": "skattegrunnlag",
  "sisteTilgjengeligePeriode": "2019"
}

Data kommer som ett tilgjengeligdata-objekt.

Hvert Tilgjengeligdata-object inneholder

• personidentifikator - typisk Fødselsnummer eller D-nummer
• ressursid - id på typen data, f.eks “skattegrunnlag”
• siste tilgjengelige periode - beskriver sist tilgjengelige periode for ressursen. Har forskjellig format basert på ressursen. F.eks. kun årstall for skattegrunnlag.

XML

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

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": "TD-011",
  "melding": "Parameter 'personidentifikator' har ugyldig format. Må være nøyaktig 11 siffer"
}

XML

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

feil.xsd

feil eksempel.xml

Feilkoder

Se også felles feilkoder for alle applikasjonene.