SUPPORTED METHODS:
GET
| Parameters | Type | Description |
|---|---|---|
| token (required) | Valid token | |
| start_date (required) | date | Start date |
| end_date (required) | date | End date |
| type (required) | enum (schedule_summary, shifts_confirmed, crib_sheet, shift_exchanges, shifts_summary, open_shifts, position_summary, daily_peak_hours, budget, confirmed_timesheets, all_timesheets, group_statistics) | |
| account (accepted) | integer | Account id |
| location (accepted) | integer | Location id |
| schedule (accepted) | integer | Position id |
| employee (accepted) | integer | Employee id |
| skill (accepted) | integer | Skill id |
| options (accepted) | integer | Options |
| deduct_breaks (accepted) | enum (0, 1) | 0: do not desuct breaks 1: deduct breaks |
| split_overnight (accepted) | enum (0, 1) | 0: do not split overnight 1: split overnight |
| group_results (accepted) | enum (0, 1) | 0: do not group results 1: group results |
DOCUMENTATION
GET
Group Account Management - Returns a list of all accounts in the Group.
Level 3 is required
--
Example Request:
{
"method":"GET",
"module":"group.reports",
"request":{
"start_date":"March 1,2017",
"end_date":"March 5,2017",
"type":"schedule_summary",
"employee":"2097936"
}
}
Example Response:
{
"status": 1,
"data": {
"users": [
{
"id": "2097936",
"name": "Test Employee",
"store": "202039",
"eid": "",
"group_id": "2",
"location": "574075",
"shifts": [
{
"id": "386133309",
"start": "37",
"schedule": "1068294",
"end": "69",
"published": "1488563669",
"edited": "1488467096",
"start_date": "2864",
"end_date": "2864",
"start_timestamp": "2017-03-02 09:00:00",
"end_timestamp": "2017-03-02 17:00:00",
"schedule_name": "1w -test5",
"schedule_color": "3",
"users": "2097936"
}
],
"total": 8,
"reports": {
"2864": [
{
"id": "386133309",
"schedule_name": "1w -test5",
"schedule": "1068294",
"schedule_color": "E5922D",
"start": "9:00am",
"end": "5:00pm",
"hours": 8
}
]
}
}
],
"dates": [
{
"id": 2863,
"formatted": "Mar 1, 2017",
"total": 0
},
{
"id": 2864,
"formatted": "Mar 2, 2017",
"total": 8
},
{
"id": 2865,
"formatted": "Mar 3, 2017",
"total": 0
},
{
"id": 2866,
"formatted": "Mar 4, 2017",
"total": 0
},
{
"id": 2867,
"formatted": "Mar 5, 2017",
"total": 0
}
],
"total": 8
},
"token": "xxxxxxx"
}