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

Версия 13:00, 12 августа 2010

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

Содержание

1 contact.add
2 contact.update
3 contact.get
4 contact.getList
5 Константы
- 5.1 Пол
6 Перейти

contact.add

Создание контрагента:

<?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>

В разделе Константы приведен список допустимых значений для поля sex.

Ответ:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <contact>
    <id></id>
  </contact>
</response>

contact.update

Изменение данных о контакте:

<?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>

Ответ:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <contact>
    <id></id>
  </contact>
</response>

contact.get

Получение информации по клиенту:

<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.update">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <contact>
    <id></id>
  </contact>
  <signature></signature>
</request>

Ответ:

<?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>

Если запрос выполняется от учетки не имеющей админ прав, поля havePlanfixAccess и user н ебудут переданы.

contact.getList

<?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>

параметр havePlanfixAccess - необязательный, если он указан, то допустимое значение true. При заданном значении будет возвращен список контактов имеющих доступ к ПланФиксу.

Ответ:

<?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>

Константы

Пол

MALE - Мужской
FEMALE - Женский

Перейти

ПланФикс API