Api doc


SDK's


Api Modules

terminal.clockout

Terminal clockout management.



Supported Methods:

GET
Params
  • token (Required): valid token
  • terminal_key (Required): varchar
  • id: integer
  • photo: varchar
  • schedule: integer
  • logout: enum (0, 1)
  • computer_id: varchar
  • ip: varchar
  • notes: varchar
  • tips: varchar


Documentation

GET
Employee ClockOut trough terminal.
All users can fetch this module.

--

Parameters:

  1. "terminal_key": required //Terminal key (varchar)
  2. "id": accepted //Employee id (integer)
  3. "photo": accepted /*JSON (varchar)
  4.   * eg. {"large":"timeclock/pic_250834.13540.jpg",
  5.   * "small":"timeclock/sm_250834.13540.jpg",
  6.   * "tiny":"timeclock/ti_250834.13540.jpg"}*/
  7. "logout": accepted //Automatically logout employee from terminal after clockin (enum[0,1])
  8. /* 1: Logout
  9.   * 0: Do not logout */
  10. "schedule": accepted //Schedule id (integer)
  11. "computer_id": accepted //Computer id – required if there is no IP adress (varchar)
  12. "ip": accepted //IP adress – requred if there is no computer_id (varchar)
  13. "notes": accepted //Notes (varchar)
  14. "tips": accepted //Tips (double)
  15. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"terminal.clockout",
  3. "method":"GET",
  4. "request":{
  5. "terminal_key":"xxxxxxx",
  6. "id": 245698,
  7. "logout": 0,
  8. "schedule": 132548,
  9. "ip":"xxx.xxx.xx.x"
  10. }
  11. }

Example Response:

  1. {
  2.    "status":1,
  3.    "data": "You are clocked out",
  4.    "token":"xxxxxxx"
  5. }