GET Schedule Report
Changed on/reports/schedule Permission level: 5
get/reports/schedule
Request
- Base URLhttps://www.humanity.com/api/v2
- AuthAPI key in query parameter access_token
Query parameters
start_datestring date required
end_datestring date required
typestring required
enum[schedule_summary, shift_confirmed, crib_sheet, shift_exchanges, open_shifts, position_summary, shift_acknowledgement]
locationinteger
schedulestring
Array of schedule ids (eg. "234,563,770")
employeestring
Array of employees ids (eg. "234,563,770")
skillstring
with_statusesinteger
null : without statuses, isset: with statuses
optionsinteger
1: order by name
deductbreaksinteger
min value 1
remote_siteinteger
include_emp_per_posinteger
acknowledgement_statusstring
Response
200
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": "2012",
"weekday": "Sat",
"mname": "May",
"week": "20",
"dayid": 7,
"formatted": "May 19, 2012"
},
"end_date": {
"id": "1116",
"month": "5",
"day": "19",
"year": "2012",
"weekday": "Sat",
"mname": "May",
"week": "20",
"dayid": 7,
"formatted": "May 19, 2012"
},
"start": "11 am",
"end": "5 pm",
"length": "0",
"location": "0",
"confirmed": "0",
"schedule_name": "Development",
"schedule_color": "657050"
},
"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": "2012",
"weekday": "Sun",
"mname": "May",
"week": "20",
"dayid": 1,
"formatted": "May 20, 2012"
},
"end_date": {
"id": "1117",
"month": "5",
"day": "20",
"year": "2012",
"weekday": "Sun",
"mname": "May",
"week": "20",
"dayid": 1,
"formatted": "May 20, 2012"
},
"start": "8 am",
"end": "4 pm",
"length": "0",
"location": "0",
"confirmed": "0",
"schedule_name": "Cash",
"schedule_color": "570026"
}
},
"token": "xxxxxxx"
}Changes
- info
endpoint added
- info