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/getSalaryExport.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. |
| salaryGroup | Navn på løngruppe | Ja, hvis ikke afregningsgruppe, medarbejdernummer, firmanavn, gruppenavn, CostCenter, CostCenter gruppering eller afdelingsnavn benyttes | |
| salaryGroupCollection | Navn på afregningsgruppe | Ja, hvis ikke løngruppe, medarbejdernummer, firmanavn, gruppenavn, CostCenter, CostCenter gruppering eller afdelingsnavn benyttes | |
| employeeNumber | Medarbejdernummer | Ja, hvis ikke løngruppe, afregningsgruppe, firmanavn, gruppenavn CostCenter, CostCenter gruppering eller afdelingsnavn benyttes | |
| company | Firmanavn | Ja, hvis ikke løngruppe, medarbejdernummer, afregningsgruppe, CostCenter, CostCenter gruppering, gruppenavn eller afdelingsnavn benyttes | |
| department | Afdelingsnavn | Ja, hvis ikke løngruppe, medarbejdernummer, afregningsgruppe, CostCenter, CostCenter gruppering, gruppenavn eller firmanavn benyttes | |
| group | Gruppenavn | Ja, hvis ikke løngruppe, medarbejdernummer, afregningsgruppe, firmanavn, CostCenter, CostCenter gruppering eller afdelingsnavn benyttes | |
| costCenter | Navn på CostCenter | Ja, hvis ikke løngruppe, medarbejdernummer, afregningsgruppe, firmanavn, gruppenavn, CostCenter gruppering eller afdelingsnavn benyttes | |
| costCenterCollection | Navn på CostCenter gruppering | Ja, hvis ikke løngruppe, medarbejdernummer, afregningsgruppe, firmanavn, CostCenter, gruppenavn eller afdelingsnavn benyttes | |
| salaryExportTemplate | Navn på eksportfil | Ja | |
| startDate | Startdato | Ja, yyyymmdd eller yyyy-mm-dd | |
| endDate | Slutdato | Ja, yyyymmdd eller yyyy-mm-dd | |
| lockShifts | Lås vagter | Nej 0 = Nej 1 = Lås vagter | |
| show_deactivated | Inkluder deaktiverede medarbejdere | Nej 0 = Nej 1 = Medtager deaktiverede medarbejdere | |
| getOld | Medtag registreringer før valgt startdato | Nej 0 = Nej 1 = Medtager vagter | |
| exportShifts | Marker, i Timeregistrering, at registrering er eksporteret | Nej 0 = Nej 1 = Sætter markering | |
| getAsFile | Modtag som fil | Nej 0 = Nej 1 = Modtager eksporten som fil |
Eksempel på opbygning af URL:
https://workforce.lessor.dk/sync/getSalaryExport.php/?id=xxx&startDate=20200316&endDate=20200415
Ekstra parametre tilføjes ved at skrive fx &exportShifts=1
3.1 Levering af data
De hentede data leveres i det format der er defineret i opsætningen af eksportfilen.