ПланФикс API contact.updateUserInfo: различия между версиями

Материал из Planfix
Перейти к: навигация, поиск
(Новая страница: «Функция обновления информации относящейся к залогиниванию пользователя в системе. Выпол...»)
 
Нет описания правки
 
(не показано 7 промежуточных версий 2 участников)
Строка 7: Строка 7:
   <contact>
   <contact>
     <id></id>
     <id></id>
    <userid></userid>
    <general></general>
     <user>
     <user>
       <password></password>
       <password></password>
       <status></status>
       <status></status>
       <email></email>
       <email></email>
      <pic></pic>
      <notifyByEmail></notifyByEmail>
     </user>
     </user>
   </contact>
   </contact>
Строка 19: Строка 23:
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
|-
|-
|id ||int ||идентификатор контакта ||
|id||int||идентификатор контакта ||
|-
|userid||int||идентификатор контакта для случаев, когда он используется в системе наравне с сотрудниками (исполнитель задачи и т.п., а также пользовательское поле типа контакт) ||
|-
|general||int||номер контакта ||
 
|-
|-
|user || || информация о учетке используемой для залогинивания ||
|user || || информация о учетке используемой для залогинивания ||
Строка 28: Строка 37:
|-
|-
|user.email || string|| адрес электронной почты||
|user.email || string|| адрес электронной почты||
|-
|user.jabber || string|| Jabber-аккаунт|| используется в системе уведомлений
|-
|user.notifyByEmail|| bool||получать уведомления по электронной почте || установка этого параметра в 1 (использовать) требует непустого значения для поля  '''email'''
|-
|user.notifyByJabber|| bool||получать уведомления по jabber || установка этого параметра в 1 (использовать) требует непустого значения для поля '''jabber'''
|-
|user.notifyByPlanfix|| bool||получать уведомления по внутренней системе уведомлений ПланФикс ||
|-
|user.pic || string||base64 закодированное изображение ||
|-
|-
|signature ||string(32) ||подпись ||
|signature ||string(32) ||подпись ||
Строка 58: Строка 77:
</response>
</response>
</source>
</source>
{| class="wikitable" style="margin-top: 1em; width:100% "
 
!width="50"|Значение ''code'' !! Расшифровка
|-
|align="center"| 0000|| неизвестная ошибка
|-
|}




== Перейти ==
== Перейти ==
*[[ПланФикс API]]
*[[ПланФикс API:Контакты]]
*[[ПланФикс API:Контакты]]
*[[Коды ошибок]]
*[[Список функций]]

Текущая версия от 12:02, 2 августа 2021

Функция обновления информации относящейся к залогиниванию пользователя в системе. Выполнение этой функции требует наличие админ прав. Формат запроса:

<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.updateUserInfo">
  <account></account>
  <sid></sid>
  <contact>
    <id></id>
    <userid></userid>
    <general></general>
    <user>
      <password></password>
      <status></status>
      <email></email>
      <pic></pic>
      <notifyByEmail></notifyByEmail>
    </user>
  </contact>
  <signature></signature>
</request>
Название Тип Значение Примечание
id int идентификатор контакта
userid int идентификатор контакта для случаев, когда он используется в системе наравне с сотрудниками (исполнитель задачи и т.п., а также пользовательское поле типа контакт)
general int номер контакта
user информация о учетке используемой для залогинивания
user.password string пароль
user.status enum статус список допустимых значений смотри в разделе статусы пользователей
user.email string адрес электронной почты
user.jabber string Jabber-аккаунт используется в системе уведомлений
user.notifyByEmail bool получать уведомления по электронной почте установка этого параметра в 1 (использовать) требует непустого значения для поля email
user.notifyByJabber bool получать уведомления по jabber установка этого параметра в 1 (использовать) требует непустого значения для поля jabber
user.notifyByPlanfix bool получать уведомления по внутренней системе уведомлений ПланФикс
user.pic string base64 закодированное изображение
signature string(32) подпись


Результат успешного выполнения функции:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <contact>
    <id></id>
  </contact>
</response>
Название Тип Значение Примечание
contact.id int идентификатор контакта


В противном случае будет возвращен ответ с ошибкой:

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


Перейти