Link Search Menu Expand Document

API

API utviklet for å gi maskinell tilgang til informasjon i AA-registeret.

  1. Hvordan bruke APIet
    1. Hvordan få tilgang
    2. Testdata
    3. Skjema
    4. Tjenester
      1. Ping og helsesjekk
      2. Arbeidsforhold
        1. Eksempel #4
    5. Korrelasjon-id’er
      1. Forespørsel
      2. Arbeidsforhold
    6. Feilmeldinger
      1. Feilkoder og forklaring
      2. Eksempler (feilmeldinger)

Hvordan bruke APIet

APIet er tilgjengelig via NAV sin API-portal:

NAV API Portal - Prod

Testmiljø med syntetiske data (“preprod”) er også tilgjengelig:

NAV API Portal - Preprod

MERK: preprod er et test- og utviklingsmiljø og det kan forekomme nedetid eller ustabilitet.

Hvordan få tilgang

  1. Din virksomhet må søke om tilgang til Aa-registeret. Les mer om dette på nav.no sine sider.
  2. API-brukere (utviklere) må abonnere på Aareg sine tjenester i API-portalen. Les mer her.

Dette gir de nødvendige rettighetene til å

  1. opprette et gyldig Maskinporten-token (Authorization-headeren)
  2. opprette en gyldig API-nøkkel (Ocp-Apim-Subscription-Key-headeren).

Les mer om bruk av Maskinporten generelt her.

Hvis man skal bruke APIet på vegne av en annen virksomhet (delegert tilgang), må rettigheter innvilges i Altinn. Les mer om hvordan man gir tilgang via Altinn her.

Maskinporten-scope som brukes for dette APIet er: nav:aareg/v1/arbeidsforhold

Testdata

Opplysningspliktig Arbeidsgiver Arbeidstakere Beskrivelse
811010022 911010054 27025700991
02036101175
02035700369
06047100427
20085802152
11055600521
26036900821
19046501597
31036300992
27036901220
24036901647
27010100017
Ordinære og maritime arbeidsforhold

10 åpne og 1 avsluttet arbeidsforhold

1 arbeidstaker med adressesperre (27010100017)

Skjema

GraphQL-skjema er tilgengelig for nedlasting her.

Det kan også inspiseres ved bruk av Introspection.

MERK: Skjemaet er under arbeid, og det kan forekomme endringer.

Tjenester

Ping og helsesjekk

Send et kall med HttpMethod.OPTIONS og authorization til /graphql endepunket. Forventet resultat er HttpStatus.OK

Arbeidsforhold

Tjeneste for å hente en liste med arbeidsforholdsinformasjon for angitt arbeidstaker og/eller arbeidssted og/eller opplysningspliktig.

Spørring (komplett)

query($finnArbeidsforholdVariabler: FinnArbeidsforholdVariabler) {
    finnArbeidsforhold(finnArbeidsforholdVariabler: $finnArbeidsforholdVariabler) {
        arbeidsforhold {
            id
            type {
                kode
                beskrivelse
            }
            arbeidstaker {
                ident
            }
            arbeidssted {
                type
                ident
            }
            opplysningspliktig {
                type
                ident
            }
            ansettelsesperiode {
                startdato
                sluttdato
                sluttaarsak {
                    kode
                    beskrivelse
                }
                varsling {
                    kode
                    beskrivelse
                }
            }
            ansettelsesdetaljer {
                type
                arbeidstidsordning {
                    kode
                    beskrivelse
                }
                ansettelsesform {
                    kode
                    beskrivelse
                }
                yrke {
                    kode
                    beskrivelse
                }
                ... on MaritimAnsettelsesdetaljer {
                    fartsomraade {
                        kode
                        beskrivelse
                    }
                    skipsregister {
                        kode
                        beskrivelse
                    }
                    fartoeystype {
                        kode
                        beskrivelse
                    }
                }
                antallTimerPrUke
                avtaltStillingsprosent
                sisteStillingsprosentendring
                sisteLoennsendring
                rapporteringsmaaneder {
                    fra
                    til
                }
            }
            permisjoner {
                id
                type {
                    kode
                    beskrivelse
                }
                startdato
                sluttdato
                prosent
                varsling {
                    kode
                    beskrivelse
                }
            }
            permitteringer {
                id
                type {
                    kode
                    beskrivelse
                }
                startdato
                sluttdato
                prosent
                varsling {
                    kode
                    beskrivelse
                }
            }
            timerMedTimeloenn {
                antall
                startdato
                sluttdato
                rapporteringsmaaned
            }
            utenlandsopphold {
                land {
                    kode
                    beskrivelse
                }
                startdato
                sluttdato
                rapporteringsmaaned
            }
            idHistorikk {
                id
            }
            varsler {
                entitet
                varsling {
                    kode
                    beskrivelse
                }
            }
            rapporteringsordning {
                kode
                beskrivelse
            }
            uuid
            opprettet
            sistBekreftet
            sistEndret
        }
    }
}

