Api doc


SDK's


Api Modules

admin.settings

Returns a list of all modules, methods and their support variables and types.



Supported Methods:

GET
Params
  • token (Required): valid token


UPDATE
Params
  • token (Required): valid token
  • admin_past_edit: enum (0, 1)
  • book_days_off: enum (0, 1)
  • book_days_off_adv: integer
  • confirm_trade_before: enum (0, 1)
  • confirm_trade_after: enum (0, 1)
  • sms: enum (0, 1)
  • email: enum (0, 1)
  • pm: enum (0, 1)
  • visible_staff: enum (0, 1)
  • visible_staff_details: enum (0, 1)
  • visible_coworkers: enum (0, 1)
  • trade_shifts: enum (0, 1)
  • coworkers_contacts: enum (0, 1)
  • future_avail: enum (0, 1)
  • weekly_avail: enum (0, 1)
  • visible_overview: enum (0, 1)
  • visible_own: enum (0, 1)
  • message_wall_on: enum (0, 1)
  • message_wall_emp: enum (0, 1)
  • message_wall_comments: enum (0, 1)
  • on_now: enum (0, 1)
  • shift_confirm: enum (0, 1)
  • timeclock: enum (0, 1)
  • tc_terminal_lock: enum (0, 1)
  • tc_round_to: integer
  • tc_clock_in_timeframe: integer
  • tc_autoclockout: enum (0, 1)
  • tc_webcam: enum (0, 1)
  • overtime: integer
  • pref_availability_timeframe: integer
  • pref_alt_w_overtime_calc: enum (0, 1)
  • pref_birthday: enum (0, 1)
  • pref_birthday_card: enum (0, 1)
  • pref_birthday_reminder: enum (0, 1)
  • pref_allow_req_acc: enum (0, 1)
  • security_question: varchar
  • security_answer: varchar


Documentation

GET
Retrieves a list of all admin current settings.
Level 5 is required

--

Parameters:

  1. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "method":"GET",
  3. "module":"admin.settings",
  4. "request":{
  5.  
  6. }
  7. }

Example Response:

  1. {
  2. "status":1,
  3. "data":{
  4. "admin_past_edit":"0",
  5. "edit_profile":"1",
  6. "reports":"1",
  7. "book_days_off":"1",
  8. "book_days_off_adv":"30",
  9. "book_days_off_max":"10",
  10. "confirm_trade_before":"1",
  11. "confirm_trade_after":"1",
  12. "sms":"1",
  13. "email":"1",
  14. "pm":"1",
  15. "visible_staff":"1",
  16. "visible_staff_details":"1",
  17. "visible_coworkers":"1",
  18. "trade_shifts":"1",
  19. "coworkers_contacts":"0",
  20. "future_avail":"1",
  21. "weekly_avail":"1",
  22. "visible_overview":"0",
  23. "visible_own":"1",
  24. "timeout":"0",
  25. "message_wall_on":"1",
  26. "message_wall_emp":"0",
  27. "message_wall_comments":"1",
  28. "message_wall_uploads":"0",
  29. "on_now":"0",
  30. "shift_confirm":"1",
  31. "shift_drop":"0",
  32. "shift_autoconfirm":"0",
  33. "timeclock":"1",
  34. "tc_terminal_lock":"0",
  35. "tc_round_to":"60",
  36. "tc_round_to_in":"-1",
  37. "tc_round_to_out":"-1",
  38. "tc_clock_in_timeframe":"-1",
  39. "tc_autoclockout":"0",
  40. "tc_webcam":"0",
  41. "tc_empl_import":"1",
  42. "tc_empl_addtime":"1",
  43. "24hr":"0",
  44. "draft":"1",
  45. "date":"M j, Y",
  46. "startday":"1",
  47. "currency":"1",
  48. "viewadvance":"-1",
  49. "login_splogo":"1",
  50. "scosting":"3",
  51. "start_day":"1",
  52. "end_day":"7",
  53. "start_time":"0",
  54. "end_time":"0",
  55. "overtime":"40",
  56. "timezone":"-05:00,1"
  57. },
  58. "token":"xxxxxxx"
  59. }

---

UPDATE
Updates admin settings.
Level 2 is required.

--

