{
  "openapi" : "3.0.1",
  "info" : {
    "title" : "DFØ API",
    "description" : "Datamodellene som er beskrevet her skal være generiske og dekkende for tilgang på data om person, organisasjon og stilling hos DFØ sine kunder.\n* Ansatte, gjester og innleide (gyldighet i dag - hvis ingen gyldig post i dag, hent første gyldige post, eller siste gyldige post 30 dager tilbake i tid. Personer forsvinner fra grensesnittet 30 dager etter fratredelse. Default er spørring på dagens dato, men det er mulig å endre dato for spørring frem eller tilbake i tid. Da vil backend forholde seg til denne datoen som dagens dato. Eksempelvis vil det i 2022 være mulig å spørre på en person tilbake til 01.01.2021 selv om personen fratrådte 30.05.2021. Det vil også være mulig å spørre på en person 01.05.2021, selv om personen ikke tiltrer før 01.09.2021). \n* Lokasjoner (kun i bruk for SVV - ingen informasjon om dette i denne filen)\n* Stillinger (Henter stillingens navn og alle definerte knytninger som er gyldige fra i dag, og i all fremtid. Det vil også være mulig å definere 'innlest dato' for å hente historiske poster).\n* Orgenheter\n\nUpdate log\n1.0    Initial versions\n1.1    Updated on 18.02.2019\n1.2    Updated \n2.0 Oppdatert til å være generisk og gyldig for BOTT, og mer innledende definisjoner.",
    "version" : "2.0"
  },
  "servers" : [ {
    "url" : "https://api.dfo.no/"
  } ],
  "tags" : [ {
    "name" : "Ansatte",
    "description" : "Ansatte og innleide"
  } ],
  "paths" : {
    "/ansatte/{id}" : {
      "get" : {
        "tags" : [ "Ansatte" ],
        "summary" : "Hent en ansatt eller innleid",
        "description" : "Hent en spesifikk ansatt eller innleid ved bruk av id (ansattnummer).... Bør PDO inngå som attributt på person?",
        "operationId" : "Hent_person",
        "responses" : {
          "200" : {
            "description" : "",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ansatte"
                }
              }
            }
          }
        }
      },
      "put" : {
        "tags" : [ "Ansatte" ],
        "summary" : "Oppdater en ansatt eller innleid",
        "description" : "Oppdater epostadresse og brukerident, samt andre data hvor kundene er eier av relevant data, på ansatt, innledig eller gjest.\nBenyttes av kunde for å sette disse verdiene i systemet hos DFØ.\nKunde er master for brukerident og epostadresse hentes fra AD, eller tilsvarende løsninger hos kundene.",
        "operationId" : "Oppdater_person",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "epost" : {
                    "type" : "string",
                    "description" : "Epostadresse - 0105 USERID_LONG - deltype 0010, maks feltlengde 241 tegn",
                    "example" : "kari@uit.no"
                  },
                  "telefonnummer" : {
                    "type" : "string",
                    "description" : "Telefonnummer arbeid - PA0105USRID_LONG - deltype 0020, maks feltlengde 40 tegn (30+10)",
                    "example" : "98765432"
                  },
                  "tjenestetelefon" : {
                    "type" : "string",
                    "description" : "Tjenestetelefon - PA0105USRID - deltype 9001, maks feltlengde 30 tegn",
                    "example" : "98765433"
                  },
                  "mobilnummer" : {
                    "type" : "string",
                    "description" : "Mobilnummer jobb- PA0105USRID - deltype 9003 - viktig at dette feltet er fylt inn for de ansatte som skal bruke 2-faktor pålogging, maks feltlengde 30 tegn",
                    "example" : "98765434"
                  },
                  "sakarkivnr" : {
                    "type" : "string",
                    "description" : "Sak og arkivnummer - PA0002YHR_ARKIV_SAKSNR, maks feltlengde 11 tegn",
                    "example" : "20/09876542"
                  },
                  "brukerident" : {
                    "type" : "string",
                    "description" : "initialer i SAP - PA0002INITS - maks feltlengde 10 tegn - Kan kun oppdateres hvis feltet for initialer er tomt",
                    "example" : "yngher"
                  },
                  "eksternIdent" : {
                    "type" : "string",
                    "description" : "Ekstern ID, eksempelvis Feide ID - PA0105USRID_LONG - deltype 9020, maks feltlengde 241 tegn",
                    "example" : "johanne@feide.no"
                  }
                }
              }
            }
          },
          "required" : false
        },
        "responses" : {
          "200" : {
            "description" : "200 OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ansatte"
                }
              }
            }
          }
        },
        "security" : [ {
          "dfo-auth-apikey" : [ ]
        } ],
        "x-codegen-request-body-name" : "body"
      },
      "parameters" : [ {
        "name" : "id",
        "in" : "path",
        "required" : true,
        "schema" : {
          "type" : "string"
        }
      } ]
    }
  },
  "components" : {
    "schemas" : {
      "ansatte" : {
        "title" : "Ansatte",
        "required" : [ "eksternbruker", "etternavn", "fdato", "fnr", "fornavn", "id", "jurBedriftsnummer", "kjonn", "kostnadssted", "landkode", "lederflagg", "medarbeidergruppe", "medarbeiderundergruppe", "organisasjonId", "portaltilgang", "privatPostadresse", "privatPostnr", "privatPoststed", "reservasjonPublisering", "sluttdato", "startdato", "stillingId", "turnustilgang" ],
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "DFØ ansattnummer - 0000PERNR, maks feltlengde 8 tegn",
            "example" : "5001234"
          },
          "brukerident" : {
            "type" : "string",
            "description" : "Brukerident (verdien kan bestemmes av kunde, og postes via PUT ansatt API) - 0002INITS - maks feltlengde 8 tegn",
            "example" : "olanor"
          },
          "dfoBrukerident" : {
            "type" : "string",
            "description" : "Brukernavn hos DFØ - 0105 USERID_LONG - deltype 0001 - maks feltlengde 12 tegn og består av firmakode (4 siffer) og brukerident (initialer i SAP)",
            "example" : "9900olanor"
          },
          "eksternIdent" : {
            "type" : "string",
            "description" : "Ekstern ID, eksempelvis Feide ID - PA0105USRID_LONG - deltype 9020, maks feltlengde 241 tegn",
            "example" : "abcdefe23456@uit.no"
          },
          "fornavn" : {
            "type" : "string",
            "description" : "Fornavn - 0002VORNA, maks feltlengde 40 tegn",
            "example" : "Ola"
          },
          "etternavn" : {
            "type" : "string",
            "description" : "Etternavn - 0002NACHN, maks feltlendge 40 tegn",
            "example" : "Nordmann"
          },
          "fnr" : {
            "type" : "string",
            "description" : "Fødselsnummer - 0002PERID, maks feltlengde 20 tegn",
            "example" : "01017044123"
          },
          "annenId" : {
            "type" : "array",
            "description" : "internasjonale ID'er fra infotype 0185 i SAP",
            "items" : {
              "$ref" : "#/components/schemas/annenid"
            }
          },
          "fdato" : {
            "type" : "string",
            "description" : "Fødselsdato - 0002GBDAT, maks feltlengde 8 tegn",
            "example" : "1970-01-01"
          },
          "kjonn" : {
            "type" : "string",
            "description" : "Kjønn - 0002GESCH\n- F (Female)\n- M (Male)",
            "example" : "M"
          },
          "sakarkivnr" : {
            "type" : "string",
            "description" : "Sak og arkivnummer - PA0002YHR_ARKIV_SAKSNR, maks feltlengde 11 tegn",
            "example" : "20/09876543"
          },
          "landkode" : {
            "type" : "string",
            "description" : "Landskode - PA0002NATIO, maks feltlengde 3 tegn",
            "example" : "NO"
          },
          "medarbeidergruppe" : {
            "type" : "string",
            "description" : "Medarbeidergruppe - 0001PERSG, tabell T501T viser aktuelle verdier med tilhørende beskrivelse",
            "example" : "1",
            "enum" : [ "1 (Fast ansatt)", "2 (Embedsmenn)", "3 (Åremålsansatte)", "4 (Midlert./engasj. tjm)", "5 (Ekstrahjelp)", "6 (Vikarer)", "7 (Tiltak)", "8 (Ekstern m/utbetaling)", "9 (Ekstern u/utbetaling)", "B (Beordret)", "E (Avvikende ekstrahj)", "F (Avvikende faste ans)", "L (Lokalt ansatte)", "M (Avvikende midl ans)", "P (Politikere)", "S (Sjøfolk)", "T (Vikar Sjøfolk)", "V (Avvikende vikar)", "x (Avvik ekst m/lønn(8))" ]
          },
          "medarbeiderundergruppe" : {
            "type" : "string",
            "description" : "MedarbeiderunderGruppe - 0001PERSK -  tabell T503T viser aktuelle verdier med tilhørende beskrivelse",
            "example" : "01",
            "enum" : [ "1 (Hovedlønnstabell)", "2 (Hovedlø.tab.u/oppryk)", "3 (Lederlønnstabellen)", "4 (Timelønn C-tabellen)", "6 (Skift/turnusordning)", "7 (X_Ungarb. ikke i bruk)", "8 (X_Underv.pers.lesebr)", "9 (individuell avlønn)", "10 (Lærlinger/elever)", "11 (Rengjøringspersonale)", "12 (Stipendiater)", "13 (Postdoktor)", "14 (Hovedlø.tab uten SPK)", "15 (Timelønn C-tab u/SPK)", "16 (Ekst.prosj. post 211)", "17 (Int.prosj. post 213)", "18 (E.prsj.p.211 - timel)", "20 (Svalbard/hov.l.tabel)", "21 (Svalbard/led.l.tabel)", "22 (Svalbard/tim.C-tabel)", "23 (Svalbard/honorarer)", "24 (Svalbard/renhold)", "25 (Statssekr./pol.rådg.)", "26 (Statsmin./statsråd)", "27 (Stortingsrepr)", "28 (Vararepresentanter)", "29 (Jan Mayen)", "30 (Pensjon. pensjonvilk)", "31 (X_Ikke statsp>70 h.l)", "32 (X_Ikke statsp>70 t.l)", "33 (Bistillinger SPK)", "34 (Konstituert dommer)", "35 (Jan Mayen/tim.C-tab)", "36 (Værobservatør)", "37 (andre observatører)", "38 (Jan Mayen/honorarer)", "40 (Arbeidsmarkedstiltak)", "41 (X_sysselsettingstilt)", "42 (X_Attføring)", "43 (Arbeidsavklaring)", "44 (Arb.tiltak u/lønn)", "50 (Ekstern med oppdrag)", "51 (Styrer.råd,utvalg)", "52 (Kunstnerlønn)", "53 (Politikere (dep.))", "54 (Oppdrag u/pensjon)", "55 (Oppdrag m/pensjon)", "56 (Verger)", "57 (Ektefellebidrag NAV)", "58 (Utleggstrekk Helfo)", "59 (Ekstern uten oppdrag)", "60 (Pensjon)", "62 (Lok.per lønnet i No)", "63 (Lok.per tr/oppgpl.No)", "64 (Lok.per.oppgpl.No)", "65 (Lok.per.trygd i No)", "66 (Lok.per.(pers.adm))", "67 (Valgkonsuler)", "68 (Eksperter NORAD)", "69 (Observatører UD)", "70 (Leger)", "71 (Tolker)", "72 (Advokater)", "73 (Revisorer)", "74 (Andre sakkyndige)", "75 (Medlem Forliksråd)", "76 (Politireserven)", "77 (avvik kontering 8)", "78 (avvik kontering 9)", "79 (avvik kontering 10)", "80 (Næringsdrivende)", "92 (Sivilarbeidere)", "93 (Emeritus)", "94 (Konsulent)", "95 (Gjesteforsker)" ]
          },
          "startdato" : {
            "type" : "string",
            "description" : "Startdato for ansatt (første arbeidsdag) - bruker Funksjonsmodul YHR_HENT_START_SLUTT2",
            "example" : "2010-05-01"
          },
          "sluttdato" : {
            "type" : "string",
            "description" : "Sluttdato for ansatt (siste arbeidsdag) - bruker Funksjonsmodul YHR_HENT_START_SLUTT2",
            "example" : "2019-01-31"
          },
          "sluttarsak" : {
            "type" : "string",
            "description" : "Sluttårsak - T530TMGTXT",
            "example" : "Oppsig.fra ans - slutt i stat"
          },
          "stillingId" : {
            "type" : "integer",
            "description" : "Stillings ID - HRP1001 og B008/A008 knytningen mellom ansattnummer og stilling. Dette er personens hovedstilling",
            "example" : 30000468
          },
          "dellonnsprosent" : {
            "type" : "string",
            "description" : "Dellønnsprosent - PA0008BSGRD, makslengde 5 tegn + 2 desimaler",
            "example" : "100"
          },
          "kostnadssted" : {
            "type" : "string",
            "description" : "kostnadssted - PA0001KOSTL, makslengde 10 tegn",
            "example" : "67165"
          },
          "organisasjonId" : {
            "type" : "integer",
            "description" : "Organisasjons ID - PA0001ORGEH, makslengde 8 tegn",
            "example" : 10000048
          },
          "jurBedriftsnummer" : {
            "type" : "integer",
            "description" : "Juridisk bedriftsnummer for virksomheten - T001Z, party=NO_JUR og aktuell firmakode. YHR_BEDRIFTSNUMMER",
            "example" : 976362832
          },
          "tilleggsstilling" : {
            "type" : "array",
            "description" : "internasjonale ID'er fra infotype 0185 i SAP",
            "items" : {
              "$ref" : "#/components/schemas/tilleggsstilling"
            }
          },
          "lederflagg" : {
            "type" : "boolean",
            "description" : "- false (personen er ikke en leder) true (personen er en leder) - HRP1001 - både lederknytning og fungerende leder - Finn B012 knytningen og deretter eventuelt finn A008 eller A081",
            "example" : false
          },
          "portaltilgang" : {
            "type" : "boolean",
            "description" : "- false (personen er skal ikke ha portaltilgang) true (personen skal ha portaltilgang) - PA0655ESSONLY",
            "example" : false
          },
          "turnustilgang" : {
            "type" : "boolean",
            "description" : "- false (personen er skal ikke ha turnustilgang) true (personen skal ha turnustilgang) - PA0655ZZGATBRUKER",
            "example" : false
          },
          "eksternbruker" : {
            "type" : "boolean",
            "description" : "- false (personen skal ikke ha eksternt brukernavn) true (personen skal ha eksternt brukernavn. Feltet vil benyttes for å indikere om personer skal ha generert erksternt brukernavn fra fødererte partnere som eksempelvis Feide eller kunders ADFS løsninger - PA0655ZZEKSTBRUKER",
            "example" : true
          },
          "reservasjonPublisering" : {
            "type" : "boolean",
            "description" : "- false (personen er ikke reservert mot publisering) true (personen er reservert mot publisering – skal ikke publiseres) - PA0105USRTY SUBTY=9100",
            "example" : false
          },
          "epost" : {
            "type" : "string",
            "description" : "Epostadresse (verdien blir bestemt av IDM), PA0105USERID_LONG - deltype 0010, maks feltlengde 241 tegn",
            "example" : "ola.nordmann@uib.no"
          },
          "tjenestetelefon" : {
            "type" : "string",
            "description" : "Tjenestetelefon - PA0105USRID - deltype 9001, maks feltlengde 30 tegn",
            "example" : "45011222"
          },
          "privatTelefonnummer" : {
            "type" : "string",
            "description" : "Privat telefonnummer - PA0105USRID - deltype 9002, maks feltlengde 30 tegn",
            "example" : "33112233"
          },
          "telefonnummer" : {
            "type" : "string",
            "description" : "Telefonnummer arbeid - PA0105USRID_LONG - deltype 0020, maks feltlengde 40 tegn (30+10)",
            "example" : "56231245"
          },
          "mobilnummer" : {
            "type" : "string",
            "description" : "Mobilnummer jobb- PA0105USRID - deltype 9003 - viktig at dette feltet er fylt inn for de ansatte som skal bruke 2-faktor pålogging, maks feltlengde 30 tegn",
            "example" : "90011222"
          },
          "mobilPrivat" : {
            "type" : "string",
            "description" : "Mobilnummer privat - PA0105USRID - deltype 9004, maks feltlengde 30 tegn",
            "example" : "90543572"
          },
          "privatTlfUtland" : {
            "type" : "string",
            "description" : "Privat tlf utland - PA0105USRID - deltype 9005, maks feltlengde 30 tegn",
            "example" : "+46 123456789"
          },
          "privatPostadresse" : {
            "type" : "string",
            "description" : "Postadresse privat - PA0006STRAS, maks feltlengde 60 tegn",
            "example" : "Stolpelyktveien 1"
          },
          "privatPostnr" : {
            "type" : "string",
            "description" : "Postnummer - PA0006PSTLZ, maks feltlengde 10 tegn",
            "example" : "5231"
          },
          "privatPoststed" : {
            "type" : "string",
            "description" : "Poststed - PA0006ORT01, maks feltlengde 40 tegn",
            "example" : "Paradis"
          },
          "endretDato" : {
            "type" : "string",
            "description" : "Dato for siste registrerte endring utført av HR - PCL4AEDTM",
            "example" : "2018-12-19"
          },
          "endretAv" : {
            "type" : "string",
            "description" : "Brukernavn på hvilken bruker som sist utførte endringer på denne personen - PCL4UNAME. Dette er hjelpsom info når det oppdages utfordringer rundt verdier som er endret eller registrert og disse skal leses inn i IDM plattformen. Maks feltlengde 12 tegn",
            "example" : "3-ABCD / 9900ABCD"
          }
        },
        "description" : "Datamodell for ansattobjektet i SAP"
      },
      "annenid" : {
        "type" : "object",
        "properties" : {
          "idType" : {
            "type" : "string",
            "description" : "ID-type - PA0185ICTYP, maks feltlengde 2 tegn",
            "example" : "02"
          },
          "idBeskrivelse" : {
            "type" : "string",
            "description" : "Beskrivelse av ID-type - T5R06ICTXT (Språkkode=NO og Landgruppering=20)",
            "example" : "Passnummer"
          },
          "idNr" : {
            "type" : "integer",
            "description" : "ID-nummer (Passnummer eller annet nummer avhengig av valgt deltype) - PA0185ICNUM",
            "example" : 123456789
          },
          "idStartdato" : {
            "type" : "string",
            "description" : "Startdato på ID (startdato for gyldighet på internasjonal ID registrert på infotype 185 i SAP) - PA0185BEGDA",
            "example" : "2019-01-01"
          },
          "idSluttdato" : {
            "type" : "string",
            "description" : "sluttdato på ID (sluttdato for gyldighet på internasjonal ID registrert på infotype 185 i SAP) - PA0185ENDDA",
            "example" : "2023-12-31"
          },
          "idLand" : {
            "type" : "string",
            "description" : "land for ID - PA0185IDCOT benyttes til å hente fullt navn på land (betegnelse lang) fra T005",
            "example" : "Norge"
          }
        },
        "description" : "leder array"
      },
      "tilleggsstilling" : {
        "type" : "object",
        "properties" : {
          "stillingId" : {
            "type" : "string",
            "description" : "Stillings ID på tilleggsstilling - PA0509PLANS",
            "example" : "30000468"
          },
          "startdato" : {
            "type" : "string",
            "description" : "Startdato i tilleggsstillingen - PA0509BEGDA",
            "example" : "2019-05-01"
          },
          "sluttdato" : {
            "type" : "string",
            "description" : "sluttdato i tilleggsstillingen - PA0509ENDDA",
            "example" : "2020-06-01"
          },
          "dellonnsprosent" : {
            "type" : "string",
            "description" : "Dellønnsprosent på tilleggsstilling (benevnes også som stillingsprosent) - PA0509EMPCT",
            "example" : "100"
          }
        },
        "description" : "leder array. Tilleggsstillinger henter data fra IT0509, ved årsakskode flere stillinger - PA0509REACD"
      }
    },
    "securitySchemes" : {
      "dfo-auth-apikey" : {
        "type" : "apiKey",
        "name" : "api_key",
        "in" : "header"
      }
    }
  },
  "x-original-swagger-version" : "2.0"
}