SUPPORTED METHODS:
GET
Parameters | Type | Description |
---|---|---|
token (required) | Valid token | |
fields (required) | varchar | Fields Allowed fields: type = 'timesheets': 'employee', 'eid', 'user', 'location', 'schedule_id', 'schedule_name','start_day', 'end_day', 'start_time', 'end_time', 'total_time', 'notes' type = 'confirmedtimesheets': 'employee', 'eid', 'user', 'location', 'schedule_id', 'schedule_name', 'start_day', 'end_day', 'start_time', 'end_time', 'total_time', 'rate', 'ratecard', 'special', 'overtime', 'cost', 'notes' type = 'shifts': 'employee', 'eid', 'user', 'location', 'schedule_id', 'schedule_name', 'start_day', 'end_day', 'start_time', 'end_time', 'total_time','title','notes' type = 'confirmedshifts': 'employee', 'eid', 'user', 'location', 'schedule_id', 'schedule_name', 'start_day', 'end_day', 'start_time', 'end_time', 'total_time','title','notes' type = 'openshifts': 'employees', 'slots', 'location', 'schedule_id', 'schedule_name', 'start_day', 'end_day', 'start_time', 'end_time', 'total_time', 'title','notes', 'published' |
start_date (required) | date | Start date |
end_date (required) | date | End date |
type (required) | enum (timesheets, confirmedtimesheets, shifts, confirmedshifts, openshifts) | Type timesheets, confirmedtimesheets, shifts, confirmedshifts openshifts |
schedule (accepted) | integer | Schedule id |
employee (accepted) | varchar | Employee |
location (accepted) | integer | Location id |
skill (accepted) | integer | Skill id |
deduct_breaks (accepted) | min length 1 | isset: Deduct breaks |
remote_site (accepted) | integer | Remote site id |
options | varchar |
DOCUMENTATION
GET
Retrieves a list of custom reports.
Level 3 is required.
--
Example Request:
{
"module":"reports.custom",
"method":"GET",
"request":{
"fields":"employee",
"start_date":"May 19, 2017",
"end_date":"May 20, 2017",
"type":"confirmedshifts"
}
}
Example Response:
{
"status":"1",
"data":[
{
"employee":"Alan"
},
{
"employee":"Bond"
},
{
"employee":"Brian"
},
{
"employee":"Peter"
},
{
"employee":"stewie "
}
],
"token":"xxxxxxx"
}