ПланФикс API: Контакты: различия между версиями

Материал из Planfix
Перейти к: навигация, поиск
Нет описания правки
 
(не показано 11 промежуточных версий 4 участников)
Строка 1: Строка 1:
Список функций для управления контактами в ПланФикс'е
{{#seo:
|title=ПланФикс API: Контакты
|titlemode=append
|keywords=планфикс, контакты, api, апи
|description=контакты api
}}


== contact.add ==
Список функций для управления контактами в ПланФиксе
Создание контрагента:
#[[ПланФикс API contact.add|contact.add / Добавление контакта]]
<source lang="xml">
#[[ПланФикс API contact.update|contact.update / Обновление данных контакта]]
<?xml version="1.0" encoding="UTF-8"?>
#[[ПланФикс API contact.updateCustomData|contact.updateCustomData / Обновление данных пользовательских полей контакта]]
<request method="contact.add">
#[[ПланФикс API contact.get|contact.get / Получить информацию]]
  <account><!-- имя аккаунта --></account>
#[[ПланФикс API contact.getList|contact.getList / Получить список контактов]]
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
#[[ПланФикс API contact.managePlanfixAccess|contact.managePlanfixAccess / Разрешить/запретить доступ в ПланФикс]]
  <contact>
#[[ПланФикс API contact.updateUserInfo|contact.updateUserInfo / Обновить информацию пользователя]]
    <!-- -->
#[[ПланФикс API contact.updateContractors|contact.updateContractors / Изменить информацию о принадлежности контакта к компании]]
    <name>Имя Отчество</name>
#[[ПланФикс API contact.getPhoneTypes|contact.getPhoneTypes/ Получить список типов телефонных номеров]]
    <lastName>Фамилия</lastName>
#[[ПланФикс API contact.getGroupList|contact.getGroupList / Получить список доступных групп контактов в ПланФикс ]]
    <post>Должность</post>
#[[ПланФикс API contact.delete|contact.delete / Удалить контакт]]
    <email></email>
    <mobilePhone>Мобильный телефон</mobilePhone>
    <!-- дополнительные данные -->
    <workPhone>Рабочий телефон</workPhone>
    <homePhone>Домашний телефон</homePhone>
    <address>Адрес</address>
    <description>Дополнительная информация</description>
    <sex>Пол</sex>
    <skype></skype>
    <icq></icq>
    <userPic>base64</userPic>
    <birthday>Дата рождения</birthday>
  </contact>
  <signature></signature>
