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, shift_confirmed, crib_sheet, shift_exchanges, open_shifts, position_summary, shift_acknowledgement) | Type schedule_summary: Schedule summary shift_confirmed: Confirmed shifts crib_sheet: Crib sheet shift_exchanges: Shift exchanges open_shifts: Open shifts position_summary: Position summary |
| location (accepted) | integer | Location id |
| schedule (accepted) | integer | Schedule id |
| employee (accepted) | integer | Employees Array of employees ids (eg. "234,563,770") |
| skill (accepted) | integer | Skill id |
| with_statuses (accepted) | integer | With or without statuses null : without statuses isset: with statuses |
| options (accepted) | integer | 1: Order by name |
| deductbreaks (accepted) | integer | Deduct breaks |
| remote_site (accepted) | integer | Remote site id |
| include_emp_per_pos (accepted) | integer | Include employees per position |
| acknowledgement_status (accepted) | varchar | Acknowledgement status |
DOCUMENTATION
GET
Retrives a list of schedule reports betwen selected dates.
Level 5 is required (all users can fetch this module)
--
Example Request:
{
"method":"GET",
"module":"reports.schedule",
"request":{
"start_date":"May 19, 2017",
"end_date":"May 21, 2017",
"type":"open_shifts"
}
}
Example Response:
{
"status":1,
"data":{
"82185":{
"id":"82185",
"series":"82015",
"created":"1311728514",
"published":"1339668653",
"edited":"1311728514",
"deleted":"0",
"recurs":"1",
"recur_rule":"2",
"schedule":"866",
"store":"11",
"type":"1",
"needed":"1",
"have":"0",
"working":"0",
"user":"2",
"start_date":{
"id":"1116",
"month":"5",
"day":"19",
"year":"2017",
"weekday":"Sat",
"mname":"May",
"week":"20",
"dayid":7,
"formatted":"May 19, 2017"
},
"end_date":{
"id":"1116",
"month":"5",
"day":"19",
"year":"2017",
"weekday":"Sat",
"mname":"May",
"week":"20",
"dayid":7,
"formatted":"May 19, 2017"
},
"start":"11 am",
"end":"5 pm",
"length":"0",
"title":"",
"location":"0",
"notes":"",
"confirmed":"0",
"schedule_name":"Development",
"schedule_color":"657050",
"employee":[
null
]
},
"93829":{
"id":"93829",
"series":"0",
"created":"1337631224",
"published":"1339668653",
"edited":"1337631231",
"deleted":"0",
"recurs":"0",
"recur_rule":"0",
"schedule":"32410",
"store":"11",
"type":"1",
"needed":"3",
"have":"0",
"working":"0",
"user":"5148",
"start_date":{
"id":"1117",
"month":"5",
"day":"20",
"year":"2017",
"weekday":"Sun",
"mname":"May",
"week":"20",
"dayid":1,
"formatted":"May 20, 2017"
},
"end_date":{
"id":"1117",
"month":"5",
"day":"20",
"year":"2017",
"weekday":"Sun",
"mname":"May",
"week":"20",
"dayid":1,
"formatted":"May 20, 2017"
},
"start":"8 am",
"end":"4 pm",
"length":"0",
"title":"",
"location":"0",
"notes":"",
"confirmed":"0",
"schedule_name":"Cash",
"schedule_color":"570026",
"employee":[
null
]
},
"93901":{
"id":"93901",
"series":"0",
"created":"1337632834",
"published":"1339668653",
"edited":"1337934987",
"deleted":"0",
"recurs":"0",
"recur_rule":"0",
"schedule":"32408",
"store":"11",
"type":"1",
"needed":"5",
"have":"0",
"working":"0",
"user":"4910",
"start_date":{
"id":"1119",
"month":"5",
"day":"22",
"year":"2017",
"weekday":"Tue",
"mname":"May",
"week":"21",
"dayid":3,
"formatted":"May 22, 2017"
},
"end_date":{
"id":"1119",
"month":"5",
"day":"22",
"year":"2017",
"weekday":"Tue",
"mname":"May",
"week":"21",
"dayid":3,
"formatted":"May 22, 2017"
},
"start":"8 am",
"end":"5 pm",
"length":"0",
"title":"",
"location":"0",
"notes":"",
"confirmed":"0",
"schedule_name":"Admin\/meetings",
"schedule_color":"484948",
"employee":[
null
]
}
},
"token":"xxxxxxx"
}