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

Материал из Planfix
Перейти к: навигация, поиск
(Новая страница: «Функция позволяет разрешить или запретить доступ для контакта. Выполнение этой функции т...»)
 
Нет описания правки
 
(не показано 8 промежуточных версий 2 участников)
Строка 7: Строка 7:
   <contact>
   <contact>
     <id></id>
     <id></id>
    <userid></userid>
    <general></general>
    <email></email>
     <havePlanfixAccess></havePlanfixAccess>
     <havePlanfixAccess></havePlanfixAccess>
   </contact>
   </contact>
Строка 15: Строка 18:
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
|-
|-
|id ||int ||идентификатор контакта ||
|id||int||идентификатор контакта ||
|-
|-
|havePlanfixAccess ||bool || запретить (false) или открыть(true) доступ к ПланФикс ||
|userid||int||идентификатор контакта для случаев, когда он используется в системе наравне с сотрудниками (исполнитель задачи и т.п., а также пользовательское поле типа контакт) ||
|-
|general||int||номер контакта ||
 
|-
|email|| string || использовать указанный e-mail для организации доступа в ПланФикс || не обязательный параметр, используется только в первый раз, при открытии доступа к ПланФик'су
|-
|havePlanfixAccess ||bool || запретить (0) или открыть(1) доступ к ПланФикс ||
|-
|-
|signature ||string(32) ||подпись ||
|signature ||string(32) ||подпись ||
Строка 30: Строка 40:
   <contact>
   <contact>
     <id></id>
     <id></id>
     <havePlanfixAccess></havePlanfixAccess>
     <status></status>
   </contact>
   </contact>
</response>
</response>
Строка 37: Строка 47:
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
|-
|-
|id ||int ||идентификатор контакта ||
|id||int||идентификатор контакта ||
|-
|-
|havePlanfixAccess || bool|| имеет ли доступ контакт к ПланФиксу || не возвращается, если первый раз открывается доступ для контакта
|status || enum|| результат выполнения операции || список допустимых значений смотри в разделе [[ПланФикс API:Результат выполнения contact.managePlanfixAccess|результат выполнения contact.managePlanfixAccess]]
|-
|-
|}
|}
Строка 51: Строка 61:
</response>
</response>
</source>
</source>
{| class="wikitable" style="margin-top: 1em; width:100% "
 
!width="50"|Значение ''code'' !! Расшифровка
|-
|align="center"| 0000|| неизвестная ошибка
|-
|}




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

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

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

<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.managePlanfixAccess">
  <account></account>
  <sid></sid>
  <contact>
    <id></id>
    <userid></userid>
    <general></general>
    <email></email>
    <havePlanfixAccess></havePlanfixAccess>
  </contact>
  <signature></signature>
</request>
Название Тип Значение Примечание
id int идентификатор контакта
userid int идентификатор контакта для случаев, когда он используется в системе наравне с сотрудниками (исполнитель задачи и т.п., а также пользовательское поле типа контакт)
general int номер контакта
email string использовать указанный e-mail для организации доступа в ПланФикс не обязательный параметр, используется только в первый раз, при открытии доступа к ПланФик'су
havePlanfixAccess bool запретить (0) или открыть(1) доступ к ПланФикс
signature string(32) подпись


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

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <contact>
    <id></id>
    <status></status>
  </contact>
</response>
Название Тип Значение Примечание
id int идентификатор контакта
status enum результат выполнения операции список допустимых значений смотри в разделе результат выполнения contact.managePlanfixAccess


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

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


Перейти