ПланФикс API contact.add: различия между версиями
Материал из Planfix
Seva (обсуждение | вклад) Нет описания правки |
Seva (обсуждение | вклад) Нет описания правки |
||
Строка 24: | Строка 24: | ||
<canBeWorker></canBeWorker> | <canBeWorker></canBeWorker> | ||
<canBeClient></canBeClient> | <canBeClient></canBeClient> | ||
<group> | |||
<id></id> | |||
</group> | |||
<customData> | <customData> | ||
<customValue> | <customValue> | ||
Строка 79: | Строка 82: | ||
|- | |- | ||
|canBeClient|| boolean||отображается в списке контрагентов задачи || | |canBeClient|| boolean||отображается в списке контрагентов задачи || | ||
|- | |||
|group.id || int || идентификатор группы контактов || | |||
|- | |- | ||
|customData|| ||значения пользовательских полей контакта|| | |customData|| ||значения пользовательских полей контакта|| |
Версия от 06:32, 21 декабря 2016
Функция добавления контакта. Формат запроса:
<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.add">
<account></account>
<sid></sid>
<contact>
<template></template>
<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>
<isCompany></isCompany>
<canBeWorker></canBeWorker>
<canBeClient></canBeClient>
<group>
<id></id>
</group>
<customData>
<customValue>
<id></id>
<value></value>
</customValue>
<!-- ... -->
</customData>
</contact>
<signature></signature>
</request>
Название | Тип | Значение | Примечание |
---|---|---|---|
template | id | номер шаблона контакта, (general в результатах contact.getList) | |
Реализация создания контакта по шаблону в API на текущий момент неполна.
Из шаблона устанавливается форма создания контакта (и соответственно имеющиеся в контакте пользовательские поля) и часть её свойств. Из шаблона на текущий момент не устанавливаются: аналитики, файлы, чек-листы, напоминания | |||
name | string | Имя Отчество | |
lastName | string | Фамилия | |
post | string | Должность | |
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 | |
isCompany | boolean | является компанией | |
canBeWorker | boolean | отображается в списке участников задачи | |
canBeClient | boolean | отображается в списке контрагентов задачи | |
group.id | int | идентификатор группы контактов | |
customData | значения пользовательских полей контакта | ||
customData.customValue.id | идентификатор пользовательского поля контакта | ||
customData.customValue.value | значение пользовательского поля контакта | ||
signature | string(32) | подпись |
Результат успешного выполнения функции:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<contact>
<id></id>
<userid></userid>
<general></general>
</contact>
</response>
Название | Тип | Значение | Примечание |
---|---|---|---|
contact.id | int | идентификатор добавленного контакта | |
contact.userid | int | идентификатор контакта для случаев, когда он используется в системе наравне с сотрудниками (исполнитель задачи и т.п.) | |
contact.general | int | номер добавленного контакта |
В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>