ПланФикс API user.update: различия между версиями
Материал из Planfix
Seva (обсуждение | вклад) Нет описания правки |
Seva (обсуждение | вклад) Нет описания правки |
||
(не показана 1 промежуточная версия этого же участника) | |||
Строка 8: | Строка 8: | ||
<id></id> | <id></id> | ||
<name></name> | <name></name> | ||
<midName></midName> | |||
<lastName></lastName> | <lastName></lastName> | ||
<email></email> | <email></email> | ||
<role></role> | <role></role> | ||
<status></status> | <status></status> | ||
<password></password> | <password></password> | ||
<birthdate></birthdate> | <birthdate></birthdate> | ||
<sex></sex> | <sex></sex> | ||
<phone></ | <phones> | ||
<phone> | |||
<number></number> | |||
<typeId></typeId> | |||
<typeName></typeName> | |||
</phone> | |||
<!-- ... --> | |||
</phones> | |||
<isInvisibleOutOfGroup></isInvisibleOutOfGroup> | <isInvisibleOutOfGroup></isInvisibleOutOfGroup> | ||
<isBlindOutOfGroup></isBlindOutOfGroup> | <isBlindOutOfGroup></isBlindOutOfGroup> | ||
Строка 40: | Строка 39: | ||
|id ||int || || | |id ||int || || | ||
|- | |- | ||
|name ||string ||имя | |name ||string ||имя пользователя || | ||
|- | |||
|midName ||string ||отчество пользователя ||необязательное поле | |||
|- | |- | ||
|lastName ||string ||фамилия пользователя ||необязательное поле | |lastName ||string ||фамилия пользователя ||необязательное поле | ||
|- | |- | ||
|email || string|| электронный адрес почты||необязательное поле | |email || string|| электронный адрес почты||необязательное поле | ||
|- | |- | ||
|role ||enum || роль пользователя в системе||необязательное поле. доступно для изменения только пользователям с правами администратор. полный список смотри в разделе [[ПланФикс API:Роли пользователей|роли пользователей]] | |role ||enum || роль пользователя в системе||необязательное поле. доступно для изменения только пользователям с правами администратор. полный список смотри в разделе [[ПланФикс API:Роли пользователей|роли пользователей]] | ||
Строка 53: | Строка 52: | ||
|- | |- | ||
|password ||string || пароль ||необязательное поле | |password ||string || пароль ||необязательное поле | ||
|- | |- | ||
|birthdate ||DateTime ||дата рождения ||необязательное поле | |birthdate ||DateTime ||дата рождения ||необязательное поле | ||
Строка 66: | Строка 57: | ||
|sex ||enum ||пол сотрудника ||необязательное поле. список допустимых значений смотри в разделе [[ПланФикс API:Пол сотрудника|пол сотрудника]] | |sex ||enum ||пол сотрудника ||необязательное поле. список допустимых значений смотри в разделе [[ПланФикс API:Пол сотрудника|пол сотрудника]] | ||
|- | |- | ||
| | |phones || string||телефоны || | ||
|- | |- | ||
| | |phone.number||string ||номер телефона || | ||
|- | |- | ||
| | |phone.typeId||int || идентификатор типа номера|| допустимые значения можно получить функцией [[ПланФикс API contact.getPhoneTypes|contact.getPhoneTypes]] | ||
|- | |- | ||
| | |phone.typeName||string || название типа номера|| | ||
|- | |- | ||
|isInvisibleOutOfGroup || bool|| true=Видит только членов своих групп; false=Видит всех сотрудников ||необязательное поле. доступно для изменения только пользователям с правами администратор | |isInvisibleOutOfGroup || bool|| true=Видит только членов своих групп; false=Видит всех сотрудников ||необязательное поле. доступно для изменения только пользователям с правами администратор |
Текущая версия от 12:48, 19 ноября 2021
Функция обновления данных пользователя. Формат запроса:
<?xml version="1.0" encoding="UTF-8"?>
<request method="user.update">
<account></account>
<sid></sid>
<user>
<id></id>
<name></name>
<midName></midName>
<lastName></lastName>
<email></email>
<role></role>
<status></status>
<password></password>
<birthdate></birthdate>
<sex></sex>
<phones>
<phone>
<number></number>
<typeId></typeId>
<typeName></typeName>
</phone>
<!-- ... -->
</phones>
<isInvisibleOutOfGroup></isInvisibleOutOfGroup>
<isBlindOutOfGroup></isBlindOutOfGroup>
<userPic></userPic>
<post>
<id></id>
</post>
</user>
<signature></signature>
</request>
Название | Тип | Значение | Примечание |
---|---|---|---|
id | int | ||
name | string | имя пользователя | |
midName | string | отчество пользователя | необязательное поле |
lastName | string | фамилия пользователя | необязательное поле |
string | электронный адрес почты | необязательное поле | |
role | enum | роль пользователя в системе | необязательное поле. доступно для изменения только пользователям с правами администратор. полный список смотри в разделе роли пользователей |
status | enum | статус | необязательное поле. доступно для изменения только пользователям с правами администратор. список допустимых значений смотри в разделе статусы пользователей |
password | string | пароль | необязательное поле |
birthdate | DateTime | дата рождения | необязательное поле |
sex | enum | пол сотрудника | необязательное поле. список допустимых значений смотри в разделе пол сотрудника |
phones | string | телефоны | |
phone.number | string | номер телефона | |
phone.typeId | int | идентификатор типа номера | допустимые значения можно получить функцией contact.getPhoneTypes |
phone.typeName | string | название типа номера | |
isInvisibleOutOfGroup | bool | true=Видит только членов своих групп; false=Видит всех сотрудников | необязательное поле. доступно для изменения только пользователям с правами администратор |
isBlindOutOfGroup | bool | true=Его видят только члены его групп; false=Его видят все сотрудники | необязательное поле. доступно для изменения только пользователям с правами администратор |
userPic | string | base64 закодированная картинка | необязательное поле |
post.id | int | должность которую занимает пользователь | необязательное поле |
Результат успешного выполнения функции:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<user>
<id></id>
</user>
</response>
Название | Тип | Значение | Примечание |
---|---|---|---|
user.id | int | идентификатор обновляемого пользователя |
В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>