Api doc


SDK's


Api Modules

timeclock.timeclocks

Returns a list of all Time Clocks.



Supported Methods:

GET
Params
  • token (Required): valid token
  • start_date: date
  • end_date: date
  • schedule: integer
  • employee: integer
  • status: enum (approved, unapproved)
  • page: integer
  • per_page: integer
  • order_by: enum (id, end_timestamp)
  • direction: enum (asc, desc)


Documentation

GET
Returns a list of schedules.
Level 5 is required

--

Parameters:

  1. "start_date": accepted //Start date (date)
  2. "end_date": accepted //End date (date)
  3. "schedule": accepted //Schedule id (integer)
  4. "employee": accepted //Employee id (integer)
  5. "status": accepted //Status (enum[unapproved,approved])
  6. /* unapproved: Unapproved timeclocks
  7.   * approved: Approved timeclocks */
  8. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"timeclock.timeclocks",
  3. "method":"GET",
  4. "request":{
  5. "start_date":"11/14/2013",
  6. "end_date":"11/14/2013"
  7. }
  8. }

Example Response:

  1. {
  2. "status":1,
  3. "data":[{
  4. "store": "18769",
  5. "in_terminal": "0",
  6. "break_time": "21",
  7. "approved_time": "0",
  8. "out_gps": "{\"latitude\":\"\",\"longitude\":\"\",\"supported\":0}",
  9. "in_picture": null,
  10. "out_picture_url": "",
  11. "out_hour": "18",
  12. "out_terminal": "-98",
  13. "length": {
  14. "total_hours": "0.02",
  15. "hours": 0,
  16. "mins": 1
  17. },
  18. "in_gps": "{\"latitude\":\"\",\"longitude\":\"\",\"supported\":0}",
  19. "out_day": "1660",
  20. "out_timestamp": "1384427970",
  21. "in_picture_url": "",
  22. "remote_site": null,
  23. "schedule": {
  24. "name": "Kids",
  25. "id": "153311"
  26. },
  27. "in_hour": "18",
  28. "events": [
  29. {
  30. "clock_time": "3952824",
  31. "type": "3",
  32. "data": {"notes": "shift notes"},
  33. "timestamp": "2013-11-14 04:18:13",
  34. "id": "11741"
  35. },
  36. {
  37. "clock_time": "3952824",
  38. "type": "6",
  39. "data": {"position": "153311"},
  40. "timestamp": "2013-11-14 04:18:24",
  41. "id": "11742"
  42. },
  43. {
  44. "clock_time": "3952824",
  45. "type": "1",
  46. "data": null,
  47. "timestamp": "2013-11-14 04:18:45",
  48. "id": "11743"
  49. },
  50. {
  51. "clock_time": "3952824",
  52. "type": "2",
  53. "data": {"breakin": "11743"},
  54. "timestamp": "2013-11-14 04:19:06",
  55. "id": "11744"
  56. }
  57. ],
  58. "in_timestamp": "1384427881",
  59. "in_location": "devtest2",
  60. "shift": null,
  61. "screenshots": null,
  62. "in_day": "1660",
  63. "status": "0",
  64. "approved_by": "0",
  65. "end_timestamp": "2013-11-14 04:19:30",
  66. "id": "3952824",
  67. "out_time": {
  68. "day": "Nov 14, 2013",
  69. "timestamp": "2013-11-14 04:19:30",
  70. "time": "4:19am"
  71. },
  72. "approved_notes": "",
  73. "out_picture": "",
  74. "created": "0",
  75. "out_location": "devtest2",
  76. "in_time": {
  77. "day": "Nov 14, 2013",
  78. "timestamp": "2013-11-14 04:18:01",
  79. "time": "4:18am"
  80. },
  81. "notes": "shift notes",
  82. "employee": {
  83. "name": "Lisa",
  84. "id": "258265"
  85. },
  86. "start_timestamp": "2013-11-14 04:18:01",
  87. "current_length": {
  88. "total_hours": "0.03",
  89. "hours": 0,
  90. "mins": 2
  91. }
  92. }],
  93. "token":"xxxxxxx"
  94. }

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