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 |
|---|---|---|---|
| accessToken | Ja | Token fra Login. | Kreves for å få svar på API request |
| clientId | Ja | Klientnummer for hvilket firma en skal hente ansatte fra | |
| departmentIdFilter | Nei | Filter for å hente kun ansatte på angitte avdelingsnr | |
| includeTimeActive | Nei | Filter for å inkludere kun ansatte som er aktiv i Tid | True / False Default er True |
| includeTimePassive | Nei | Filter for å inkludere kun ansatte som er passiv i Tid | True / False Default er False |
| includeAbsenceActive | Nei | Filter for å inkludere kun ansatte som er aktiv i Fravær | True / False Default er True |
| includeAbsencePassive | Nei | Filter for å inkludere kun ansatte som er passiv i Fravær | True / False Default er True |
| includePlanActive | Nei | Filter for å inkludere kun ansatte som er aktiv i Plan | True / False Default er True |
| includePlanPassive | Nei | Filter for å inkludere kun ansatte som er passiv i Plan | True / False Default er True |
| genderFilter | Nei | Filter for å inkludere kun ansatte av et kjønn | K = Kvinner M = Menn Null = Alle (Default) |
| wageGroupIdFilter | Nei | Filter for å inkludere kun ansatte som er med i en av angitte lønnsgruppenr | Ansatt kan kun være medlem i en lønnsgruppe |
| costCarrierIdFilter | Nei | Filter for å inkludere kun ansatte som har en av angitte bærernr | |
| statisticsGroupCodeFilter | Nei | Filter for å inkludere kun ansatte av en gitt type | A = 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 |
|---|---|---|---|
| clientid | Klientnr | 100 | Klientnr er et unikt nr for hvert enkelt firma. For konsernkunder kjøres en request for hvert enkelt firma. |
| employeeid | Ansattnr | 155 | Ansattnr |
| departmentId | Avdelingsnr | 50 | Nr på standard avdeling om det er angitt på den ansatte |
| firstname | Fornavn | Ola | Det finnes bare ett felt for navn. Fornavn og etternavn avledes slik: Alle bortsett fra siste navn i navnefelt Dersom komma i navnefelt, alle navn etter komma |
| lastname | Etternavn | Danielsen | Det finnes bare ett felt for navn. Fornavn og etternavn avledes slik: Siste navn fra navnefelt Dersom komma i navnefelt, alle navn før komma |
| address1 | Adresse 1 | Berghammeren 14 | |
| address2 | Adresse 2 | ||
| countrycode | Landkode | NO | Lankode for postnr / adresse |
| zipCode | Postnr | 6500 | |
| phoneNumber | Telefonnr | ||
| cellphonenumber | Mobilnr | 90012345 | |
| emailaddress | epostadresse | ola@bedriften.no | |
| isTimeActive | Er aktiv i Tid | true | Capitech Tid modul. true eller false |
| isAbsenceActive | Er aktiv i Fravær | true | Capitech Fravær modul. true eller false |
| isPlanActive | Er aktiv i Plan | true | Capitech Plan modul. true eller false |
| phoneNumber2 | Telefonnr 2 | ||
| gender | Kjønn | M | K = Kvinne M = Mann |
| birthdate | Fødselsdato | 100756 | Format ddmmyy |
| employeeStartDate | Ansatt startdato | 2021-07-05 T00:00:00+02:00 | Format yyyy-mm-ddTHH:MM:SS inkludert tidssone |
| employeeEndDate | Ansatt sluttdato | Format yyyy-mm-ddTHH:MM:SS inkludert tidssone | |
| employeeSeniorityDate | Ansatt ansiennitetsdato | Format yyyy-mm-ddTHH:MM:SS inkludert tidssone | |
| externalId | ekstern id | Id fra eksternt system som kan benyttes ved innlegging av ansatte inn til Capitech via API | |
| wageGroupId | Lønnsgruppenr | 10 | Nr på lønnsgruppe den ansatte tilhører |
| taskId | Arbeidsoppgavenr | 25 | Nr på standard arbeidsoppgave om det er angitt på den ansatte |
| projectId | Prosjektnr | Nr på standard prosjekt om det er angitt på den ansatte | |
| subprojectId | Underprosjektnr | Nr på standard underprosjekt om det er angitt på den ansatte | |
| phaseId | Fasenr | Nr på standard fase om det er angitt på den ansatte | |
| orderId | Ordenr | Nr på standard ordre om det er angitt på den ansatte | |
| freedimension1Id | Fri dimensjon 1 nr | Nr på standard fri dimensjon 1 om det er angitt på den ansatte | |
| freedimension2Id | Fri dimensjon 2 nr | Nr på standard fri dimensjon 2 om det er angitt på den ansatte | |
| costCarrierId | Bærernr | Nr på standard kostnadsbærer om det er angitt på den ansatte | |
| statisticsGroupCode | Ansatt type | F | A = Arbeider F = Funksjonær |
| registrationAccess | Registreringstilgang | 3 | Tilgang til registrering i Min Capitech -2 = Ingen registrering, kun visning |
| cardNumber | kortnr | 188 | Kortnummer om det er angitt på |
| den ansatte. (F.eks strekkode eller magnet kort) | |||
| RFID | RFIDnr | 45677844944746 | Nummer på RFID kort om det er angitt på den ansatte. |
| hmsCardId | hmskortnr | Id fra HMS kort dersom dette er lagret på den ansatte. | |
| authenticationId | ekstern brukerid | ola@bedriften.no | Ekstern brukerid som benyttes ved bruk av ekstern pålogging, f.eks Azure AD |
| nearestLeaderUserId | Nærmeste leder brukernavn | OleH | Brukernavn for nærmeste leder |
| nearestLeaderName | Nærmeste leder navn | Ole Hansen | Navn på nærmeste leder |
| nearestLeaderEmail | Nærmeste leder E-post | ole.hansen@bedriften.com | E-post adresse til nærmeste leder |
| countryCodeCellphone | Landkode mobilnr | 47 | Landkode for den ansattes mobilnr |
| willRegisterTime | Skal registrere tid | true | Den ansatte skal registrere tid |
| isFlexitimeActive | Er aktiv i fleksitid | true | Capitech fleksitid modul. true eller false |
| isSmsActive | Er aktiv i sms | true | Capitech sms modul. true eller false |
| isManualAdditionsActive | Er manuelle tillegg aktivert | true | Manuelle tillegg aktivert. true eller false |
| id | Unik id | 854 | Unik id for denne ansatte |
| Tip | ||
|---|---|---|
| ||
Du kan se mer detaljer om API parametere og returdata i en demoløsning her Demosalg.capitech.no/API |