Api doc


SDK's


Api Modules

timeclock.clockin

Clock In Employee (Default: Authenticated User)



Supported Methods:

GET
Params
  • token (Required): valid token
  • employee: integer
  • photo: varchar
  • location: varchar
  • latitude: varchar
  • longitude: varchar
  • clock_in_time: time
  • tips: varchar


Documentation

GET
Clock In Employee (Default: Authenticated User)
Level 5 is required (all users can fetch this module)

--

Parameters:

  1. "employee": accepted //Employee id (integer)
  2. "photo": accepted /*Photo (varchar)
  3.   *eg.{"large":"timeclock/pic_250834.135402.jpg",
  4.   * "small":"timeclock/sm_250834.135402.jpg",
  5.   * "tiny":"timeclock/ti_250834.135402.jpg"}*/
  6. "location": accepted //Clock in localtion - IP adress (varchar)
  7. "latitude": accepted //Latitude (varchar)
  8. "longitude": accepted //Longitude (varchar)
  9. "clock_in_time": accepted /*Clock in time (time)
  10.   * eg. "Mar 11, 2015 01:33am"
  11.   * by default it is the current timestamp*/
  12. "tips": accepted //Tips (double)
  13. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"timeclock.clockin",
  3. "method":"GET",
  4. "request":{
  5. "employee":"746063"
  6. }
  7. }

Example Response:

  1. {
  2. "status":1,
  3. "data":{
  4. "id":"21928932",
  5. "store":"60393",
  6. "status":"0",
  7. "schedule":null,
  8. "notes":null,
  9. "created":"1426067560",
  10. "in_timestamp":"1426055580",
  11. "in_day":"2142",
  12. "out_timestamp":"0",
  13. "out_day":"0",
  14. "in_hour":"7",
  15. "out_hour":"0",
  16. "in_location":"82.117.214.54",
  17. "out_location":"Website",
  18. "in_terminal":"0",
  19. "out_terminal":"-98",
  20. "approved_by":"0",
  21. "approved_time":"0",
  22. "approved_notes":"",
  23. "in_picture":null,
  24. "out_picture":"",
  25. "screenshots":null,
  26. "break_time":"0",
  27. "start_timestamp":"2015-03-11 01:33:00",
  28. "end_timestamp":null,
  29. "in_picture_url":"",
  30. "out_picture_url":null,
  31. "in_gps":"{\"latitude\":\"\",\"longitude\":\"\",\"supported\":0}",
  32. "out_gps":null,
  33. "shift":null,
  34. "employee":{
  35. "id":"746063",
  36. "name":"John Doe"
  37. },
  38. "in_time":{
  39. "time":"01:33",
  40. "day":"Mar 11, 2015",
  41. "timestamp":"2015-03-11 01:33:00"
  42. },
  43. "length":[
  44.  
  45. ],
  46. "out_time":[
  47.  
  48. ],
  49. "current_length":{
  50. "hours":3,
  51. "mins":20,
  52. "total_hours":"3.33"
  53. },
  54. "events":[
  55.  
  56. ]
  57. },
  58. "token":"xxxxxxx"
  59. }

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