Api doc


SDK's


Api Modules

timeclock.clockout

Clock Out Employee (Default: Authenticated User)



Supported Methods:

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


Documentation

GET
Clock Out Employee (Default: Authenticated User)
Level 5 is required

--

Parameters:

  1. "schedule": accepted //Schedule id (integer)
  2. "notes": accepted //Notes (varchar)
  3. "employee": accepted //Employee id (integer)
  4. "photo": accepted /*Photo (varchar)
  5.   *eg.{"large":"timeclock/pic_250834.135402.jpg",
  6.   * "small":"timeclock/sm_250834.135402.jpg",
  7.   * "tiny":"timeclock/ti_250834.135402.jpg"}*/
  8. "location": accepted //Clock in localtion - IP adress (varchar)
  9. "clock_out_time": accepted /*Clock out time timestamp (time)
  10.   *If is not set, it adds current timestamp as clock out time.
  11.   *eg."clock_out_time":"Nov 28, 2012 05:00 PM"*/
  12. "tips": accepted //Tips (double)
  13. "latitude": accepted //Latitude (varchar)
  14. "longitude": accepted //Longitude (varchar)
  15. "token": "xxxxxxx" //Valid token is required

Example Request:

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

Example Response:

  1. {
  2. "status":1,
  3. "data":{
  4. "id":"2294555",
  5. "store":"17949",
  6. "status":"0",
  7. "schedule":null,
  8. "notes":null,
  9. "in_timestamp":"1359632738",
  10. "out_timestamp":"1359633124",
  11. "in_location":"130.180.250.172",
  12. "out_location":"130.180.250.172",
  13. "approved_by":"0",
  14. "approved_time":"0",
  15. "approved_notes":"",
  16. "in_picture":null,
  17. "in_picture_url":"",
  18. "out_picture":"",
  19. "start_timestamp":"2013-01-31 12:45:38",
  20. "end_timestamp":"2013-01-31 12:52:04",
  21. "in_gps":"{\"latitude\":\"\",\"longitude\":\"\",\"supported\":0}",
  22. "out_gps":"{\"latitude\":\"\",\"longitude\":\"\",\"supported\":0}",
  23. "employee":{
  24. "id":"25965",
  25. "name":"Dwight"
  26. },
  27. "in_time":{
  28. "time":"12:45",
  29. "day":"Jan 31, 2013",
  30. "timestamp":"2013-01-31 12:45:38"
  31. },
  32. "length":{
  33. "hours":0,
  34. "mins":6,
  35. "total_hours":"0.11"
  36. },
  37. "out_time":{
  38. "time":"12:52",
  39. "day":"Jan 31, 2013",
  40. "timestamp":"2013-01-31 12:52:04"
  41. },
  42. "current_length":{
  43. "hours":0,
  44. "mins":6,
  45. "total_hours":"0.11"
  46. },
  47. "events":[
  48.  
  49. ]
  50. },
  51. "token":"xxxxxxx"
  52. }