MERK:

  • Minst 1 id må være angitt, dvs. arbeidstakerId og/eller arbeidsstedId og/eller opplysningspliktigId
  • Det må oppgis minst 1 verdi for følgende filterparametere:
    • arbeidsforholdtype: [ordinaertArbeidsforhold, maritimtArbeidsforhold, frilanserOppdragstakerHonorarPersonerMm, forenkletOppgjoersordning]
    • rapporteringsordning: [A_ORDNINGEN, FOER_A_ORDNINGEN]
    • arbeidsforholdstatus: [AKTIV, FREMTIDIG, AVSLUTTET]
  • JSON støtter ikke en streng over flere linjer og query- må derfor ligge på 1 linje.

Eksempler (spørring)

Eksempel #1
  • Alle ordinære arbeidsforhold som er rapportert via A-Ordningen med alle dataelementer og arbeidsforholdstatuser for gitt arbeidstaker og arbeidssted og opplysningspliktig

Spørring:

{
  "query": "query($finnArbeidsforholdVariabler: FinnArbeidsforholdVariabler) { finnArbeidsforhold(finnArbeidsforholdVariabler: $finnArbeidsforholdVariabler) { arbeidsforhold { id uuid type { kode beskrivelse } arbeidstaker { ident } arbeidssted { type ident } opplysningspliktig { type ident } ansettelsesperiode { startdato sluttdato sluttaarsak { kode beskrivelse } varsling { kode beskrivelse } } ansettelsesdetaljer { type arbeidstidsordning { kode beskrivelse } ansettelsesform { kode beskrivelse } yrke { kode beskrivelse } ... on MaritimAnsettelsesdetaljer { fartsomraade { kode beskrivelse } skipsregister { kode beskrivelse } fartoeystype { kode beskrivelse } } antallTimerPrUke avtaltStillingsprosent sisteStillingsprosentendring sisteLoennsendring rapporteringsmaaneder { fra til } } permisjoner { id type { kode beskrivelse } startdato sluttdato prosent varsling { kode beskrivelse } } permitteringer { id type { kode beskrivelse } startdato sluttdato prosent varsling { kode beskrivelse } } timerMedTimeloenn { antall startdato sluttdato rapporteringsmaaned } utenlandsopphold { land { kode beskrivelse } startdato sluttdato rapporteringsmaaned } idHistorikk { id } varsler { entitet varsling { kode beskrivelse } } rapporteringsordning { kode beskrivelse } opprettet sistBekreftet sistEndret } } }",
  "variables": {
    "finnArbeidsforholdVariabler": {
      "opplysningspliktigId": "987654321",
      "arbeidsstedId": "876543210",
      "arbeidstakerId": "31120154321",
      "arbeidsforholdtype": [
        "ordinaertArbeidsforhold"
      ],
      "rapporteringsordning": [
        "A_ORDNINGEN"
      ],
      "arbeidsforholdstatus": [
        "AKTIV",
        "FREMTIDIG",
        "AVSLUTTET"
      ],
      "ansettelsesdetaljerhistorikk": false
    }
  }
}

Respons:

  • ordinært arbeidsforhold
  • ansettelsesperiode uten varsling
  • ansettelsesdetaljer (1)
  • permisjoner (0)
  • permitteringer (0)
  • timer-med-timelønn (0)
  • utenlandsopphold (0)
  • arbeidsforhold-id-historikk (0)
  • varsler (0)
{
  "data": {
    "finnArbeidsforhold": {
      "arbeidsforhold": [
        {
          "id": "ARBEIDSFORHOLD_ID",
          "type": {
            "kode": "ordinaertArbeidsforhold",
            "beskrivelse": "Ordinært arbeidsforhold"
          },
          "arbeidstaker": {
            "ident": "ARBEIDSTAKER_FNR"
          },
          "arbeidssted": {
            "type": "Underenhet",
            "ident": "UNDERENHET_ORG_NR"
          },
          "opplysningspliktig": {
            "type": "Hovedenhet",
            "ident": "HOVEDENHET_ORG_NR"
          },
          "ansettelsesperiode": {
            "startdato": "2019-03-01",
            "sluttdato": null,
            "sluttaarsak": null,
            "varsling": null
          },
          "ansettelsesdetaljer": [
            {
              "type": "Ordinaer",
              "arbeidstidsordning": {
                "kode": "ikkeSkift",
                "beskrivelse": "Ikke skift"
              },
              "ansettelsesform": null,
              "yrke": {
                "kode": "5221126",
                "beskrivelse": "BUTIKKMEDARBEIDER"
              },
              "antallTimerPrUke": 37.5,
              "avtaltStillingsprosent": 15.0,
              "sisteStillingsprosentendring": null,
              "sisteLoennsendring": "2019-03-01",
              "rapporteringsmaaneder": {
                "fra": "2019-04",
                "til": null
              }
            }
          ],
          "permisjoner": null,
          "permitteringer": null,
          "timerMedTimeloenn": null,
          "utenlandsopphold": null,
          "idHistorikk": null,
          "varsler": null,
          "rapporteringsordning": {
            "kode": "A_ORDNINGEN",
            "beskrivelse": "Rapportert via a-ordningen (2015-d.d.)"
          },
          "uuid": "37317576-979a-406b-9127-2c53b0111d1a",
          "opprettet": "2019-04-09T11:03:28.690",
          "sistBekreftet": "2019-04-09T11:03:28",
          "sistEndret": "2020-04-17T16:36:33"
        }
      ]
    }
  }
}
Eksempel #2
  • Alle aktive og avsluttede ordinære og maritime arbeidsforhold som er rapportert via A-Ordningen med startdato, sluttdato og evt. sluttårsak eller varsling for gitt arbeidstaker

