Planfix API user.update

From Planfix
Jump to: navigation, search

A function to update user data. Request format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="user.update">
        <!-- ... -->
Name Type Value Note
id int
name string user's name
midName string user's middle name optional field
lastName string user's last name optional field
email string email address optional field
role enum user's role in the system user roles]] section
status enum status optional field. editable only by administrators. list of acceptable values can be found in the user statuses section
password string password optional field
birthdate DateTime birthdate optional field
sex enum employee's gender optional field. list of acceptable values can be found in the employee gender section
phones string phones
phone.number string phone number
phone.typeId int type identifier of the number acceptable values can be obtained with the contact.getPhoneTypes function
phone.typeName string name of the number type
isInvisibleOutOfGroup bool true=Sees only members of his groups; false=Sees all employees optional field. editable only by administrators
isBlindOutOfGroup bool Only members of his groups can see him; false=All employees can see him optional field. editable only by administrators
userPic string base64 encoded picture optional field int position held by the user optional field

Result of successful function execution:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
Name Type Value Note int identifier of the updated user

Otherwise, a response with an error will be returned:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">

Go To