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

Версия от 11:14, 7 мая 2016

Функция обновления информации о клиенте. Формат запроса:

<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.update">
  <account></account>
  <sid></sid>
  <contact>
    <id></id>
    <general></general>
    <name></name>
    <lastName></lastName>
    <post></post>
    <email></email>
    <mobilePhone></mobilePhone>
    <workPhone></workPhone>
    <homePhone></homePhone>
    <address></address>
    <description></description>
    <sex></sex>
    <skype></skype>
    <icq></icq>
    <birthdate></birthdate>
    <lang></lang>
    <canBeWorker></canBeWorker>
    <canBeClient></canBeClient>
    <customData>
      <customValue>
        <id></id>
        <value></value>
      </customValue>
      <!-- ... -->
    </customData>
  </contact>
  <signature></signature>
</request>

Название	Тип	Значение	Примечание
id	int	идентификатор обновляемого контакта
general	int	номер обновляемого контакта (используется если не задан id)
name	string	Имя Отчество
lastName	string	Фамилия
post	string	Должность
email	string	адрес электронной почты
mobilePhone	string	Мобильный телефон
workPhone	string	Рабочий телефон
homePhone	string	Домашний телефон
address	string	Адрес
description	string	Дополнительная информация
sex	enum	пол	допустимые значения смотри в разделе пол клиента
skype	string	skype-контакт
icq	string	номер-icq
birthdate	DateTime	дата рождения
lang	string	язык: Ru, En
canBeWorker	boolean	отображается в списке участников задачи
canBeClient	boolean	отображается в списке контрагентов задачи
customData		значения пользовательских полей контакта
customData.customValue.id		идентификатор пользовательского поля контакта
customData.customValue.value		значение пользовательского поля контакта
signature	string(32)	подпись

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

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

Название	Тип	Значение	Примечание
contact.id	int	идентификатор обновляемого контакта
contact.general	int	номер добавленного контакта

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

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

Перейти