Spørring:

{
  "query": "query($finnArbeidsforholdVariabler: FinnArbeidsforholdVariabler) { finnArbeidsforhold(finnArbeidsforholdVariabler: $finnArbeidsforholdVariabler) { arbeidsforhold { id uuid type { kode beskrivelse } arbeidssted { type ident } opplysningspliktig { type ident } ansettelsesperiode { startdato sluttdato sluttaarsak { kode beskrivelse } varsling { kode beskrivelse } } } } }",
  "variables": {
    "finnArbeidsforholdVariabler": {
      "arbeidstakerId": "31120154321",
      "arbeidsforholdtype": [
        "ordinaertArbeidsforhold",
        "maritimtArbeidsforhold"
      ],
      "rapporteringsordning": [
        "A_ORDNINGEN"
      ],
      "arbeidsforholdstatus": [
        "AKTIV",
        "AVSLUTTET"
      ],
      "ansettelsesdetaljerhistorikk": false
    }
  }
}

Respons:

  • ordinært arbeidsforhold
  • ansettelsesperiode med sluttårsak
  • ansettelsesdetaljer (2)
  • permisjoner (0)
  • permitteringer (0)
  • timer-med-timelønn (0)
  • utenlandsopphold (0)
  • arbeidsforhold-id-historikk (0)
  • varsler (0)
{
  "data": {
    "finnArbeidsforholdPrArbeidstaker": {
      "arbeidsforhold": [
        {
          "id": "ARBEIDSFORHOLD_ID",
          "type": {
            "kode": "ordinaertArbeidsforhold",
            "beskrivelse": "Ordinært arbeidsforhold"
          },
          "arbeidstaker": {
            "ident": "ARBEIDSTAKER_FNR"
          },
          "arbeidssted": {
            "type": "Underenhet",
            "ident": "UNDERENHET_ORG_NR"
          },
          "opplysningspliktig": {
            "type": "Hovedenhet",
            "ident": "HOVEDENHET_ORG_NR"
          },
          "ansettelsesperiode": {
            "startdato": "2019-03-14",
            "sluttdato": "2019-04-07",
            "sluttaarsak": {
              "kode": "arbeidstakerHarSagtOppSelv",
              "beskrivelse": "Fant ingen beskrivelse som var gyldig 01.09.2017"
            },
            "varsling": null
          },
          "ansettelsesdetaljer": [
            {
              "type": "Ordinaer",
              "arbeidstidsordning": {
                "kode": "ikkeSkift",
                "beskrivelse": "Ikke skift"
              },
              "ansettelsesform": null,
              "yrke": {
                "kode": "3493104",
                "beskrivelse": "SKOLEBIBLIOTEKAR"
              },
              "antallTimerPrUke": 37.5,
              "avtaltStillingsprosent": 45.33,
              "sisteStillingsprosentendring": "2019-03-21",
              "sisteLoennsendring": "2019-03-14",
              "rapporteringsmaaneder": {
                "fra": "2019-03",
                "til": null
              }
            },
            {
              "type": "Ordinaer",
              "arbeidstidsordning": {
                "kode": "ikkeSkift",
                "beskrivelse": "Ikke skift"
              },
              "ansettelsesform": null,
              "yrke": {
                "kode": "3493104",
                "beskrivelse": "SKOLEBIBLIOTEKAR"
              },
              "antallTimerPrUke": 37.5,
              "avtaltStillingsprosent": 40.0,
              "sisteStillingsprosentendring": "2019-03-14",
              "sisteLoennsendring": "2019-03-14",
              "rapporteringsmaaneder": {
                "fra": "2019-01",
                "til": "2019-02"
              }
            }
          ],
          "permisjoner": null,
          "permitteringer": null,
          "timerMedTimeloenn": null,
          "utenlandsopphold": null,
          "idHistorikk": null,
          "varsler": null,
          "rapporteringsordning": {
            "kode": "A_ORDNINGEN",
            "beskrivelse": "Rapportert via a-ordningen (2015-d.d.)"
          },
          "uuid": "2e3038bf-442a-479f-9649-b0abfd17a410",
          "opprettet": "2019-04-05T08:44:53.807",
          "sistBekreftet": "2019-04-05T14:57:44",
          "sistEndret": "2019-10-14T13:10:57"
        }
      ]
    }
  }
}
Eksempel #3
  • Arbeidstakere for aktive ordinære arbeidsforhold som er rapportert via A-Ordningen for gitt arbeidssted og opplysningspliktig