Parameters:

  1. "admin_past_edit": accepted //Edit admin settings (enum[0,1])
  2. /* 0: Can not edit admin settings
  3.   * 1: Can edit admin settings */
  4. "book_days_off": accepted //Book days off (enum[0,1])
  5. /* 0: Can not book day off
  6.   * 1: Can book day off */
  7. "book_days_off_adv": accepted //Book day off advance - number of days (integer)
  8. "confirm_trade_before": accepted //Confirm trade before (enum[0,1])
  9. /* 0: Manager do not have to confirm shift trades
  10.   * before requests are sent to other employees
  11.   * 1: Manager have to confirm shift trades before
  12.   * requests are sent to other employees */
  13. "confirm_trade_after": accepted //Confirm trade after (enum[0,1])
  14. /* 0: Manager do not have to confirm shift trades
  15.   * after requests are sent to other employees
  16.   * 1: Manager do not have to confirm shift trades
  17.   * after requests are sent to other employees*/
  18. "sms": accepted //Sms notification (enum[0,1])
  19. /* 0: Sms notification disabled
  20.   * 1: Sms notification enabled */
  21. "email": accepted //Email notification (enum[0,1])
  22. /* 0: Email notification disabled
  23.   * 1: Email notification enabled */
  24. "pm": accepted //Private message (enum[0,1])
  25. /* 0: Employees can not send private messages
  26.   * 1: Employees can send private messages */
  27. "visible_staff": accepted //Visible staff (enum[0,1])
  28. /* 0: Employees can not see visible staff
  29.   * 1: Employees can see visible staff */
  30. "visible_staff_details": accepted //Visible staff details (enum[0,1])
  31. /* 0: Employees can not see visible staff details
  32.   * 1: Employees can see visible staff details */
  33. "visible_coworkers": accepted //Visible coworkers (enum[0,1])
  34. /* 0: Employees can not see visible coworkers
  35.   * 1: Employees can see visible coworkers */
  36. "trade_shifts": accepted //Trade shifts (enum[0,1])
  37. /* 0: Employees can not trade shifts
  38.   * 1: Employees can trade shifts */
  39. "coworkers_contacts": accepted //Coworkers contacts (enum[0,1])
  40. /* 0: Employees can not see coworkers contacts
  41.   * 1: Employees can see coworkers contacts */
  42. "future_avail": accepted //Future availability (enum[0,1])
  43. /* 0: Employees can not set future availability
  44.   * 1: Employees can set future availabilityy */
  45. "weekly_avail": accepted //Weekly available (enum[0,1])
  46. /* 0: Employees can not set weekly availability
  47.   * 1: Employees can set weekly availability */
  48. "visible_overview": accepted //Visible overview (enum[0,1])
  49. /* 0: Not allowed to view all schedules
  50.   * 1: Allowed to view all schedules */
  51. "visible_own": accepted //Visible own (enum[0,1])
  52. /* 0: Employees can not view own staff
  53.   * 1: Employees can view own staff */
  54. "message_wall_on": accepted //Message wall on (enum[0,1])
  55. /* 0: Message wall off
  56.   * 1: Message wall on */
  57. "message_wall_emp": accepted //Message wall employees (enum[0,1])
  58. /* 0: Only managers can post messages
  59.   * 1: Employees can post messages */
  60. "message_wall_comments": accepted //Message wall comments (enum[0,1])
  61. /* 0: Staff can not leave comments
  62.   * 1: Staff can leave comments */
  63. "on_now": accepted //On now (enum[0,1])
  64. /* 0: Employees can not view "Who's on now"
  65.   * 1: Employees can view "Who's on now" */
  66. "shift_confirm": accepted //Shift confirm (enum[0,1])
  67. /* 0: Can not confirm shifts
  68.   * 1: Can confirm shift */
  69. "timeclock": accepted //Timeclock (enum[0,1])
  70. /* 0: Time Clock Module is disabled.
  71.   * 1: Time Clock Module is enabled.*/
  72. "tc_terminal_lock": accepted //Timeclock terminal lock (enum[0,1])
  73. /* 0: Do not lock time-clocking to specified
  74.   * locations
  75.   * 1: Lock time-clocking to specified locations*/
  76. "tc_round_to": accepted //Round time clock totals to nearest (integer)
  77. "tc_clock_in_timeframe": accepted //Round ClockIn times up to the nearest (integer)
  78. "tc_autoclockout": accepted //Timeclock auto clock out (enum[0,1])
  79. /* 0: Autoclockout disabled
  80.   * 1: Autoclockout enabled */
  81. "tc_webcam": accepted //Timeclock webcam (enum[0,1])
  82. /* 0: Employees do not have to use webcam when they
  83.   * clock in & out
  84.   * 1: Employees have to use webcam when they clock
  85.   * in & out */
  86. "overtime": accepted //Daily overtime - max number of hours (integer)
  87.  
  88. "pref_availability_timeframe": accepted /*AvailabilityChangeRequests are effective (integer)
  89.   *0 – Immediatly
  90.   *1 – after one day
  91.   *2 – after two days
  92.   *7 – after one week */
  93. "pref_alt_w_overtime_calc": accepted /*Alternative weekly overtime calculation (enum[0,1])
  94.   *Using this mode will only put regular hours into
  95.   *weekly overtime quota.
  96.   *Daily overtime will not be included.*/
  97. "pref_birthday": accepted //Enable/Disable Birthday Notifications (enum[0,1])
  98. "pref_birthday_card": accepted //Enable/Disable happy birthday card (enum[0, 1])
  99. "pref_birthday_reminder": accepted //Birthday reminder (enum[0,1])
  100. "pref_allow_req_acc": accepted /*Users can request account (enum[0,1])
  101.   *Allow this option to let new employees request
  102.   *account directly from company's login page.*/
  103. "security_question": accepted /*Security question (varchar)
  104.   *for user who make account request */
  105. "security_answer": accepted /*Security answer (varchar)
  106.   *for user who make account request */
  107.  
  108. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"admin.settings",
  3. "method":"UPDATE",
  4. "request":{
  5. "admin_past_edit":"0",
  6. "book_days_off":"1",
  7. "book_days_off_adv":"3",
  8. "confirm_trade_before":"1",
  9. "confirm_trade_after":"0",
  10. "sms":"1"
  11. }
  12. }

