Returns a list of all modules, methods and their support variables and types.
SUPPORTED METHODS:
GET
| Parameters | Type | Description |
|---|---|---|
| token (required) | Valid token |
UPDATE
| Parameters | Type | Description |
|---|---|---|
| token (Required) | token (Required) | |
| admin_past_edit (accepted) | enum (0, 1) | Edit admin settings 0: Can not edit admin settings 1: Can edit admin settings |
| book_days_off (accepted) | enum (0, 1) | Book days off 0: Can not book day off 1: Can book day off |
| book_days_off_adv (accepted) | enum (0, 1) | Confirm trade before 0: Manager do not have to confirm shift trades before requests are sent to other employees 1: Manager have to confirm shift trades before requests are sent to other employees |
| confirm_trade_after (accepted) | enum (0, 1) | Confirm trade after 0: Manager do not have to confirm shift trades after requests are sent to other employees 1: Manager do not have to confirm shift trades after requests are sent to other employees |
| sms (accepted) | enum (0, 1) | Sms notification 0: Sms notification disabled 1: Sms notification enabled |
| email (accepted) | enum (0, 1) | Email notification 0: Email notification disabled 1: Email notification enabled |
| pm (accepted) | enum (0, 1) | Private message 0: Employees can not send private messages 1: Employees can send private messages |
| visible_staff (accepted) | enum (0, 1) | Visible staff 0: Employees can not see visible staff 1: Employees can see visible staff |
| visible_staff_details (accepted) | enum (0, 1) | Visible staff details 0: Employees can not see visible staff details 1: Employees can see visible staff details |
| visible_coworkers (accepted) | enum (0, 1) | Visible coworkers 0: Employees can not see visible coworkers 1: Employees can see visible coworkers |
| trade_shifts (accepted) | enum (0, 1) | Trade shifts 0: Employees can not trade shifts 1: Employees can trade shifts |
| coworkers_contacts (accepted) | enum (0, 1) | Future availability 0: Employees can not set future availability 1: Employees can set future availability |
| weekly_avail (accepted) | enum (0, 1) | Visible overview 0: Not allowed to view all schedules 1: Allowed to view all schedules |
| visible_own (accepted) | enum (0, 1) | Visible own 0: Employees can not view own staff 1: Employees can view own staff |
| message_wall_on (accepted) | enum (0, 1) | Message wall employees 0: Only managers can post messages 1: Employees can post messages |
| message_wall_emp (accepted) | enum (0, 1) | Message wall employees 0: Only managers can post messages 1: Employees can post messages |
| message_wall_comments (accepted) | enum (0, 1) | Message wall comments 0: Staff can not leave comments 1: Staff can leave comments |
| on_now (accepted) | enum (0, 1) | On now 0: Employees can not view "Who's on now" 1: Employees can view "Who's on now" |
| shift_confirm (accepted) | enum (0, 1) | Shift confirm 0: Can not confirm shifts 1: Can confirm shift |
| timeclock (accepted) | enum (0, 1) | Timeclock 0: Time Clock Module is disabled. 1: Time Clock Module is enabled |
| tc_terminal_lock (accepted) | enum (0, 1) | Timeclock terminal lock 0: Do not lock time-clocking to specified locations 1: Lock time-clocking to specified locations |
| tc_round_to (accepted) | integer | Round time clock totals to nearest |
| tc_clock_in_timeframe (accepted) | integer | Round ClockIn times up to the nearest |
| tc_autoclockout (accepted) | enum (0, 1) | Timeclock auto clock out 0: Autoclockout disabled 1: Autoclockout enabled |
| tc_webcam (accepted) | enum (0, 1) | Timeclock webcam 0: Employees do not have to use webcam when they clock in & out 1: Employees have to use webcam when they clock in & out |
| overtime (accepted) | integer | Daily overtime - max number of hours |
| pref_availability_timeframe (accepted) | integer | AvailabilityChangeRequests are effective (integer) 0 – Immediatly 1 – after one day 2 – after two days 7 – after one week |
| pref_alt_w_overtime_calc (accepted) | enum (0, 1) | Alternative weekly overtime calculation. Using this mode will only put regular hours into weekly overtime quota. Daily overtime will not be included |
| pref_birthday (accepted) | enum (0, 1) | Enable/Disable Birthday Notifications |
| pref_birthday_card (accepted) | enum (0, 1) | Enable/Disable happy birthday card |
| pref_birthday_reminder (accepted) | enum (0, 1) | Birthday reminder |
| pref_allow_req_acc (accepted) | enum (0, 1) | Users can request account Allow this option to let new employees request account directly from company's login page. |
| security_question (accepted) | varchar | Security question for user who make account request |
| security_answer (accepted) | varchar | Security answer for user who make account request |
DOCUMENTATION
GET
Retrieves a list of all admin current settings.
Level 5 is required
--
Example Request:
{
"method":"GET",
"module":"admin.settings",
"request":{
}
}
Example Response:
{
"status":1,
"data":{
"admin_past_edit":"0",
"edit_profile":"1",
"reports":"1",
"book_days_off":"1",
"book_days_off_adv":"30",
"book_days_off_max":"10",
"confirm_trade_before":"1",
"confirm_trade_after":"1",
"sms":"1",
"email":"1",
"pm":"1",
"visible_staff":"1",
"visible_staff_details":"1",
"visible_coworkers":"1",
"trade_shifts":"1",
"coworkers_contacts":"0",
"future_avail":"1",
"weekly_avail":"1",
"visible_overview":"0",
"visible_own":"1",
"timeout":"0",
"message_wall_on":"1",
"message_wall_emp":"0",
"message_wall_comments":"1",
"message_wall_uploads":"0",
"on_now":"0",
"shift_confirm":"1",
"shift_drop":"0",
"shift_autoconfirm":"0",
"timeclock":"1",
"tc_terminal_lock":"0",
"tc_round_to":"60",
"tc_round_to_in":"-1",
"tc_round_to_out":"-1",
"tc_clock_in_timeframe":"-1",
"tc_autoclockout":"0",
"tc_webcam":"0",
"tc_empl_import":"1",
"tc_empl_addtime":"1",
"24hr":"0",
"draft":"1",
"date":"M j, Y",
"startday":"1",
"currency":"1",
"viewadvance":"-1",
"login_splogo":"1",
"scosting":"3",
"start_day":"1",
"end_day":"7",
"start_time":"0",
"end_time":"0",
"overtime":"40",
"timezone":"-05:00,1"
},
"token":"xxxxxxx"
}
UPDATE
Updates admin settings.
Level 2 is required.
Example Request:
{
"module":"admin.settings",
"method":"UPDATE",
"request":{
"admin_past_edit":"0",
"book_days_off":"1",
"book_days_off_adv":"3",
"confirm_trade_before":"1",
"confirm_trade_after":"0",
"sms":"1"
}
}
Example Response:
{
"status":1,
"data":{
"admin_past_edit":"0",
"edit_profile":"1",
"reports":"1",
"book_days_off":"1",
"book_days_off_adv":"3",
"book_days_off_max":"10",
"confirm_trade_before":"1",
"confirm_trade_after":"0",
"sms":"1",
"email":"1",
"pm":"1",
"visible_staff":"1",
"visible_staff_details":"1",
"visible_coworkers":"1",
"trade_shifts":"1",
"coworkers_contacts":"0",
"future_avail":"1",
"weekly_avail":"1",
"visible_overview":"0",
"visible_own":"1",
"timeout":"0",
"message_wall_on":"1",
"message_wall_emp":"0",
"message_wall_comments":"1",
"message_wall_uploads":"0",
"on_now":"0",
"shift_confirm":"1",
"shift_drop":"0",
"shift_autoconfirm":"0",
"timeclock":"1",
"tc_terminal_lock":"0",
"tc_round_to":"60",
"tc_round_to_in":"-1",
"tc_round_to_out":"-1",
"tc_clock_in_timeframe":"-1",
"tc_autoclockout":"0",
"tc_webcam":"0",
"tc_empl_import":"1",
"tc_empl_addtime":"1",
"24hr":"0",
"draft":"1",
"date":"M j, Y",
"startday":"1",
"currency":"1",
"viewadvance":"-1",
"login_splogo":"1",
"scosting":"3",
"start_day":"1",
"end_day":"7",
"start_time":"0",
"end_time":"0",
"overtime":"40",
"timezone":"-05:00,1",
"availability_timeframe":"0",
"alt_w_overtime_calc":"0",
"birthday":"1",
"birthday_card":"1",
"allow_req_acc":"0",
"security_question":"",
"security_answer":""
},
"token":"xxxxxxx"
}