Oppdrag Utenlandske Virksomheter API leverer data fra oppdragsregister for en organisasjon.

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:oppdragutenlandskevirksomheter

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: Oppdrag utenlandske virksomheter API.

Grensesnittbeskrivelse

URL har følgede oppbygging:

GET https://<env>/api/oppdrag/v1/<rettighetspakke>/utenlandskevirksomheter/<organisasjonsnummer>/oppdrag/antall
  • <env>: Miljø-spesifikk adresse
  • <rettighetspakke>: En rettighetspakke er en kode for virksomheten sitt juridiske grunnlag for datauthenting. For mer informasjon se Rettighetspakke
  • <organisasjonsnummer>: Organisasjonsnummeret man spør etter informasjon om.

Versjonering

Se generelle regler for versjonering.

Bruk med samtykke

For Datakonsumenter som benytter Samtykke gjelder en del tilleggskrav:

AltinnSamtykke header

Må legge ved en ekstra header AltinnSamtykke. Verdien i denne headeren skal være et Json Web Token (JWT) signert av Altinn. For informasjon rundt hvordan man skaffer et slikt token, sjekk Altinn: hente token

Begrenset til rettighetspakke ebevis

Datakonsumenter som henter data basert på samtykke tildeles rettighetspakken ebevis.

Eksempel på respons fra tjenesten

Her er et eksempel på en spørring med curl mot tjenesten. Du må ha et gyldig maskinportentoken og altinn samtykketoken som legges ved som headerer i curl-kommandoen.

$ curl -v -H "Authorization: Bearer <maskinporten_token>" -H "AltinnSamtykke: <samtykke_token>" "https://api-at.sits.no/api/innrapportert/inntektsmottaker/sbl/12345678901/oppgave/inntekt?fraOgMed=2016-11&tilOgMed=2017-01"

Open API spesifikasjon

Spesifikasjon for tjenesten kan lastes ned her Oppdrag_API_v0.5.yaml

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

{
      "forespurteOrganisasjon": "974761076",
      "oppdrag": {
            "antallAktiveOppdragSomArbeidsgiver": 44,
            "antallAktiveArbeidstakere": 64,
            "antallRegistrerteOppdragSomOppdragsgiver": 14
      },
      "levert": "2020-09-17T09:44:42.877055"
}

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": "OPPDRAGUTENLANDSKEVIRKSOMHETER-005",
      "melding": "Du er ikke autorisert for tilgang til den forespurte ressursen.",
      "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 vedvarene feil vennligst ta kontakt med brukerstøtte med applikasjon og korrelasjonsid fra feilmelding.

Feilkode HTTP Statuskode Feilområde
OPPDRAGUTENLANDSKEVIRKSOMHETER-001 500 Uventet feil på tjenesten.
OPPDRAGUTENLANDSKEVIRKSOMHETER-002 500 Uventet feil i et bakenforliggende system.
OPPDRAGUTENLANDSKEVIRKSOMHETER-003 404 Ukjent url benyttet.
OPPDRAGUTENLANDSKEVIRKSOMHETER-004 401 Feil i forbindelse med autentisering.
OPPDRAGUTENLANDSKEVIRKSOMHETER-005 403 Feil i forbindelse med autorisering.
OPPDRAGUTENLANDSKEVIRKSOMHETER-006 400 Feil i forbindelse med validering av inputdata.
OPPDRAGUTENLANDSKEVIRKSOMHETER-007 403 Feil i forbindelse med samtykke.
OPPDRAGUTENLANDSKEVIRKSOMHETER-008 404 Ingen restanser funnet på oppgitt organisasjonsnummer.
OPPDRAGUTENLANDSKEVIRKSOMHETER-009 406 Feil tilknyttet dataformat. Kun json eller xml er støttet.
Tags: