Api doc


SDK's


Api Modules

timeclock.terminal

Clockin terminal management.



Supported Methods:

DELETE
Params
  • token (Required): valid token
  • id (Required): integer


CREATE
Params
  • token (Required): valid token
  • name (Required): varchar
  • location (Required): integer
  • pref_userlist: enum (1, 2)
  • pref_login: enum (0, 1)
  • pref_webcam: enum (0, 1)
  • pref_password: enum (0, 1)
  • returnObject: enum (0, 1)


UPDATE
Params
  • token (Required): valid token
  • id (Required): integer
  • id: integer
  • returnObject: enum (0, 1)


GET
Params
  • token (Required): valid token
  • id: integer


Documentation

CREATE
Creates new time clock terminal.
Level 3 is required.

--

Parameters:

  1. "name": required // Terminal name (varchar)
  2. "location": required // Clock location id (integer)
  3.  
  4. "pref_userlist": accepted /*enum (1, 2) 1 - Show employees as select box,
  5.   2 - Show as Gallery*/
  6. "pref_login": accepted /*enum (0, 1) 1 - Require Full Employee Login,
  7.   0 - Not requires*/
  8. "pref_webcam": accepted /*enum (0, 1) 1 - Require Webcam,
  9.   0 - Not requires*/
  10. "pref_password": accepted /*enum (0, 1) 1 - Require Password,
  11.   0 - Not requires*/
  12.  
  13. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"timeclock.terminal",
  3. "method":"CREATE",
  4. "request":{
  5. "name":"testTerminal",
  6. "location":5525,
  7. "pref_userlist": 1,
  8. "pref_login": 1,
  9. "pref_webcam": 0,
  10. "pref_password": 1
  11. }
  12. }

Example Response:

  1. {
  2. "status":1,
  3. "data":"Terminal created",
  4. "token":"xxxxxxx"
  5. }

---

UPDATE
Updates a time clock terminal, refreshes the URL.
Level 3 is required.

--

Parameters:

  1. "id": required //Clock location terminal id (integer)
  2. "token": "xxxxxxx" //Valid token is required

Example request:

  1. {
  2. "module":"timeclock.terminal",
  3. "method":"UPDATE",
  4. "request":{
  5. "id":3443
  6. }
  7. }

Example Response:

  1. {
  2. "status":1,
  3. "data":"Terminal URL Reset",
  4. "token":"xxxxxxx"
  5. }

---

DELETE
Deletes time clock terminal.
Level 3 is required.

--

Parameters:

  1. "id": required //Clock location terminal id
  2. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"timeclock.terminal",
  3. "method":"DELETE",
  4. "request":{
  5. "id":3443
  6. }
  7. }

Example Response:

  1. {
  2. "status":1,
  3. "data":"Terminal deleted",
  4. "token":"xxxxxxx"
  5. }