Bruke API for å hente fravær fra Capitech

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

Fravær i Capitech kan hentes ut på to nivå:

A. Fravær pr ansatt og periode
Dette er et nivå mange system bruker hvor en i hovedtrekk har hvilken ansatt, fraværskode, fra og til dato samt fraværsprosent mv.

For dette benyttes API endepunkt api/public/v1/Absence/getAbsence

B. Fravær pr ansatt og periode med klokkeslett og timer pr dag
Dette er et mer detaljert nivå med informasjon om klokkeslett og antall timer fravær for hver dag. Om det benyttes plan modul kan det også være flere vakter med fravær på samme dag og dermed flere sett med klokkeslett og timer på samme dag.

For dette benyttes API endepunkt api/public/v1/Absence/getAbsenceTransactions

Absence API - getAbsence

Fravær pr ansatt pr periode

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

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 timer på
fromDate	Ja	Fradato for ønsket periode i format yyyy-mm-dd	Fra og med
toDate	Ja	Tildato for ønsket periode i format yyyy-mm-dd	Til og med
updateFromDateFilter	Nei	Filter for å kun hente fravær som er opprettet eller oppdatert på eller etter angitt dato og evt. klokkeslett. Format: yyyy-mm-dd for kun dato eller yyyy-mm-dd 00:00:00.000 for dato og klokkeslett	Fra og med
absenceIdFilter	Nei	Filter for å kun hente fravær med angitt id
employeeIdFilter	Nei	Filter for å kun hente fravær på angitte ansattnr
departmentIdFilter	Nei	Filter for å hente kun fravær på angitte avdelingsnr
absenceCodeFilter	Nei	Filter for å hente kun fravær på angitte Capitech fraværskoder	Eksempel AVS for avspasering eller BAR for barns sykdom, dette er avhengig av kundens oppsett av fraværskoder.
absenceTypeFilter	Nei	Filter for å hente kun fravær på angitte Capitech fraværstyper	Dette er faste systemtyper i Capitech fravær uavhengig av kundens oppsett 1: Fravær 2: Avspasering 3: Ferie 4: Permisjon 5: Permittert

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

Felt	Beskrivelse	Eksempel	Merknad
absenceId	Fraværsid	488788	En unik id for hvert enkelt fravær
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
employee	ansattnavn	Ola Danielsen
absenceCode	Fraværskode	EGM	Fraværskode er et konfigurerbart oppsett pr klient (firma)
absenceDescription	Fraværskode navn	Egenmelding
absenceType	Fraværstype	1	Dette er faste systemtyper i Capitech fravær uavhengig av kundens oppsett 1: Fravær 2: Avspasering 3: Ferie 4: Permisjon 5: Permittert
absenceCertificationType	Egenmelding/Sykemelding	1	Dette er faste systemtyper i Capitech fravær uavhengig av kundens oppsett 0: Hverken egenmelding eller sykemelding 1: Egenmelding 2: Egenmelding barns sykdom 3: Sykemelding
fromDate	Fravær startdato	2021-07-10	Dato fraværet starter
endDate	Fravær sluttdato	2021-07-10	Dato fraværet slutter
starttime	Fravær fra klokkeslett	08:00:00.000	Kun utfylt dersom dette er angitt av bruker og likt for alle dager i perioden Fravær klokkeslett beregnes iht. avtalt arbeidstid i Capitech og kan variere fra dag til dag.
endtime	Fravær til klokkeslett	16:00:00.000	Kun utfylt dersom dette er angitt av bruker og likt for alle dager i perioden. Fravær klokkeslett beregnes iht. avtalt arbeidstid i Capitech og kan variere fra dag til dag.
hours	Timer	7.50	Antall timer fravær
absencePercent	Fraværsprosent	100	Default 100, kan være angitt til f. eks 50 i graderte sykemeldinger mv.
departmentId	Avdelingsnr	50	Nr på avdelingen fraværet er registrert på
department	Avdeling navn	Logistikk	Navn på avdelingen fraværet er registrert på
vacationDays	Feriedager	0	Antall feriedager benyttet i dette fravær. Kun dersom fravær av type ferie.
isAbsenceInstance	Er fraværstilfelle	true	Kun for sykefravær, true om dette fraværet er fraværstilfelle. Kan være satt false f.eks om ansatt måtte dra hjem fra jobb og det er registrert egenmelding men at fraværet ikke skal telles som tilfelle.
isSelfCertifiedAbsence	Egenmelding	true	true om det er fravær av type egenmelding
selfCertifiedAbsenceDays	Egenmelding dager	1	Antall dager egenmelding i dette fravær
workRelated	Arbeidsrelatert	false	true om det er angitt på fraværet at det er arbeidsrelatert
createdOn	Opprettet dato og klokkeslett	2021-07-10 08:02:00.000
createdBy	Brukernavn som opprettet fraværet	trineg
updatedOn	Sist endret dato og klokkeslett	2021-07-11 14:05:00.000
updatedBy	Brukernavn som sist endret fraværet	larsb