NB: Kan gi duplikater siden en arbeidstaker kan ha flere arbeidsforhold med ulike ansettelsesperioder på gitt arbeidssted og opplysningspliktig

Spørring:

{
  "query": "query($finnArbeidsforholdVariabler: FinnArbeidsforholdVariabler) { finnArbeidsforhold(finnArbeidsforholdVariabler: $finnArbeidsforholdVariabler) { arbeidsforhold { arbeidstaker { ident } } } }",
  "variables": {
    "finnArbeidsforholdVariabler": {
      "opplysningspliktigId": "987654321",
      "arbeidsstedId": "876543210",
      "arbeidsforholdtype": [
        "ordinaertArbeidsforhold"
      ],
      "rapporteringsordning": [
        "A_ORDNINGEN"
      ],
      "arbeidsforholdstatus": [
        "AKTIV"
      ],
      "ansettelsesdetaljerhistorikk": false
    }
  }
}

Respons:

  • ordinært arbeidsforhold
  • ansettelsesperiode uten varsling
  • ansettelsesdetaljer (1)
  • permisjoner (1)
  • permitteringer (1)
  • timer-med-timelønn (0)
  • utenlandsopphold (0)
  • arbeidsforhold-id-historikk (0)
  • varsler (0)
{
  "data": {
    "finnArbeidsforholdPrArbeidstaker": {
      "arbeidsforhold": [
        {
          "id": "ARBEIDSFORHOLD_ID",
          "type": {
            "kode": "ordinaertArbeidsforhold",
            "beskrivelse": "Ordinært arbeidsforhold"
          },
          "arbeidstaker": {
            "ident": "ARBEIDSTAKER_FNR"
          },
          "arbeidssted": {
            "type": "Underenhet",
            "ident": "UNDERENHET_ORG_NR"
          },
          "opplysningspliktig": {
            "type": "Hovedenhet",
            "ident": "HOVEDENHET_ORG_NR"
          },
          "ansettelsesperiode": {
            "startdato": "2018-11-01",
            "sluttdato": null,
            "sluttaarsak": null,
            "varsling": null
          },
          "ansettelsesdetaljer": [
            {
              "type": "Ordinaer",
              "arbeidstidsordning": {
                "kode": "ikkeSkift",
                "beskrivelse": "Ikke skift"
              },
              "ansettelsesform": null,
              "yrke": {
                "kode": "1319123",
                "beskrivelse": "DAGLIG LEDER (FÆRRE ENN 10 ANSATTE - REHABILITERING)"
              },
              "antallTimerPrUke": 37.5,
              "avtaltStillingsprosent": 100.0,
              "sisteStillingsprosentendring": null,
              "sisteLoennsendring": "2018-11-01",
              "rapporteringsmaaneder": {
                "fra": "2019-03",
                "til": null
              }
            }
          ],
          "permisjoner": [
            {
              "id": "PERMISJON_ID",
              "type": {
                "kode": "permisjonMedForeldrepenger",
                "beskrivelse": "Permisjon med foreldrepenger"
              },
              "startdato": "2018-11-01",
              "sluttdato": "2019-03-14",
              "prosent": 100.0,
              "varsling": null
            }
          ],
          "permitteringer": [
            {
              "id": "PERMITTERING_ID",
              "type": {
                "kode": "permittering",
                "beskrivelse": "Permittering"
              },
              "startdato": "2019-03-15",
              "sluttdato": null,
              "prosent": 100.0,
              "varsling": null
            }
          ],
          "timerMedTimeloenn": null,
          "utenlandsopphold": null,
          "idHistorikk": null,
          "varsler": null,
          "rapporteringsordning": {
            "kode": "A_ORDNINGEN",
            "beskrivelse": "Rapportert via a-ordningen (2015-d.d.)"
          },
          "uuid": "3a80935e-97d7-4d69-bfb8-f7c1185c121a",
          "opprettet": "2019-03-14T13:57:05.180",
          "sistBekreftet": "2019-04-04T13:19:31",
          "sistEndret": "2019-10-10T10:52:46"
        }
      ]
    }
  }
}
Eksempel #4
  • Arbeidstakere for avsluttede ordinære arbeidsforhold som er rapportert før A-Ordningen for gitt opplysningspliktig

NB: Kan gi duplikater siden en arbeidstaker kan ha flere arbeidsforhold med ulike ansettelsesperioder på gitt arbeidssted og opplysningspliktig

Spørring:

{
  "query": "query($finnArbeidsforholdVariabler: FinnArbeidsforholdVariabler) { finnArbeidsforhold(finnArbeidsforholdVariabler: $finnArbeidsforholdVariabler) { arbeidsforhold { arbeidstaker { ident } } } }",
  "variables": {
    "finnArbeidsforholdVariabler": {
      "opplysningspliktigId": "987654321",
      "arbeidsforholdtype": [
        "ordinaertArbeidsforhold"
      ],
      "rapporteringsordning": [
        "FOER_A_ORDNINGEN"
      ],
      "arbeidsforholdstatus": [
        "AVSLUTTET"
      ],
      "ansettelsesdetaljerhistorikk": false
    }
  }
}

Respons:

  • ordinært arbeidsforhold
  • ansettelsesperiode med varsling
  • ansettelsesdetaljer (1)
  • permisjoner (0)
  • permitteringer (0)
  • timer-med-timelønn (0)
  • utenlandsopphold (0)
  • arbeidsforhold-id-historikk (1)
  • varsler (2)
{
  "data": {
    "finnArbeidsforholdPrArbeidstaker": {
      "arbeidsforhold": [
        {
          "id": "ARBEIDSFORHOLD_ID",
          "type": {
            "kode": "ordinaertArbeidsforhold",
            "beskrivelse": "Ordinært arbeidsforhold"
          },
          "arbeidstaker": {
            "ident": "ARBEIDSTAKER_FNR"
          },
          "arbeidssted": {
            "type": "Underenhet",
            "ident": "UNDERENHET_ORG_NR"
          },
          "opplysningspliktig": {
            "type": "Hovedenhet",
            "ident": "HOVEDENHET_ORG_NR"
          },
          "ansettelsesperiode": {
            "startdato": "2018-01-01",
            "sluttdato": "2018-11-30",
            "sluttaarsak": null,
            "varsling": {
              "kode": "IBARBG",
              "beskrivelse": "Sluttdato satt av NAV. Arbeidsforholdet har ikke blitt bekreftet. Sluttdato er siste dato i kalendermåneden som arbeidsforholdet er bekreftet."
            }
          },
          "ansettelsesdetaljer": [
            {
              "type": "Ordinaer",
              "arbeidstidsordning": {
                "kode": "ikkeSkift",
                "beskrivelse": "Ikke skift"
              },
              "ansettelsesform": null,
              "yrke": {
                "kode": "1210160",
                "beskrivelse": "STYREMEDLEM"
              },
              "antallTimerPrUke": 37.5,
              "avtaltStillingsprosent": 100.0,
              "sisteStillingsprosentendring": "2018-01-01",
              "sisteLoennsendring": "2018-01-01",
              "rapporteringsmaaneder": {
                "fra": "2018-01",
                "til": null
              }
            }
          ],
          "permisjoner": null,
          "permitteringer": null,
          "timerMedTimeloenn": null,
          "utenlandsopphold": null,
          "idHistorikk": [
            {
              "id": "HISTORISK_ARBEIDSFORHOLD_ID"
            }
          ],
          "varsler": [
            {
              "entitet": "Arbeidsforhold",
              "varsling": {
                "kode": "MATCH",
                "beskrivelse": "Arbeidsforholdet er matchet av NAV og har en historikk for arbeidsforhold-id"
              }
            },
            {
              "entitet": "Ansettelsesperiode",
              "varsling": {
                "kode": "IBARBG",
                "beskrivelse": "Sluttdato satt av NAV. Arbeidsforholdet har ikke blitt bekreftet. Sluttdato er siste dato i kalendermåneden som arbeidsforholdet er bekreftet."
              }
            }
          ],
          "rapporteringsordning": {
            "kode": "FOER_A_ORDNINGEN",
            "beskrivelse": "Rapportert før a-ordningen (1978-2014)"
          },
          "uuid": "a1c61883-bfb9-4cc8-a875-398402317da6",
          "opprettet": "2019-02-27T13:02:30.970",
          "sistBekreftet": "2019-03-06T14:56:29",
          "sistEndret": "2019-03-09T18:12:06"
        }
      ]
    }
  }
}
Eksempel #5
  • Alle ordinære arbeidsforhold som er rapportert via A-Ordningen med historikk på stillingsprosent for gitt arbeidssted

Spørring:

{
  "query": "query($finnArbeidsforholdVariabler: FinnArbeidsforholdVariabler) { finnArbeidsforhold(finnArbeidsforholdVariabler: $finnArbeidsforholdVariabler) { arbeidsforhold { id uuid arbeidstaker { ident } opplysningspliktig { type ident } ansettelsesdetaljer { avtaltStillingsprosent rapporteringsmaaneder { fra til } } } } }",
  "variables": {
    "finnArbeidsforholdVariabler": {
      "arbeidsstedId": "876543210",
      "arbeidsforholdtype": [
        "ordinaertArbeidsforhold"
      ],
      "rapporteringsordning": [
        "A_ORDNINGEN"
      ],
      "arbeidsforholdstatus": [
        "AKTIV",
        "FREMTIDIG",
        "AVSLUTTET"
      ],
      "ansettelsesdetaljerhistorikk": true
    }
  }
}

Respons:

  • maritimt arbeidsforhold
  • ansettelsesperiode uten varsling
  • ansettelsesdetaljer (1)
  • permisjoner (0)
  • permitteringer (0)
  • timer-med-timelønn (3)
  • utenlandsopphold (2)
  • arbeidsforhold-id-historikk (0)
  • varsler (0)
{
  "data": {
    "finnArbeidsforholdPrArbeidstaker": {
      "arbeidsforhold": [
        {
          "id": "ARBEIDSFORHOLD_ID",
          "type": {
            "kode": "maritimtArbeidsforhold",
            "beskrivelse": "Maritimt arbeidsforhold"
          },
          "arbeidstaker": {
            "ident": "ARBEIDSTAKER_FNR"
          },
          "arbeidssted": {
            "type": "Underenhet",
            "ident": "UNDERENHET_ORG_NR"
          },
          "opplysningspliktig": {
            "type": "Hovedenhet",
            "ident": "HOVEDENHET_ORG_NR"
          },
          "ansettelsesperiode": {
            "startdato": "2007-03-01",
            "sluttdato": null,
            "sluttaarsak": null,
            "varsling": null
          },
          "ansettelsesdetaljer": [
            {
              "type": "Maritim",
              "arbeidstidsordning": {
                "kode": "ikkeSkift",
                "beskrivelse": "Ikke skift"
              },
              "ansettelsesform": null,
              "yrke": {
                "kode": "3141113",
                "beskrivelse": "MASKINSJEF"
              },
              "fartsomraade": {
                "kode": "innenriks",
                "beskrivelse": "Innenriks"
              },
              "skipsregister": {
                "kode": "nor",
                "beskrivelse": "NOR"
              },
              "fartoeystype": {
                "kode": "annet",
                "beskrivelse": "Annet"
              },
              "antallTimerPrUke": 37.0,
              "avtaltStillingsprosent": 100.0,
              "sisteStillingsprosentendring": "2019-01-01",
              "sisteLoennsendring": "2019-01-01",
              "rapporteringsmaaneder": {
                "fra": "2019-01",
                "til": null
              }
            }
          ],
          "permisjoner": [],
          "permitteringer": [],
          "timerMedTimeloenn": [
            {
              "antall": 45.0,
              "startdato": "2018-12-01",
              "sluttdato": "2018-12-31",
              "rapporteringsmaaned": "2019-01"
            },
            {
              "antall": 27.0,
              "startdato": null,
              "sluttdato": null,
              "rapporteringsmaaned": "2019-02"
            },
            {
              "antall": 15.0,
              "startdato": null,
              "sluttdato": null,
              "rapporteringsmaaned": "2019-03"
            }
          ],
          "utenlandsopphold": [
            {
              "land": {
                "kode": "GB",
                "beskrivelse": "STORBRITANNIA"
              },
              "startdato": "2017-05-01",
              "sluttdato": "2017-05-31",
              "rapporteringsmaaned": "2017-05"
            },
            {
              "land": {
                "kode": "CA",
                "beskrivelse": "CANADA"
              },
              "rapporteringsmaaned": "2017-09"
            }
          ],
          "idHistorikk": null,
          "varsler": null,
          "rapporteringsordning": {
            "kode": "A_ORDNINGEN",
            "beskrivelse": "Rapportert via a-ordningen (2015-d.d.)"
          },
          "uuid": "b383adab-114a-46a5-b192-8689e7902c37",
          "opprettet": "2019-02-08T12:29:55.673",
          "sistBekreftet": "2019-04-03T14:36:04",
          "sistEndret": "2019-09-03T15:38:07"
        }
      ]
    }
  }
}
Eksempel #6
  • Frilanser arbeidsforhold som er rapportert via A-Ordningen med startdato, sluttdato og evt. sluttårsak eller varsling for gitt arbeidstaker

Spørring:

{
  "query": "query($finnArbeidsforholdVariabler: FinnArbeidsforholdVariabler) { finnArbeidsforhold(finnArbeidsforholdVariabler: $finnArbeidsforholdVariabler) { arbeidsforhold { id uuid type { kode beskrivelse } arbeidssted { type ident } opplysningspliktig { type ident } ansettelsesperiode { startdato sluttdato sluttaarsak { kode beskrivelse } varsling { kode beskrivelse } } } } }",
  "variables": {
    "finnArbeidsforholdVariabler": {
      "arbeidstakerId": "31120154321",
      "arbeidsforholdtype": [
        "frilanserOppdragstakerHonorarPersonerMm"
      ],
      "rapporteringsordning": [
        "A_ORDNINGEN"
      ],
      "arbeidsforholdstatus": [
        "AKTIV",
        "AVSLUTTET"
      ],
      "ansettelsesdetaljerhistorikk": false
    }
  }
}

