Api doc


SDK's


Api Modules

timeclock.status

Get Clock Status of Employee (Default: Authenticated User). Returns 'in' or 'out'



Supported Methods:

GET
Params
  • token (Required): valid token
  • employee: integer
  • details: enum (1)


Documentation

GET
Get Clock Status of Employee (Default: Authenticated User). Returns 'in' or 'out'
If ("details":"1"), then returns detailed timeclock.
Level 5 is required (all users can fetch this module)

--

Parameters:

  1. "employee": accepted //Employee id (integer)
  2. "details": accepted //Details (enum[1])
  3. /* 1: With details */
  4. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"timeclock.status",
  3. "method":"GET",
  4. "request":{
  5. "employee":691,
  6. "detailed":1
  7. }
  8. }

Example Response:

  1. {
  2. "status":1,
  3. "data":{
  4. "id":"5448",
  5. "status":"0",
  6. "schedule":null,
  7. "notes":null,
  8. "in_timestamp":"1340804769",
  9. "out_timestamp":"0",
  10. "in_location":"Website",
  11. "out_location":"Website",
  12. "approved_by":"0",
  13. "approved_time":"0",
  14. "approved_notes":"",
  15. "in_picture":null,
  16. "out_picture":"",
  17. "employee":{
  18. "id":"691",
  19. "name":"Alan Ford"
  20. },
  21. "in_time":{
  22. "time":"08:46",
  23. "day":"Jun 27, 2012"
  24. },
  25. "length":{
  26. "hours":"",
  27. "mins":"",
  28. "total_hours":""
  29. },
  30. "out_time":{
  31. "time":"",
  32. "day":""
  33. },
  34. "events":false
  35. },
  36. "token":"xxxxxxx"
  37. }