</request>
</source>
В разделе [[#Константы|Константы]] приведен список допустимых значений для поля '''sex'''.


Ответ:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <contact>
    <id></id>
  </contact>
</response>
</source>
== contact.update ==
Изменение данных о контакте:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.update">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <contact>
    <!-- -->
    <id></id>
    <name>Имя Отчество</name>
    <lastName>Фамилия</lastName>
    <post>Должность</post>
    <email></email>
    <mobilePhone>Мобильный телефон</mobilePhone>
    <!-- дополнительные данные -->
    <workPhone>Рабочий телефон</workPhone>
    <homePhone>Домашний телефон</homePhone>
    <address>Адрес</address>
    <description>Дополнительная информация</description>
    <sex>Пол</sex>
    <skype></skype>
    <icq></icq>
    <userPic>base64</userPic>
    <birthday>Дата рождения</birthday>
  </contact>
  <signature></signature>
</request>
</source>
Ответ:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <contact>
    <id></id>
  </contact>
</response>
</source>
== contact.get ==
Получение информации по клиенту:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.update">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <contact>
    <id></id>
  </contact>
  <signature></signature>
</request>
</source>
Ответ:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <contact>
    <!-- -->
    <id></id>
    <name>Имя Отчество</name>
    <lastName>Фамилия</lastName>
    <post>Должность</post>
    <email></email>
    <mobilePhone>Мобильный телефон</mobilePhone>
    <!-- дополнительные данные -->
    <workPhone>Рабочий телефон</workPhone>
    <homePhone>Домашний телефон</homePhone>
    <address>Адрес</address>
    <description>Дополнительная информация</description>
    <sex>Пол</sex>
    <skype></skype>
    <icq></icq>
    <userPicUrl>???</userPicUrl>
    <birthday>Дата рождения</birthday>
    <!-- Контрагент, компании -->
    <contractors>
      <client>
        <id></id>
        <name></name>
      </client>
      <client>
        <id></id>
        <name></name>
      </client>
      <!-- ... -->
    </contractors>
    <!-- имеется ли доступ к планфиксу -->
    <havePlanfixAccess>{true|false}</havePlanfixAccess>
    <!-- если есть доступ -->
    <user>
      <login></login>
      <role></role>
      <status></status>
      <email></email>
    </user>
  </contact>
</response>
</source>
Если запрос выполняется от учетки не имеющей админ прав, поля '''havePlanfixAccess''' и '''user''' н ебудут переданы.
== contact.getList ==
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.getList">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <pageCurrent></pageCurrent>
  <pageSize></pageSize>
  <sortType></sortType>
  <havePlanfixAccess>true</havePlanfixAccess>
  <signature></signature>
</request>
</source>
параметр '''havePlanfixAccess''' - необязательный, если он указан, то допустимое значение ''true''. При заданном значении будет возвращен список контактов имеющих доступ к ПланФиксу.
Ответ:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <contacts count="x" totalCount="x">
    <contact>
      <!-- -->
      <id></id>
      <name>Имя Отчество</name>
      <lastName>Фамилия</lastName>
      <post>Должность</post>
      <email></email>
      <mobilePhone>Мобильный телефон</mobilePhone>
      <!-- дополнительные данные -->
      <workPhone>Рабочий телефон</workPhone>
      <homePhone>Домашний телефон</homePhone>
      <address>Адрес</address>
      <description>Дополнительная информация</description>
      <sex>Пол</sex>
      <skype></skype>
      <icq></icq>
      <userPicUrl>???</userPicUrl>
      <birthday>Дата рождения</birthday>
      <!-- Контрагент, компании -->
      <contractors>
        <client>
          <id></id>
          <name></name>
        </client>
        <client>
          <id></id>
          <name></name>
        </client>
        <!-- ... -->
      </contractors>
    </contact>
    <!-- ... -->
  </contacts>
</response>
</source>
== contact.managePlanfixAccess ==
Позволяет разрешить или запретить доступ для контакта. Выполнение этой функции требует наличие админ прав.
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.managePlanfixAccess">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <contact>
    <id></id>
    <havePlanfixAccess>{true|false}</havePlanfixAccess>
  </contact>
  <signature></signature>
</request>
</source>
Ответ:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <contact>
    <!-- -->
    <id></id>
    <!-- имеется ли доступ к планфиксу -->
    <havePlanfixAccess>{true|false}</havePlanfixAccess>
  </contact>
</response>
</source>
'''havePlanfixAccess''' - возвращается только в том случае только если клиент активировал  свою учетную запись. И после выполнени яфункции на запрет доступа.
== contact.updateUserInfo ==
Обновить информацию относящуюся к залогиниванию пользователя к системе. Выполнение этой функции требует наличие админ прав.
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.updateUserInfo">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <contact>
    <id></id>
    <user>
      <password></password>
      <status></status>
      <email></email>
    </user>
  </contact>
  <signature></signature>
</request>
</source>
Ответ:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <contact>
    <id></id>
  </contact>
</response>
</source>
== contact.updateContractors ==
Изменение информации о принадлежности контакта к фирме/контрагенту
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.updateContractors">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <contact>
    <id></id>
    <contractors>
      <client>
        <id></id>
        <id></id>
        <!-- -->
      </client>
    </contractors>
  </contact>
  <signature></signature>
</request>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <contact>
    <id></id>
  </contact>
</response>
</source>
== Константы ==
=== Пол ===
*'''MALE''' - Мужской
*'''FEMALE''' - Женский


== Перейти ==
== Перейти ==
[[ПланФикс API]]
[[Список функций]]

Текущая версия от 15:03, 25 марта 2024

Список функций для управления контактами в ПланФиксе

  1. contact.add / Добавление контакта
  2. contact.update / Обновление данных контакта
  3. contact.updateCustomData / Обновление данных пользовательских полей контакта
  4. contact.get / Получить информацию
  5. contact.getList / Получить список контактов
  6. contact.managePlanfixAccess / Разрешить/запретить доступ в ПланФикс
  7. contact.updateUserInfo / Обновить информацию пользователя
  8. contact.updateContractors / Изменить информацию о принадлежности контакта к компании
  9. contact.getPhoneTypes/ Получить список типов телефонных номеров
  10. contact.getGroupList / Получить список доступных групп контактов в ПланФикс
  11. contact.delete / Удалить контакт


Перейти

Список функций

Источник — http://planfix.com/ru/help/index.php?title=ПланФикс_API:Контакты&oldid=45568