Get absences delta report - absenceio/PublicAPI GitHub Wiki
##Get absences delta report
POST publicApi/reporting/absences/deltas?apiKey=<apiKey here>
##Body
{
"filter": {
"start": "",
"end": "",
"departments" : ["one", ... ],
"status" : "new",
...
}
}
| parameter | type | optional | comment |
|---|---|---|---|
| start | date | required | yyyy-MM-dd |
| end | date | required | yyyy-MM-dd |
| departments | array | optional | ['department_1', 'department_2'] (optional) |
| users | array | optional | ['[email protected]', '[email protected]'] (optional) |
| reasons | array | optional | ['reason_1', 'reason_2'] (optional) |
| status | string | optional | 'new', 'updated', 'deleted' |
Returns absences delta report.
{
"data": [
{
"_id": "1576276edf869a0200713542",
"name": "Some Name",
"firstName": "Some",
"lastName": "Name",
"employeeId": "testId1234",
"absences": [
{
"_id": "1576276edf869a0200713542",
"start": "2015-09-21T00:00:00.000Z",
"end": "2015-09-24T00:00:00.000Z",
"daysCount": 4,
"totalDays": 4,
"reason": {
"name": "Urlaub",
"_id": "1576276edf869a0200713542"
},
"status": "New"
},
...
],
},
...
],
count: 5
}
####You can expect to get the following response:
| parameter | type | default |
|---|---|---|
| data | array | |
| count | int |
##data array
| parameter | type | default |
|---|---|---|
| _id | string | |
| name | string | |
| firstName | string | |
| lastName | string | |
| employeeId | string | |
| absences | array |
##absences array
| parameter | type | comment |
|---|---|---|
| _id | int | |
| start | date | on new/updated |
| end | date | on new/updated |
| daysCount | number | on new/updated |
| totalDays | number | on new/updated/deleted |
| reason | object | on new/updated/deleted |
| status | string | on new/updated/deleted |
| originalStart | date | on updated/deleted |
| originalEnd | date | on updated/deleted |
| originalDaysCount | number | on updated/deleted |
| originalTotalDays | number | on updated/deleted |
| originalReason | object | on updated/deleted |
##reason object
| parameter | type | default |
|---|---|---|
| _id | string | |
| name | string |