Arbeidsforhold API

Sikkerhet

Denne tjenesten støtter både bruk av maskinporten og virksomhetssertifikat. Se Sikkerhetsmekanismer for informasjon om de ulike sikkerhetsløsningene.

Bruk med Maskinporten

Følgende scope skal benyttes ved autentisering i Maskinporten: skatteetaten:arbeidsforhold

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: Arbeidsforhold API.

Grensesnittbeskrivelse

URL-en har følgede oppbygging:

GET https://<env>/api/arbeidsforhold/v1/arbeidsgiver/<organisasjonsnummer>/arbeidstaker/<foedselsnummer>/aktiv

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

Open Api Specification

Teknisk spesifikasjon av API’et er publisert på SwaggerHub: Arbeidsforhold API v1.0

Versjonering

Se Om versjonering for generelle regler for versjonering.

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 -k https://api-at.sits.no/api/arbeidsforhold/v1/arbeidsgiver/877353192/arbeidstaker/09099617966/aktiv --key nøkkel.key --cert sertifikat.cer -XGET -H 'accept: application/json'

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

{
  "svar": {"aktiv":"JA"}
}

XML

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

$ curl -v --header "Accept: application/xml" --cert datakonsument.cer --key datakonsument.key "https://api-at.sits.no/api/arbeidsforhold/v1/arbeidsgiver/877353192/arbeidstaker/09099617966/aktiv"

<?xml version='1.0' encoding='UTF-8'?>
<svar>
    <aktiv>JA</aktiv>
</svar>

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": "ARBEIDSFORHOLD-003",
 "melding": "Fant ingen aktivt arbeidsforhold mellom angitt arbeidstaker og angitt arbeidsgiver",
 "korrelasjonsid": "23a235f5-28f9-47db-9abd-ab78977c32fa"
}

XML

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

<feil xmlns="urn:no:skatteetaten:datasamarbeid:feil:v1">
   <kode>ARBEIDSFORHOLD-003</kode>
   <melding>Fant ingen aktivt arbeidsforhold mellom angitt arbeidstaker og angitt arbeidsgiver</melding>
   <korrelasjonsid>a621a996-315d-4b8a-ac6c-6239e67f03e7</korrelasjonsid>
</feil>

feil.xsd

feil.xml (eksempel)

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.