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

Версия 13:16, 13 мая 2015

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

<?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>
    <birthdate></birthdate>
    <isCompany></isCompany>
    <canBeWorker></canBeWorker>
    <canBeClient></canBeClient>
  </contact>
  <signature></signature>
</request>

Название	Тип	Значение	Примечание
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	дата рождения
isCompany	boolean	является компанией
canBeWorker	boolean	отображается в списке участников задачи
canBeClient	boolean	отображается в списке контрагентов задачи
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>

Перейти