Group Account Management - Manage individual group account
SUPPORTED METHODS:
GET
| Parameters | Type | Description |
|---|---|---|
| token (required) | Valid token | |
| id (required) | integer | Account id |
UPDATE
| Parameters | Type | Description |
|---|---|---|
| token (required) | Valid token | |
| id (required) | integer | Account id |
| name (accepted) | varchar | Account name |
| is_parent (accepted) | integer | Is parent account |
| parent | varchar | Parent id |
CREATE
| Parameters | Type | Description |
|---|---|---|
| token (required) | Valid token | |
| name (accepted) | min length 3 | Name |
| administrator (accepted) | min length 3 | Administrator |
| password (accepted) | min length 6 | Password |
| email (accepted) | ||
| domain (accepted) | min length 3 | Domain |
| clone (accepted) | integer | Clone account - by id |
| clone_positions (accepted) | enum (0, 1) | Clone positions 0: Do not clone positions 1: Clone positions |
| clone_settings (accepted) | enum (0, 1) | Clone setings 0: Do not clone settings 1: Clone settings |
| clone_training (accepted) | enum (0, 1) | Clone training 0: Do not clone training 1: Clone training |
| submaster (accepted) | enum (0, 1) | Submaster |
DELETE
| Parameters | Type | Description |
|---|---|---|
| token (required) | Valid token | |
| id (required) | integer | Account id |
DOCUMENTATION
GET
Retrieves an individual group account.
Level 3 is required
--
Example Request:
{
"method":"GET",
"module":"group.account",
"request":{
"id":"56"
}
}
Example Response:
{
"status":1,
"data":{
"details":{
"id":"56",
"settings":{
"admin_past_edit":"0",
"book_days_off":"1",
"book_days_off_adv":"1",
"book_days_off_max":"11",
"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":"0",
"message_wall_emp":"0",
"message_wall_comments":"1",
"message_wall_uploads":"1",
"on_now":"0",
"shift_confirm":"1",
"shift_drop":"0",
"shift_autoconfirm":"0",
"timeclock":"1",
"tc_terminal_lock":"1",
"tc_round_to":"-1",
"tc_round_to_in":"-1",
"tc_round_to_out":"-1",
"tc_clock_in_timeframe":"-1",
"tc_autoclockout":"0",
"tc_webcam":"0",
"tc_empl_import":"0",
"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"
},
"staff":[
{
"id":"564",
"name":"Alan Ford"
},
{
"id":"5122",
"name":"Bob Rock"
}
],
"locations":[
{
"id":"0",
"name":"none"
},
{
"id":"477",
"name":"Test"
}
],
"positions":[
{
"id":"3213",
"name":"Meeting",
"l_name":"null",
"l_id":"null"
}
]
}
},
"token":"xxxxxxx"
}
CREATE
Creates an individual group account.
Level 3 is required
--
Example Request:
{
"method":"CREATE",
"module":"group.account",
"request":{
"name":"Group",
"clone_positions":"1",
"clone_settings":"1"
}
}
Example Response:
{
"status":1,
"data":{
"details":{
"id":"57",
"settings":{
"admin_past_edit":"0",
"book_days_off":"1",
"book_days_off_adv":"1",
"book_days_off_max":"11",
"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":"0",
"message_wall_emp":"0",
"message_wall_comments":"1",
"message_wall_uploads":"1",
"on_now":"0",
"shift_confirm":"1",
"shift_drop":"0",
"shift_autoconfirm":"0",
"timeclock":"1",
"tc_terminal_lock":"1",
"tc_round_to":"-1",
"tc_round_to_in":"-1",
"tc_round_to_out":"-1",
"tc_clock_in_timeframe":"-1",
"tc_autoclockout":"0",
"tc_webcam":"0",
"tc_empl_import":"0",
"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"
},
"staff":[
{
"id":"564",
"name":"Alan Ford"
},
{
"id":"5122",
"name":"Bob Rock"
}
],
"locations":[
{
"id":"0",
"name":"none"
},
{
"id":"477",
"name":"Test"
}
],
"positions":[
{
"id":"3213",
"name":"Meeting",
"l_name":"null",
"l_id":"null"
}
]
}
},
"token":"xxxxxxx"
}
UPDATE
Updates an individual group account.
Level 3 is required
--
Example Request:
{
"method":"UPDATE",
"module":"group.account",
"request":{
"id":"57",
"name":"John Smith"
}
}
Example Response:
{
"status":1,
"data":{
"details":{
"id":"57",
"settings":{
"admin_past_edit":"0",
"book_days_off":"1",
"book_days_off_adv":"1",
"book_days_off_max":"11",
"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":"0",
"message_wall_emp":"0",
"message_wall_comments":"1",
"message_wall_uploads":"1",
"on_now":"0",
"shift_confirm":"1",
"shift_drop":"0",
"shift_autoconfirm":"0",
"timeclock":"1",
"tc_terminal_lock":"1",
"tc_round_to":"-1",
"tc_round_to_in":"-1",
"tc_round_to_out":"-1",
"tc_clock_in_timeframe":"-1",
"tc_autoclockout":"0",
"tc_webcam":"0",
"tc_empl_import":"0",
"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"
},
"staff":[
{
"id":"564",
"name":"Alan Ford"
},
{
"id":"5122",
"name":"Bob Rock"
}
],
"locations":[
{
"id":"0",
"name":"none"
},
{
"id":"477",
"name":"Test"
}
],
"positions":[
{
"id":"3213",
"name":"Meeting",
"l_name":"null",
"l_id":"null"
}
]
}
},
"token":"xxxxxxx"
}
DELETE
Deletes an individual group account.
Level 3 is required
--
Example Request:
{
"method":"DELETE",
"module":"group.account",
"request":{
"id":"147"
}
}
Example Response:
{
"status":1,
"data":"",
"token":"xxxxxxx"
}