Respons:

  • frilanser arbeidsforhold
{
  "data": {
    "finnArbeidsforhold": {
      "arbeidsforhold": [
        {
          "id": "ARBEIDSFORHOLD_ID",
          "type": {
            "kode": "frilanserOppdragstakerHonorarPersonerMm",
            "beskrivelse": "Frilansere/oppdragstakere, styremedlemmer, folkevalgte, personer som innehar tillitsverv, fosterforelder, støttekontakter, avlastere og personer med omsorgslønn"
          },
          "arbeidstaker": {
            "ident": "ARBEIDSTAKER_FNR"
          },
          "arbeidssted": {
            "type": "Underenhet",
            "ident": "UNDERENHET_ORG_NR"
          },
          "opplysningspliktig": {
            "type": "Hovedenhet",
            "ident": "HOVEDENHET_ORG_NR"
          },
          "ansettelsesperiode": {
            "startdato": "2015-12-15",
            "sluttdato": null,
            "sluttaarsak": null,
            "varsling": null
          },
          "ansettelsesdetaljer": [
            {
              "type": "Frilanser",
              "arbeidstidsordning": {
                "kode": "ikkeSkift",
                "beskrivelse": "Ikke skift"
              },
              "ansettelsesform": null,
              "yrke": {
                "kode": "1310104",
                "beskrivelse": "STYREMEDLEM (IKKE-SPESIFISERT NÆRINGSOMRÅDE-FÆRRE ENN 10 ANSATTE-PRIVAT VIRKSOMHET)"
              },
              "antallTimerPrUke": 37.5,
              "avtaltStillingsprosent": 0.0,
              "sisteStillingsprosentendring": null,
              "sisteLoennsendring": "2015-12-15",
              "rapporteringsmaaneder": {
                "fra": "2020-12",
                "til": null
              }
            }
          ],
          "permisjoner": null,
          "permitteringer": null,
          "timerMedTimeloenn": null,
          "utenlandsopphold": null,
          "idHistorikk": null,
          "varsler": null,
          "rapporteringsordning": {
            "kode": "A_ORDNINGEN",
            "beskrivelse": "Rapportert via a-ordningen (2015-d.d.)"
          },
          "uuid": "d0b9462a-cf59-4112-a6df-4a238d59da4d",
          "opprettet": "2021-01-03T10:18:59.527",
          "sistBekreftet": "2021-01-03T10:18:59",
          "sistEndret": "2021-01-03T10:19:33"
        }
      ]
    }
  }
}
Eksempel #7
  • Forenklet oppgjørsordning arbeidsforhold som er rapportert via A-Ordningen med startdato, sluttdato og evt. sluttårsak eller varsling for gitt arbeidstaker

Spørring:

{
  "query": "query($finnArbeidsforholdVariabler: FinnArbeidsforholdVariabler) { finnArbeidsforhold(finnArbeidsforholdVariabler: $finnArbeidsforholdVariabler) { arbeidsforhold { id uuid type { kode beskrivelse } arbeidssted { type ident } opplysningspliktig { type ident } ansettelsesperiode { startdato sluttdato sluttaarsak { kode beskrivelse } varsling { kode beskrivelse } } } } }",
  "variables": {
    "finnArbeidsforholdVariabler": {
      "arbeidstakerId": "31120154321",
      "arbeidsforholdtype": [
        "forenkletOppgjoersordning"
      ],
      "rapporteringsordning": [
        "A_ORDNINGEN"
      ],
      "arbeidsforholdstatus": [
        "AKTIV",
        "AVSLUTTET"
      ],
      "ansettelsesdetaljerhistorikk": false
    }
  }
}

Respons:

  • forenklet oppgjørsordning arbeidsforhold
  • opplysningspliktig og arbeidssted er (samme) person
{
  "data": {
    "finnArbeidsforhold": {
      "arbeidsforhold": [
        {
          "id": null,
          "type": {
            "kode": "forenkletOppgjoersordning",
            "beskrivelse": "Forenklet oppgjørsordning"
          },
          "arbeidstaker": {
            "ident": "ARBEIDSTAKER_FNR"
          },
          "arbeidssted": {
            "type": "Person",
            "ident": "ARBEIDSSTED_FNR"
          },
          "opplysningspliktig": {
            "type": "Person",
            "ident": "OPPLYSNINGSPLIKTIG_FNR"
          },
          "ansettelsesperiode": {
            "startdato": "2020-12-01",
            "sluttdato": "2020-12-31",
            "sluttaarsak": null,
            "varsling": null
          },
          "ansettelsesdetaljer": [
            {
              "type": "Forenklet",
              "arbeidstidsordning": null,
              "ansettelsesform": null,
              "yrke": {
                "kode": "5136102",
                "beskrivelse": "DAGMAMMA"
              },
              "antallTimerPrUke": null,
              "avtaltStillingsprosent": null,
              "sisteStillingsprosentendring": null,
              "sisteLoennsendring": null,
              "rapporteringsmaaneder": {
                "fra": "2020-12",
                "til": null
              }
            }
          ],
          "permisjoner": null,
          "permitteringer": null,
          "timerMedTimeloenn": null,
          "utenlandsopphold": null,
          "idHistorikk": null,
          "varsler": null,
          "rapporteringsordning": {
            "kode": "A_ORDNINGEN",
            "beskrivelse": "Rapportert via a-ordningen (2015-d.d.)"
          },
          "uuid": "72293930-4f8d-4fcf-8459-cef12011f553",
          "opprettet": "2021-01-02T23:33:30.850",
          "sistBekreftet": "2021-01-02T23:33:30",
          "sistEndret": "2021-01-02T23:34:06"
        }
      ]
    }
  }
}

