Clockin terminal management.
SUPPORTED METHODS:
DELETE
Parameters | Type | Description |
---|---|---|
token (required) | Valid token | |
id (required) | integer | Location id |
CREATE
Parameters | Type | Description |
---|---|---|
token (required) | Valid token | |
name (required) | varchar | Location name |
pref_userlist (accepted) | enum (1, 2) | 1 - Show employees as select box, 2 - Show as Gallery |
pref_login (accepted) | enum (0,1) | 1 - Require Full Employee Login, 0 - Not requires |
pref_webcam (accepted) | enum (0,1) | 1 - Require Webcam, 0 - Not requires |
pref_password (accepted) | enum (0,1) | 1 - Require Password, 0 - Not requires |
returnObject | enum (0,1) |
UPDATE
Parameters | Type | Description |
---|---|---|
token (required) | Valid token | |
id (required) | integer | Clock location terminal id |
returnObject | enum (0, 1) |
GET
Parameters | Type | Description |
---|---|---|
token (required) | Valid token | |
id (required) | integer | Clock location terminal id |
DOCUMENTATION
CREATE
Creates new time clock terminal.
Level 3 is required.
--
Example Request:
{
"module":"timeclock.terminal",
"method":"CREATE",
"request":{
"name":"testTerminal",
"location":5525,
"pref_userlist": 1,
"pref_login": 1,
"pref_webcam": 0,
"pref_password": 1
}
}
Example Response:
{
"status":1,
"data":"Terminal created",
"token":"xxxxxxx"
}
UPDATE
Updates a time clock terminal, refreshes the URL.
Level 3 is required.
--
Example request:
{
"module":"timeclock.terminal",
"method":"UPDATE",
"request":{
"id":3443
}
}
Example Response:
{
"status":1,
"data":"Terminal URL Reset",
"token":"xxxxxxx"
}
DELETE
Deletes time clock terminal.
Level 3 is required.
--
Example Request:
{
"module":"timeclock.terminal",
"method":"DELETE",
"request":{
"id":3443
}
}
Example Response:
{
"status":1,
"data":"Terminal deleted",
"token":"xxxxxxx"
}