ПланФикс API user.update — различия между версиями

Материал из ПланФикс
Перейти к: навигация, поиск
Строка 10: Строка 10:
 
     <lastName></lastName>
 
     <lastName></lastName>
 
     <email></email>
 
     <email></email>
−
    <jabber></jabber>
 
 
     <role></role>
 
     <role></role>
 
     <status></status>
 
     <status></status>
 
     <password></password>
 
     <password></password>
−
    <notify>
 
−
      <byEmail></byEmail>
 
−
      <byJabber></byJabber>
 
−
      <byPlanfix></byPlanfix>
 
−
    </notify>
 
 
     <birthdate></birthdate>
 
     <birthdate></birthdate>
 
     <sex></sex>
 
     <sex></sex>
−
     <phone></phone>
+
     <phones>
−
    <coeff></coeff>
+
        <phone>
−
    <timezone></timezone>
+
            <number></number>
−
    <useDst></useDst>
+
            <typeId></typeId>
 +
            <typeName></typeName>
 +
        </phone>
 +
        <!-- ... -->
 +
    </phones>
 
     <isInvisibleOutOfGroup></isInvisibleOutOfGroup>
 
     <isInvisibleOutOfGroup></isInvisibleOutOfGroup>
 
     <isBlindOutOfGroup></isBlindOutOfGroup>
 
     <isBlindOutOfGroup></isBlindOutOfGroup>
Строка 45: Строка 43:
 
|-
 
|-
 
|email || string|| электронный адрес почты||необязательное поле
 
|email || string|| электронный адрес почты||необязательное поле
−
|-
 
−
|jabber || string|| jabber-аккаунт||необязательное поле
 
 
|-
 
|-
 
|role ||enum || роль пользователя в системе||необязательное поле. доступно для изменения только пользователям с правами администратор. полный список смотри в разделе [[ПланФикс API:Роли пользователей|роли пользователей]]  
 
|role ||enum || роль пользователя в системе||необязательное поле. доступно для изменения только пользователям с правами администратор. полный список смотри в разделе [[ПланФикс API:Роли пользователей|роли пользователей]]  
Строка 53: Строка 49:
 
|-
 
|-
 
|password ||string || пароль ||необязательное поле
 
|password ||string || пароль ||необязательное поле
−
|-
 
−
|notify || || уведомления ||необязательное поле
 
−
|-
 
−
|notify.byEmail ||bool ||получать уведомления по электронной почте ||необязательное поле
 
−
|-
 
−
|notify.byJabber ||bool ||получать уведомления по jabber ||необязательное поле
 
−
|-
 
−
|notify.byPlanfix ||bool ||получать уведомления по внутренней системе уведомлений ПланФикс ||необязательное поле
 
 
|-
 
|-
 
|birthdate ||DateTime ||дата рождения ||необязательное поле
 
|birthdate ||DateTime ||дата рождения ||необязательное поле
Строка 66: Строка 54:
 
|sex ||enum ||пол сотрудника ||необязательное поле. список допустимых значений смотри в разделе [[ПланФикс API:Пол сотрудника|пол сотрудника]]
 
|sex ||enum ||пол сотрудника ||необязательное поле. список допустимых значений смотри в разделе [[ПланФикс API:Пол сотрудника|пол сотрудника]]
 
|-
 
|-
−
|phone ||string ||телефон ||необязательное поле
+
|phones || string||телефоны ||
 
|-
 
|-
−
|coeff ||float|| личный коэффициент||необязательное поле. доступно для изменения только пользователям с правами администратор
+
|phone.number||string ||номер телефона ||
 
|-
 
|-
−
|timezone || int||часовой пояс ||необязательное поле. Допустимые значения от -12 до 14
+
|phone.typeId||int || идентификатор типа номера|| допустимые значения можно получить функцией [[ПланФикс API contact.getPhoneTypes|contact.getPhoneTypes]]
 
|-
 
|-
−
|useDst ||bool ||переход на летнее время ||необязательное поле
+
|phone.typeName||string || название типа номера||
 
|-
 
|-
 
|isInvisibleOutOfGroup || bool|| true=Видит только членов своих групп; false=Видит всех сотрудников ||необязательное поле. доступно для изменения только пользователям с правами администратор
 
|isInvisibleOutOfGroup || bool|| true=Видит только членов своих групп; false=Видит всех сотрудников ||необязательное поле. доступно для изменения только пользователям с правами администратор

Версия 09:19, 22 июня 2018

Функция обновления данных пользователя. Формат запроса: 

<?xml version="1.0" encoding="UTF-8"?>
<request method="user.update">
  <account></account>
  <sid></sid>
  <user>
    <id></id>
    <name></name>
    <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 имя, отчество пользователя необязательное поле
lastName string фамилия пользователя необязательное поле
email 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>


Перейти

Источник — «http://planfix.ru/wiki/index.php?title=ПланФикс_API_user.update&oldid=15171»