Skip to end of banner
Go to start of banner

Bruke API for å hente ansatte fra Capitech

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Her finner du informasjon om hvordan API kan benyttes for å hente ut ansatte fra Capitech for gjenbruk i andre systemer. 

EmployeeAPI - getPersonalInformation 

I dette API endepunktet kan en hente ut ansatte for angitt klient (firma) og evt. andre andre filter en ønsker å avgrense på. 

Endepunktet er api/public/v1/Employee/getPersonalInformation



Beskrivelse av Request parametere

Her er en beskrivelse og forklaring av hvilke parametre en kan benytte for å hente ut fravær. En kan få mer detaljer via mouseover på hhv. request parameter og retur felter i API oversikt. 


Parameter

Påkrevd

Beskrivelse

Merknad

accessTokenJaToken fra Login. Kreves for å få svar på API request
clientIdJaKlientnummer for hvilket firma en skal hente timer på
departmentIdFilterNeiFilter for å hente kun ansatte på angitte avdelingsnr
includeTimeActiveNeiFilter for å inkludere kun ansatte som er aktiv i TidTrue / False
Default er True
includeTimePassiveNeiFilter for å inkludere kun ansatte som er passiv i TidTrue / False
Default er False
includeAbsenceActiveNeiFilter for å inkludere kun ansatte som er aktiv i FraværTrue / False
Default er True
includeAbsencePassiveNeiFilter for å inkludere kun ansatte som er passiv i FraværTrue / False
Default er True
includePlanActiveNeiFilter for å inkludere kun ansatte som er aktiv i PlanTrue / False
Default er True
includePlanPassiveNeiFilter for å inkludere kun ansatte som er passiv i PlanTrue / False
Default er True
genderFilterNeiFilter for å inkludere kun ansatte av et kjønnK = Kvinner
M = Menn
Null = Alle (Default)
wageGroupIdFilterNeiFilter for å inkludere kun ansatte som er med i en av angitte lønnsgruppenrAnsatt kan kun være medlem i en lønnsgruppe
costCarrierIdFilterNeiFilter for å inkludere kun ansatte som har en av angitte bærernr
statisticsGroupCodeFilterNeiFilter for å inkludere kun ansatte av en gitt typeA = Arbeider
F = Funksjonær
Null = Alle (Default)


Returdata

Her er en beskrivelse og forklaring av returdata en får fra dette fravær API og hva det i praksis kan benyttes til. 

Felt

Beskrivelse

Eksempel

Merknad

clientidKlientnr100Klientnr er et unikt nr for hvert enkelt firma. For konsernkunder kjøres en request for hvert enkelt firma.
employeeidAnsattnr155
departmentIdAvdelingsnr50
firstnameFornavnOla
lastnameEtternavnDanielsen
address1Adresse 1Berghammeren 14
address2Adresse 2

countrycodeLandkodeNO
zipCodePostnr6500
phoneNumberTelefonnr

cellphonenumberMobilnr90012345
emailaddressepostadresseola@bedriften.no
isTimeActiveEr aktiv i TidTrueCapitech Tid modul. True eller False
isAbsenceActiveEr aktiv i FraværTrueCapitech Fravær modul. True eller False
isPlanActiveEr aktiv i PlanTrueCapitech Plan modul. True eller False
phoneNumber2Telefonnr 2

genderKjønnMK = Kvinne
M = Mann
birthdateFødselsdato100756Format ddmmyy
employeeStartDateAnsatt startdato2021-07-05 T00:00:00+02:00Format yyyy-mm-ddTHH:MM:SS inkludert tidssone
employeeEndDateAnsatt sluttdato
Format yyyy-mm-ddTHH:MM:SS inkludert tidssone
employeeSeniorityDateAnsatt ansiennitetsdato
Format yyyy-mm-ddTHH:MM:SS inkludert tidssone
externalIdekstern id
Id fra eksternt system som kan benyttes ved innlegging av ansatte inn til Capitech via API
wageGroupIdLønnsgruppenr10Nr på lønnsgruppe den ansatte tilhører
taskIdArbeidsoppgavenr25Nr på standard arbeidsoppgave om det er angitt på den ansatte
projectIdProsjektnr
Nr på standard prosjekt om det er angitt på den ansatte
subprojectIdUnderprosjektnr
Nr på standard underprosjekt om det er angitt på den ansatte
phaseIdFasenr
Nr på standard fase om det er angitt på den ansatte
orderIdOrdenr
Nr på standard ordre om det er angitt på den ansatte
freedimension1IdFri dimensjon 1 nr
Nr på standard fri dimensjon 1 om det er angitt på den ansatte
freedimension2IdFri dimensjon 2 nr
Nr på standard fri dimensjon 2 om det er angitt på den ansatte
costCarrierIdBærernr
Nr på standard kostnadsbærer om det er angitt på den ansatte
statisticsGroupCodeAnsatt typeFA = Arbeider
F = Funksjonær
registrationAccessRegistreringstilgang

Tilgang til registrering i Min Capitech

-2 = Ingen registrering, kun visning
-1 = Registrere inn og ut (her og nå)
0 = Registrering i dag 
X = Flere dager med etterregistrering (hvor x er antall dager og større enn 0)

Eksempel:
Om registrationaccess = 3 betyr det at den ansatte har tilgang til å etterregistrere timer for  opptil 3 dager bakover fra i dag. 


cardNumberkortnr188Kortnummer om det er angitt på den ansatte. (F.eks strekkode eller magnet kort)
RFIDRFIDnr45677844944746Nummer på RFID kort om det er angitt på den ansatte. 
hmsCardIdhmskortnr
Id fra HMS kort dersom dette er lagret på den ansatte. 
authenticationIdekstern brukeridola@bedriften.noEkstern brukerid som benyttes ved bruk av ekstern pålogging, f.eks Azure AD 

Tips

Du kan se mer detaljer om API parametere og returdata i en demoløsning her Demosalg.capitech.no/API

  • No labels