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

Материал из Planfix
Перейти к: навигация, поиск
Нет описания правки
Нет описания правки
 
Строка 18: Строка 18:
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
|-
|-
|id ||int ||идентификатор контакта ||
|id||int||идентификатор контакта ||
|-
|userid||int||идентификатор контакта для случаев, когда он используется в системе наравне с сотрудниками (исполнитель задачи и т.п., а также пользовательское поле типа контакт) ||
|-
|general||int||номер контакта ||
 
|-
|-
|email|| string || использовать указанный e-mail для организации доступа в ПланФикс || не обязательный параметр, используется только в первый раз, при открытии доступа к ПланФик'су
|email|| string || использовать указанный e-mail для организации доступа в ПланФикс || не обязательный параметр, используется только в первый раз, при открытии доступа к ПланФик'су
Строка 43: Строка 48:
|-
|-
|id||int||идентификатор контакта ||
|id||int||идентификатор контакта ||
|-
|userid||int||идентификатор контакта для случаев, когда он используется в системе наравне с сотрудниками (исполнитель задачи и т.п., а также пользовательское поле типа контакт) ||
|-
|general||int||номер контакта ||
|-
|-
|status || enum|| результат выполнения операции || список допустимых значений смотри в разделе [[ПланФикс API:Результат выполнения contact.managePlanfixAccess|результат выполнения contact.managePlanfixAccess]]
|status || enum|| результат выполнения операции || список допустимых значений смотри в разделе [[ПланФикс API:Результат выполнения contact.managePlanfixAccess|результат выполнения contact.managePlanfixAccess]]

Текущая версия от 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>


Перейти