Get all absences for all or specific employees.
Description
GET /absence_management/get_absences.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&start=YYYYMMDDHHIISS&end=YYYYMMDDHHIISS
Parameter
parameter | description | type | hint | mandatory |
|---|---|---|---|---|
| company | RTI company key | string | yes | |
| import | RTI import key | string | yes | |
| start | start of queried timerange | string | Format: YYYYMMDDHHIISS | yes |
| end | end of queried timerange | string | Format: YYYYMMDDHHIISS | yes |
| employeeNumbers | array of employee numbers | json | Restriction to specific employees If this parameter is not set, all absences of all employees, who own an employee number, will be returned Format: [ 'NR1','NR2', ... ] | no |
| withHolidays | return holidays as well | bool | Each employee can be assigned to a holiday profile. If this parameter is active, the holidays will be returned as absences as well. You can recognize such entries by the atrribute isHoliday = true. Default: true | no |
| withDeleted | return deleted absences as well | bool | Deleted absences are not returned by default. You can change this by setting this parameter to true. You can recognize such entries by the attribute "deleteDate" being set. Default: false | no |
| group | name of the personnel group to which the restriction is to be made | string | The exact name of a personnel group must be given | no |
Return value
A string in Json format is returned. Returns "ERROR:description" on error.
Attributes
attribute | format | description |
|---|---|---|
| employeeNumber | string | employee number for identification |
| createDate | string (according to ISO 8601) | null | create date of entry |
| deleteDate | string (according to ISO 8601) | null | delete date of entry |
| startDate | string (according to ISO 8601) | begin of absence |
| endDate | string (according to ISO 8601) | end of absence |
| factor | float | share of working day based on assigned work profile value is between 0 and 1 with 1 being equivalent to a full day |
| type | string | short name of absence type according to portal settings |
| remark | string | null | optional description text |
| isRestTime | bool | flag if this absence is an annual leave |
| isFlexTime | bool | flag if this absence is subtracted from flex time account |
| isHoliday | bool | flag if this absence is a holiday according to assigned holiday profile |
ignored
| object
| Absences with a long duration might exclude some days in between. weekDays: numbers of weekdays (value 0 to 6 = sunday to saturday), e.g. weekend calendarDays: explicit dates, e.g. a holiday |
workTime
| object
| Working time relevant data. Values can only be determined correctly if YellowTimeManager 3.0 has been booked and set up correctly.
|
Example
[
{
"employeeNumber": "0815",
"createDate": "2021-04-15T13:53:23+02:00",
"deleteDate": null,
"startDate": "2021-03-08T00:00:00+01:00",
"endDate": "2021-03-08T23:59:59+01:00",
"factor": 1,
"type": "BA",
"remark": null,
"isRestTime": false,
"isFlexTime": false,
"isHoliday": false,
"ignored": {
"weekDays": [],
"calendarDays": []
},
"workTime": {
"targetTimeInMinutes": 0,
"calculatedTimeInMinutes": 0
}
},
...
]