Example Response:

  1. {
  2. "status":1,
  3. "data":{
  4. "admin_past_edit":"0",
  5. "edit_profile":"1",
  6. "reports":"1",
  7. "book_days_off":"1",
  8. "book_days_off_adv":"3",
  9. "book_days_off_max":"10",
  10. "confirm_trade_before":"1",
  11. "confirm_trade_after":"0",
  12. "sms":"1",
  13. "email":"1",
  14. "pm":"1",
  15. "visible_staff":"1",
  16. "visible_staff_details":"1",
  17. "visible_coworkers":"1",
  18. "trade_shifts":"1",
  19. "coworkers_contacts":"0",
  20. "future_avail":"1",
  21. "weekly_avail":"1",
  22. "visible_overview":"0",
  23. "visible_own":"1",
  24. "timeout":"0",
  25. "message_wall_on":"1",
  26. "message_wall_emp":"0",
  27. "message_wall_comments":"1",
  28. "message_wall_uploads":"0",
  29. "on_now":"0",
  30. "shift_confirm":"1",
  31. "shift_drop":"0",
  32. "shift_autoconfirm":"0",
  33. "timeclock":"1",
  34. "tc_terminal_lock":"0",
  35. "tc_round_to":"60",
  36. "tc_round_to_in":"-1",
  37. "tc_round_to_out":"-1",
  38. "tc_clock_in_timeframe":"-1",
  39. "tc_autoclockout":"0",
  40. "tc_webcam":"0",
  41. "tc_empl_import":"1",
  42. "tc_empl_addtime":"1",
  43. "24hr":"0",
  44. "draft":"1",
  45. "date":"M j, Y",
  46. "startday":"1",
  47. "currency":"1",
  48. "viewadvance":"-1",
  49. "login_splogo":"1",
  50. "scosting":"3",
  51. "start_day":"1",
  52. "end_day":"7",
  53. "start_time":"0",
  54. "end_time":"0",
  55. "overtime":"40",
  56. "timezone":"-05:00,1",
  57. "availability_timeframe":"0",
  58. "alt_w_overtime_calc":"0",
  59. "birthday":"1",
  60. "birthday_card":"1",
  61. "allow_req_acc":"0",
  62. "security_question":"",
  63. "security_answer":""
  64. },
  65. "token":"xxxxxxx"
  66. }

GET STARTED NOW

Free Trial. No Credit Card Required.

close
(e.g.+14158675309 or +1415-8675-309)

By clicking "Create my ShiftPlanning Account" you agree to the Terms of Service and Privacy Policy.

Have a promotional code?Click Here


LIVE CHAT DEMO REQUEST!

Please provide information below.

close
INSTANT DEMOSCHEDULED DEMO
Connect with a ShiftPlanning Team Member for a live demo right now!
 

RESELLER REQUEST!

Please provide information below.

close