Api doc


SDK's


Api Modules

reports.workunits



Supported Methods:

GET
Params
  • token (Required): valid token
  • start_date: varchar
  • end_date: varchar
  • employee: varchar
  • schedule: varchar
  • task: varchar
  • location: varchar
  • task_state: varchar
  • workunit: varchar
  • remote_site: varchar
  • group_results: enum (0, 1, 2)


Documentation

GET
Returns a list of worked units
Level 5 is required

--

Parameters:

  1. "start_date": accepted //Start date (varchar)
  2. "end_date": accepted //End date (varchar)
  3. "employee": accepted //Employee id (varchar)
  4. "schedule": accepted //Position id (varchar)
  5. "task": depricated
  6. "location": accepted //Location id (varchar)
  7. "task_state": depricated
  8. "workunit": accepted //Work Unit id - retrieve report only for this work unit (varchar)
  9. "remote_site": accepted //Remote site location id (varchar)
  10. "group_results": accepted /* Group results (enum [0, 1, 2])
  11.   0 - Default value - Don’t group
  12.   1 - Group by Employee
  13.   2 - Group by Employee & Position*/
  14. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"reports.workunits",
  3. "method":"GET",
  4. "request":{
  5. }
  6. }

Example Response:

  1. {
  2. "status": 1,
  3. "token": "xxxxxxx",
  4. "data": [
  5. {
  6. "end_time": "4:00pm",
  7. "cost": "27.5",
  8. "date": "Oct 8, 2014",
  9. "worked_units": "55",
  10. "workunit_name": "Staples",
  11. "employee_id": "878708",
  12. "position": "Student",
  13. "start_time": "8:00am",
  14. "payrate": "0.50",
  15. "d": "2014-10-08 08:00:00",
  16. "position_id": 605692,
  17. "employee": "John Doe",
  18. "location": "WorkShop",
  19. "employee_eid": null
  20. },
  21. {
  22. "end_time": "4:00pm",
  23. "cost": 10,
  24. "date": "Oct 8, 2014",
  25. "worked_units": "10",
  26. "workunit_name": "Cards",
  27. "employee_id": "878708",
  28. "position": "Student",
  29. "start_time": "8:00am",
  30. "payrate": "1.00",
  31. "d": "2014-10-08 08:00:00",
  32. "position_id": 605692,
  33. "employee": "John Doe",
  34. "location": "WorkShop",
  35. "employee_eid": null
  36. },
  37. {
  38. "end_time": "10:00pm",
  39. "cost": 10,
  40. "date": "Oct 8, 2014",
  41. "worked_units": "10",
  42. "workunit_name": "Cards",
  43. "employee_id": "878708",
  44. "position": "Student",
  45. "start_time": "7:00pm",
  46. "payrate": "1.00",
  47. "d": "2014-10-08 19:00:00",
  48. "position_id": 605692,
  49. "employee": "John Doe",
  50. "location": "WorkShop",
  51. "employee_eid": null
  52. },
  53. {
  54. "end_time": "N/A",
  55. "cost": "2.5",
  56. "date": "Oct 9, 2014",
  57. "worked_units": "5",
  58. "workunit_name": "Staples",
  59. "employee_id": "878708",
  60. "position": "Student",
  61. "start_time": "N/A",
  62. "payrate": "0.50",
  63. "d": "Oct 9, 2014",
  64. "position_id": 605692,
  65. "employee": "John Doe",
  66. "location": "WorkShop",
  67. "employee_eid": null
  68. }
  69. ]
  70. }

GET STARTED NOW

Free Trial. No Credit Card Required.

close
(e.g.+14158675309 or +1415-8675-309)

By clicking "Create my ShiftPlanning Account" you agree to the Terms of Service and Privacy Policy.

Have a promotional code?Click Here


LIVE CHAT DEMO REQUEST!

Please provide information below.

close
INSTANT DEMOSCHEDULED DEMO
Connect with a ShiftPlanning Team Member for a live demo right now!
 

RESELLER REQUEST!

Please provide information below.

close