Returnerer alle fravær iht. parametere som angitt og er helt eller delvis innenfor angitt periode. Bestiller en f. eks fravær for 01 - 30 Juni vil også et fravær som går fra 20 Mai tom. 01 Juni bli med.

Begrensninger

Maks 366 dager periode i fra - til dato vil aksepteres
Om returdata vil overstige 1000 records vil forespørselen avvises, avgrens med kortere datointervall eller andre filter for å redusere datamengde.

Absence API - getAbsenceTransactions

Fravær pr ansatt pr periode pr dag med detaljer

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

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 timer på
fromDate	Ja	Fradato for ønsket periode i format 'yyyy-mm-dd'	Fra og med
toDate	Ja	Tildato for ønsket periode i format 'yyyy-mm-dd'	Til og med
updateFromDateFilter	Nei	Filter for å kun hente fravær som er oppdatert etter angitt dato. Format: 'yyyy-mm-dd'
absenceIdFilter	Nei	Filter for å kun hente fravær med angitt id
employeeIdFilter	Nei	Filter for å kun hente fravær på angitte ansattnr
departmentIdFilter	Nei	Filter for å hente kun fravær på angitte avdelingsnr
absenceCodeFilter	Nei	Filter for å hente kun fravær på angitte Capitech fraværskoder	Eksempel AVS for avspasering eller BAR for barns sykdom, dette er avhengig av kundens oppsett av fraværskoder.
absenceTypeFilter	Nei	Filter for å hente kun fravær på angitte Capitech fraværstyper	Dette er faste systemtyper i Capitech fravær uavhengig av kundens oppsett 1: Fravær 2: Avspasering 3: Ferie 4: Permisjon 5: Permittert
includeAllDetails	Nei	Inkludere alle dagtransaksjoner	Om utelatt returneres kun dagtransaksjoner som er innen angitt fra - til dato, dersom denne settes til true inkluderes også transaksjoner på det aktuelle fraværet som er utenfor fra - til dato.
includeDeleted	Nei	True / False parameter med default false. Hvis denne settes til true inkluderes slettede fravær i returdata

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

Felt	Beskrivelse	Eksempel	Merknad
absenceId	Fraværsid	488788	En unik id for hvert enkelt fravær
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
employee	ansattnavn	Ola Danielsen
absenceCode	Fraværskode	EGM	Fraværskoder er et konfigurerbart oppsett pr klient (firma)
absenceDescription	Fraværskode navn	Egenmelding
absenceType	Fraværstype	1	Dette er faste systemtyper i Capitech fravær uavhengig av kundens oppsett 1: Fravær 2: Avspasering 3: Ferie 4: Permisjon 5: Permittert
absenceCertificationType	Egenmelding/Sykemelding	1	Dette er faste systemtyper i Capitech fravær uavhengig av kundens oppsett 0: Hverken egenmelding eller sykemelding 1: Egenmelding 2: Egenmelding barns sykdom 3: Sykemelding
fromDate	Fravær startdato	2021-07-10	Dato fraværet starter
endDate	Fravær sluttdato	2021-07-10	Dato fraværet slutter
starttime	Fravær fra klokkeslett		Kun utfylt dersom dette er angitt av bruker og likt for alle dager i perioden Fravær klokkeslett beregnes iht. avtalt arbeidstid i Capitech og kan variere fra dag til dag.
endtime	Fravær til klokkeslett		Kun utfylt dersom dette er angitt av bruker og likt for alle dager i perioden. Fravær klokkeslett beregnes iht. avtalt arbeidstid i Capitech og kan variere fra dag til dag.
hours	Timer	7.50	Antall timer fravær
absencePercent	Fraværsprosent