Api doc


SDK's


Api Modules

group.accounts

Group Account Management - Returns a list of all accounts in the Group



Supported Methods:

GET
Params
  • token (Required): valid token
  • detailed: enum (0, 1)
  • detailed_staff: enum (0, 1)


CREATE
Params
  • token (Required): valid token
  • accounts (Required): varchar
  • clone_positions: enum (0, 1)
  • clone_settings: enum (0, 1)
  • clone_training: enum (0, 1)


Documentation

GET
Group Account Management - Returns a list of all accounts in the Group.
Level 3 is required

--

Parameters:

  1. "detailed": accepted //Detailed (enum[0,1])
  2. /* 0: Not detailed
  3.   * 1: Detailed */
  4. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "method":"GET",
  3. "module":"group.accounts",
  4. "request":{
  5. "detailed":1
  6. }
  7. }

Example Response:

  1. {
  2. "status":1,
  3. "data":[
  4. {
  5. "id":"11",
  6. "name":"Master",
  7. "domain":"domain",
  8. "created":"1265595316",
  9. "language":"en_US",
  10. "settings":{
  11. "admin_past_edit":"0",
  12. "book_days_off":"1",
  13. "book_days_off_adv":"30",
  14. "book_days_off_max":"10",
  15. "confirm_trade_before":"1",
  16. "confirm_trade_after":"1",
  17. "sms":"1",
  18. "email":"1",
  19. "pm":"1",
  20. "visible_staff":"1",
  21. "visible_staff_details":"1",
  22. "visible_coworkers":"1",
  23. "trade_shifts":"1",
  24. "coworkers_contacts":"0",
  25. "future_avail":"1",
  26. "weekly_avail":"1",
  27. "visible_overview":"0",
  28. "visible_own":"1",
  29. "timeout":"0",
  30. "message_wall_on":"1",
  31. "message_wall_emp":"0",
  32. "message_wall_comments":"1",
  33. "message_wall_uploads":"0",
  34. "on_now":"0",
  35. "shift_confirm":"1",
  36. "shift_drop":"0",
  37. "shift_autoconfirm":"0",
  38. "timeclock":"1",
  39. "tc_terminal_lock":"0",
  40. "tc_round_to":"10",
  41. "tc_round_to_in":"-1",
  42. "tc_round_to_out":"-1",
  43. "tc_clock_in_timeframe":"-1",
  44. "tc_autoclockout":"0",
  45. "tc_webcam":"0",
  46. "tc_empl_import":"1",
  47. "tc_empl_addtime":"1",
  48. "24hr":"0",
  49. "draft":"1",
  50. "date":"M j, Y",
  51. "startday":"2",
  52. "currency":"4",
  53. "viewadvance":"-1",
  54. "login_splogo":"1",
  55. "scosting":"3",
  56. "start_day":"1",
  57. "end_day":"7",
  58. "start_time":"0",
  59. "end_time":"0",
  60. "overtime":"40",
  61. "timezone":"-05:00,1"
  62. },
  63. "admin":{
  64. "id":"556",
  65. "name":"Marc Smith",
  66. "email":"marc@humanity.com"
  67. },
  68. "staff":[
  69. {
  70. "id":"5226",
  71. "name":"Zidane"
  72. },
  73. {
  74. "id":"22367",
  75. "name":"Alan Ford"
  76. }
  77. ],
  78. "locations":{
  79. "0":"None",
  80. "294":"Budget",
  81. "318":"Budget Testing",
  82. "37":"Business Team.",
  83. "436":"serbia",
  84. "3":"Support Team"
  85. },
  86. "positions":[
  87. {
  88. "id":"32408",
  89. "name":"Admin\/meetings",
  90. "l_name":null,
  91. "l_id":null
  92. }
  93. ]
  94. }
  95. ],
  96. "token":"xxxxxxx"
  97. }

---

CREATE
Group Account Management - Creates a list of accounts in the Group.
Level 3 is required

--

Parameters:

  1. "accounts ": required //Accounts (varchar)
  2. "clone_position": acepted //Clone position (enum[0,1])
  3. /* 0: Do not clone positions
  4.   * 1: Clone positions */
  5. "clone_settings": acepted //Clone settings (enum[0,1])
  6. /* 0: Do not clone settings
  7.   * 1: Clone settings */
  8. "clone_training": acepted //Clone training (enum[0,1])
  9. /* 0: Do not clone training
  10.   * 1: Clone training */
  11. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "method":"CREATE",
  3. "module":"group.accounts",
  4. "request":{
  5. "0":"56"
  6.  
  7. }
  8. }

Example Response:

  1. {
  2. "status":1,
  3. "data":[
  4. {
  5. "details":{
  6. "id":"56",
  7. "settings":{
  8. "admin_past_edit":"0",
  9. "book_days_off":"1",
  10. "book_days_off_adv":"1",
  11. "book_days_off_max":"11",
  12. "confirm_trade_before":"1",
  13. "confirm_trade_after":"1",
  14. "sms":"1",
  15. "email":"1",
  16. "pm":"1",
  17. "visible_staff":"1",
  18. "visible_staff_details":"1",
  19. "visible_coworkers":"1",
  20. "trade_shifts":"1",
  21. "coworkers_contacts":"0",
  22. "future_avail":"1",
  23. "weekly_avail":"1",
  24. "visible_overview":"0",
  25. "visible_own":"1",
  26. "timeout":"0",
  27. "message_wall_on":"0",
  28. "message_wall_emp":"0",
  29. "message_wall_comments":"1",
  30. "message_wall_uploads":"1",
  31. "on_now":"0",
  32. "shift_confirm":"1",
  33. "shift_drop":"0",
  34. "shift_autoconfirm":"0",
  35. "timeclock":"1",
  36. "tc_terminal_lock":"1",
  37. "tc_round_to":"-1",
  38. "tc_round_to_in":"-1",
  39. "tc_round_to_out":"-1",
  40. "tc_clock_in_timeframe":"-1",
  41. "tc_autoclockout":"0",
  42. "tc_webcam":"0",
  43. "tc_empl_import":"0",
  44. "tc_empl_addtime":"1",
  45. "24hr":"0",
  46. "draft":"1",
  47. "date":"M j, Y",
  48. "startday":"1",
  49. "currency":"1",
  50. "viewadvance":"-1",
  51. "login_splogo":"1",
  52. "scosting":"3",
  53. "start_day":"1",
  54. "end_day":"7",
  55. "start_time":"0",
  56. "end_time":"0",
  57. "overtime":"40",
  58. "timezone":"-05:00,1"
  59. },
  60. "staff":[
  61. {
  62. "id":"564",
  63. "name":"Alan Ford"
  64. },
  65. {
  66. "id":"5122",
  67. "name":"Bob Rock"
  68. }
  69. ],
  70. "locations":[
  71. {
  72. "id":"0",
  73. "name":"none"
  74. },
  75. {
  76. "id":"477",
  77. "name":"Test"
  78. }
  79. ],
  80. "positions":[
  81. {
  82. "id":"3213",
  83. "name":"Meeting",
  84. "l_name":"null",
  85. "l_id":"null"
  86. }
  87. ]
  88. }
  89. }
  90. ],
  91. "token":"xxxxxxx"
  92. }