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

Материал из ПланФикс
Перейти к: навигация, поиск
Строка 8: Строка 8:
 
#[[ПланФикс API contact.updateContractors|contact.updateContractors / Изменить информацию о принадлежности контакта к фирме(контрагенту)]]
 
#[[ПланФикс API contact.updateContractors|contact.updateContractors / Изменить информацию о принадлежности контакта к фирме(контрагенту)]]
  
== contact.add ==
 
Создание контрагента:
 
<source lang="xml">
 
<?xml version="1.0" encoding="UTF-8"?>
 
<request method="contact.add">
 
  <account><!-- имя аккаунта --></account>
 
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
 
  <contact>
 
    <!-- -->
 
    <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>
 
В разделе [[#Константы|Константы]] приведен список допустимых значений для поля '''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]]
 
[[ПланФикс API]]

Версия 14:50, 24 августа 2010

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

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


Перейти

ПланФикс API