1.0 Beskrivelse
Det er muligt at trække data ud af Lessor Workforce, via API/Web Service. Servicen skal hentes af et 3. parts produkt; Lessor Workforce kan ikke sende/initiere data. Data leveres ud fra valgt selektering og skal efterfølgende behandles i et 3. parts program.
Data kan fx hente ved:
- Indtastning af URL i browservindue
- Via Excel
- Via ex programmet Postman
2.0 Forudsætninger
For at kunne hente data ud af Lessor Workforce, skal dette aktiveres på databasen.
Skriv til workforce.support@lessor.dk for at aktivere/tillade dette. Anmodning skal komme fra en administrator.
3.0 Opsætning
Data hentes ved hjælp af standard URL: https://workforce.lessor.dk/sync/exportShifts.php/?
Data kan sendes som POST eller Basic access authentication.
Tilføj følgende til URL, for at hente de ønskede data:
| Argumentnavn | Beskrivelse | Kravfelt | Kommentar |
| id | Database id | Ja | Databasens id oplyses ved kontakt til workforce.support@lessor.dk |
| user | Kan sendes som POST eller Basic access authentication. | Ja |
Brugernavn på administrator i Lessor Workforce. Vi anbefaler at oprette en bruger(admin), som kun benyttes til Web Services. Foretag første log ind med denne bruger for at ændre adgangskoden og brugeren kan efterfølgende deaktiveres. Brugeren vil stadig kunne kalde Web Servicen. |
| password | Kan sendes som POST eller Basic access authentication. | Ja | Adgangskoden der er blevet oprettet efter første log ind. |
| from |
yyyy-mm-dd tt:mm:ss |
Ja - Klokkeslæt kan udelades | |
| to |
yyyy-mm-dd tt:mm:ss |
Ja - Klokkeslæt kan udelades | |
| type |
planned = Viser planlagte vagter absence = Viser fravær absence_approved=Viser fravær som er blevet godkendt i anmodning (ikke i Timeregistrering) Ingen af to ovenstående argumenter tilføjet = Viser registrerede vagter |
Nej | Planned og Absence kan ikke begge tilføjes i samme URL. |
| includeFreeShifts | true = Ledige vagter medtages. | Nej | |
| extrainfo | 1 = Medtager vagtens pause tid, er pausen betalt, vagtens løngruppe, er vagten planlagt, er vagten frivilligt merarbejde | Nej | |
| includeapprover | 1 = Medtager dato og klokkeslæt for godkendelse, samt medarbjedernummer og navn på godkenderen. | Nej | Fungerer for registreringer og fravær. |
| company | Der kan begrænses på firma. Denne er kun anvendelig såfremt flere afdelinger har samme navn. Company kan ikke benyttes alene. | Nej |
Som default medtages vagter som ”hvor”. Alle planlagte vagter medtages i nævnte firma. Der kan tilføjes flere. |
| department |
Der kan begrænses på afdeling. Findes der flere afdelinger med samme navn, skal der også benyttes company. |
Nej |
Som default medtages vagter som ”hvor”. Alle planlagte vagter medtages i nævnte afdeling. Der kan tilføjes flere ved at adskille afdelingsnavne med komma (uden mellemrum). |
| groups | Der kan begrænses på gruppe | Nej |
Som default medtages vagter som ”hvor”. Alle planlagte vagter medtages i nævnte gruppe. Der kan tilføjes flere ved at adskille gruppenavne med komma (uden mellemrum). |
| employee | Der kan begrænses på en enkelt medarbejder | Nej | Medarbejdernummer benyttes til at definere medarbejderen. |
| look_up_method | Who = Hvem | Nej | Viser vagter for medarbejdere med de valgte afdelinger/grupper som deres primære. |
| addtime | 1 = Tilføjer vagtens varighed i minutter | Nej | |
| usestampcode | 1 = Viser stemplingskode i stedet for gruppekode | Nej | Kun relevant i forbindelse med udtræk af registreringer (intet valgt i type). |
| ccCode | 1 = Viser vagtens Cost Center kode | Nej | |
| note | 1= Viser noten | Nej | |
| shiftAllowance | 1= Medtager vagttillæg | Nej | Sendes som JSON. Æ, ø, å vises herefter. Kun på type=planned |
Eksempel på opbygning af URL:
Ekstra parametre tilføjes ved at skrive &group=xxxx
3.1 Levering af data – Planlagte Vagter
De hentede data leveres i følgende format/rækkefølge:
| Feltnavn | Format | Bemærkning | Parameter styret |
| Gruppekoden | Numerisk | Gruppens kode | |
| Gruppenavn | AN | Gruppens navn | |
| Afdelingskode | AN | Afdelingens kode | |
| Afdelingsnavn | AN | Afdelingens navn | |
| Medarbejder nr. | AN | Medarbejderens nr. | |
| Medarbejder navn | AN | Felterne: Fornavn og efternavn | |
| Start dato og tid | YYYY-MM-DD TT:MM:SS | Dato og tid, for vagt start | |
| Slut dato og tid | YYYY-MM-DD TT:MM:SS | Dato og tid, for vagt slut | |
| Tid | MM | Minutter | |
| Aktiv | 0/1 | 0 = Vagt inaktiv 1 = Vagt Aktiv | |
| Id. | Numerisk | Vagtens unikke id | |
| Cost Center kode | AN | Vagtens Cost Center kode | ccCode = 1 |
| Pause | Numerisk | Antal minutter | &extrainfo=1 |
| Betalt pause | 0/1 |
0 = Ikke betalt 1 = Betalt |
&extrainfo=1 |
| Løngruppe navn | AN | Løngruppens navn | &extrainfo=1 |
| Ledige vagter | True | Medtager Ledige vagter | &includeFreeShifts |
| Pause | Numerisk | Antal minutter | &extrainfo=1 |
| Betalt pause |
0 = Ikke betalt 1 = Betalt |
&extrainfo=1 | |
| Løngruppens navn | AN | &extrainfo=1 | |
| Er vagten planlagt | 0/1 |
0 = Nej 1 = Ja |
&extrainfo=1 |
| Er vagten frivilligt merarbejde | 0/1 |
0 = Nej 1 = Ja |
&extrainfo=1 |
| Vagtens note | AN | ¬e=1 | |
| Vagttillæg | AN |
Sendes som JSON. Fx [{"name":"Tilkald","amount":100,"units":3,"payType":"9700"}]
|
&shiftAllowance=1 |
3.2 Levering af data – Registreringer
De hentede data leveres i følgende format/rækkefølge:
| Feltnavn | Format | Bemærkning | Parameter styret |
| Gruppekoden | Numerisk | Gruppens kode | |
| Gruppenavn | AN | Gruppens navn | |
| Afdelingskode | AN | Afdelingens kode | |
| Afdelingsnavn | AN | Afdelingens navn | |
| Medarbejder nr. | AN | Medarbejderens nr. | |
| Medarbejder navn | AN | Felterne: Fornavn og efternavn | |
| Start dato og tid | YYYY-MM-DD TT:MM:SS | Dato og tid, for registreret mødt | |
| Slut dato og tid | YYYY-MM-DD TT:MM:SS | Dato og tid, for registreret gået | |
| Stemplingskode | Numerisk | Stemplingskode | &usestampcode=1 |
| Aktiv | 0/1 |
0 = Ikke godkendt 3 = Godkendt
|
|
| Id. | Numerisk | Vagtens unikke id | |
| Cost Center kode | AN | Vagtens Cost Center kode | ccCode = 1 |
| Pause | Numerisk | Antal minutter | &extrainfo=1 |
| Betalt pause |
0 = Ikke betalt 1 = Betalt |
&extrainfo=1 | |
| Løngruppens navn | AN | &extrainfo=1 | |
| Er registreringen planlagt | 0/1 |
0 = Nej 1 = Ja |
&extrainfo=1 |
| Er registreringen frivilligt merarbejde | 0/1 |
0 = Nej 1 = Ja |
&extrainfo=1 |
| Registreringens note | AN | Viser noter tilføjet på registreringen i Timeregistrering | ¬e=1 |
3.3 Levering af data – Fravær
De hentede data leveres i følgende format/rækkefølge:
| Feltnavn | Format | Bemærkning | |
| Gruppekoden | Numerisk | Gruppens kode | |
| Gruppenavn | AN | Gruppens navn | |
| Afdelingskode | AN | Afdelingens kode | |
| Afdelingsnavn | AN | Afdelingens navn | |
| Medarbejder nr. | AN | Medarbejderens nr. | |
| Medarbejder navn | AN | Felterne: Fornavn og efternavn | |
| Start dato og tid | YYYY-MM-DD TT:MM:SS | Dato og tid, for fravær start | |
| Slut dato og tid | YYYY-MM-DD TT:MM:SS | Dato og tid, for fravær slut | |
| Fraværets længde | MM | Længde i minutter | |
| Id. | Numerisk | Fraværets unikke id | |
| Cost Center Kode | AN | Tilføj parameter &ccCode=1 | |
| Fraværskode | AN | Koden/lønarten på fraværet | |
| Fraværsnavn | AN |
Tilføj Parameter &usename=1 (kommer i stedet for fraværskoden) |
|
| Pause | Numerisk | Tilføj parameter &extrainfo=1 | |
| Betalt pause |
0 = Ikke betalt 1 = Betalt |
Tilføj parameter &extrainfo=1 | |
| Løngruppens navn | AN | Tilføj parameter &extrainfo=1 | |
| Er fraværet planlagt | 0/1 |
0 = Nej 1 = Ja |
|
| Note | AN | Tilføj parameter ¬e=1 |