Edit User
JSON data EDIT USER
GET URL
BODY JSON
Name | TYPE | DESCRIPTION | REQUIRED |
---|---|---|---|
port |
STRING |
1103 |
|
api_id |
NUMBER (INT) |
can retrive data on Nuveq Portal user setting |
|
user_id |
NUMBER |
can retrive data on API USERS - Get User |
|
|
STRING |
User Email |
Optional ( if bluethooth enable, email is REQUIRED ) |
name |
STRING |
User Full Name |
|
phone |
STRING |
User Phone Number |
Optional |
photo |
STRING |
can retrive data on API USERS - Get User |
Optional |
staff_number |
STRING |
Staff Number ( ABC123 ) |
Optional |
gender |
STRING |
User Gender ( male/female ) |
Optional |
birth_date |
DATE |
User Birthday ( 1978-12-30 ) |
Optional |
access_group_id |
NUMBER (INT) |
can retrive data on API SITES - Get Access Groups |
|
lift_group_id |
NUMBER (INT) |
can retrive data on API SITES - Get Lift Groups |
|
shift_id |
NUMBER (INT) |
can retrive data on API SITES - Get Shifts |
|
department_id |
NUMBER (INT) |
can retrive data on API SITES - Get Departments |
|
post_id |
NUMBER (INT) |
can retrive data on API SITES - Get Positions |
|
card_id |
NUMBER (INT) |
can retrive data on API USERS - Get User |
|
card_no |
NUMBER (INT) |
Number of the card access |
Optional |
card_pin_no |
NUMBER (INT) |
Pin Number of the card access |
Optional |
card_expires |
DATETIME |
Expiry Date ( 2042-05-04 ) |
Optional |
card_enabled |
NUMBER (INT) |
0 - false | 1 - true |
Optional |
bluetooth_id |
NUMBER (INT) |
can retrive data on API USERS - Get User |
|
bluetooth_enabled |
NUMBER (INT) |
0 - false | 1 - true |
Optional |
site_id |
NUMBER (INT) |
can retrive data on API SITES - Get Sites ( can be one or more site added ) |
Optional |
token_key |
NUMBER (INT) |
can retrive data on Nuveq Portal user setting |
|
BODY JSON STRING
JSON Return Data:
"User Updated"
}
ERROR RETURN
ERROR STRING | FIELD API | DESCRIPTION |
---|---|---|
Fail to get Site |
sites |
Some of the site id are invalid |
User ID is empty |
user_id |
User Id is empty |
User Name is empty. |
name |
User Full Name is empty |
Fail to get Access Group. |
access_group_id |
Access Group id invalid |
Access Group is empty. |
access_group_id |
Access Group id is empty |
Fail to get Lift Group. |
lift_group_id |
Lift Group id is invalid |
Lift Group is empty. |
lift_group_id |
Lift Group id is empty |
Fail to get Shift. |
shift_id |
Shift Id is invalid |
Shift is empty. |
shift_id |
Shift Id is empty |
Fail to get Department. |
department_id |
Department Id is invalid |
Department is empty. |
department_id |
Department Id is empty |
Fail to get Position. |
post_id |
Position Id is invalid |
Position is empty. |
post_id |
Position Id is empty |
Card Number already exits. |
card_no |
Card Number is exits |
Date invalid Format. |
card_expires |
Card Expiry date is invalid format (yyyy-mm-dd) |
Card Number is empty. |
card_enabled and card_no |
Card is enabled but Card Number is empty |
Invalid Email Address. |
bluetooth_enabled and email |
Bluetooth is enabled but User Email is invalid email address |
Bluethooth Credential is Enable but there is no email value. |
bluetooth_enabled and email |
Bluetooth is enabled but User Email is empty |
User fail to update |
Edit User API |
Either Server down or maintanance, check with administrator. |