Korrelasjon-id’er

Forespørsel

Alle forespørsler som blir behandlet i tjenesten får sin egen unike ID (UUID) - korrelasjon-id - som blir returnert til konsumenten. Korrelasjon-id’en settes i HTTP-response-header’en (correlation-id) for alle HTTP-response 200 OK (inkl. responser med feil).

Hvis ønskelig kan konsumenter benytte sin egen korrelasjon-id ved å spesifisere correlation-id i HTTP-request-header’en. Konsumenter står fritt til å sende inn hva de vil, men vi anbefaler at det genereres en unik ID (UUID).

Ved henvendelser bør korrelasjon-id’en oppgis - det letter behandling av henvendelsen.

Arbeidsforhold

Alle arbeidsforhold har sin egen unike ID - uuid.

Dersom det er behov for å se nærmere på et bestemt arbeidsforhold, enten det er spørsmål om data eller rapportering av feil er det ønskelig at feltet uuid benyttes i kommunikasjonen for å identifisere arbeidsforholdet.

Denne ID’en returneres dersom konsumenten ber feltet uuid i tjenesten finnArbeidsforholdPrArbeidstaker

{
  "data": {
    "finnArbeidsforholdPrArbeidstaker": {
      "arbeidsforhold": [
        {
          "uuid": "unik-arbeidsforhold-uuid"
        }
      ]
    }
  }
}

Feilmeldinger

Spørringer som feiler vil respondere med en 200 HTTP-status og en json-body med en errors-liste, samt et felt som angir typen feil under “classification”.

Feilkoder og forklaring

Feilkode Forklaring Klassifisering
AA-000 Det oppsto en feil under behandlingen av forespøselen ExecutionAborted
AA-001 Spørringen inneholder ugyldige variabler/verdier, eller er på et ugyldig format ValidationError
AA-002 Arbeidsforholdet er ikke komplett. Ta kontakt med brukerstøtte, og bruk korrelasjons-id som referanse ExecutionAborted
AA-200 Spørring må inneholde minst 1 av variablene opplysningspliktigId, arbeidsstedId og arbeidstakerId ValidationError
AA-201 Spørring må inneholde minst 1 verdi for arbeidsforholdtype ValidationError
AA-202 Spørring må inneholde minst 1 verdi for rapporteringsordning ValidationError
AA-203 Spørring må inneholde minst 1 verdi for arbeidsforholdstatus ValidationError
AA-204 Validering av opplysningspliktigId feilet ValidationError
AA-205 Validering av arbeidsstedId feilet ValidationError
AA-206 Validering av arbeidstakerId feilet ValidationError
AA-207 Validering av arbeidsforholdtype, rapporteringsordning eller arbeidsforholdstatus feilet ValidationError

Eksempler (feilmeldinger)

AA-000

{
    "errors": [
        {
            "message": "En ukjent feil oppstod",
            "locations": [],
            "extensions": {
                "errormessages": {
                    "code": "AA-000",
                    "message": "Det oppsto en feil under behandlingen av forespøselen",
                    "details": null
                },
                "classification": "ExecutionAborted"
            }
        }
    ],
    "data": {
        "finnArbeidsforhold": null
    }
}

AA-001

{
    "errors": [
        {
            "message": "Ugyldig input",
            "locations": [],
            "extensions": {
                "errormessages": [
                    {
                        "code": "AA-001",
                        "message": "Spørringen inneholder ugyldige variabler/verdier, eller er på et ugyldig format",
                        "details": null
                    }
                ],
                "classification": "ValidationError"
            }
        }
    ],
    "data": {
        "finnArbeidsforhold": null
    }
}

AA-002

{
    "errors": [
        {
            "message": "Ugyldig data",
            "locations": [],
            "extensions": {
                "errormessages": [
                    {
                        "code": "AA-002",
                        "message": "Arbeidsforholdet er ikke komplett. Ta kontakt med brukerstøtte, og bruk korrelasjons-id som referanse",
                        "details": null
                    }
                ],
                "classification": "ExecutionAborted"
            }
        }
    ],
    "data": {
        "finnArbeidsforhold": {
            "arbeidsforhold": null
        }
    }
}

AA-200

{
    "errors": [
        {
            "message": "Ugyldig input",
            "locations": [],
            "extensions": {
                "errormessages": [
                    {
                        "code": "AA-200",
                        "message": "Spørring må inneholde minst 1 av variablene",
                        "details": "opplysningspliktigId, arbeidsstedId, arbeidstakerId"
                    }
                ],
                "classification": "ValidationError"
            }
        }
    ],
    "data": {
        "finnArbeidsforhold": null
    }
}

AA-204

{
  "errors": [
    {
      "message": "Ugyldig input",
      "locations": [],
      "extensions": {
        "errormessages": [
          {
            "code": "AA-204",
            "message": "Validering av variabel feilet",
            "details": "opplysningspliktigId"
          }
        ],
        "classification": "ValidationError"
      }
    }
  ],
  "data": {
    "finnArbeidsforhold": null
  }
}