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

Версия от 13:24, 13 мая 2015

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

<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.getList">
  <account></account>
  <sid></sid>
  <pageCurrent></pageCurrent>
  <pageSize></pageSize>
  <target></target>
  <signature></signature>
</request>

Название	Тип	Значение	Примечание
pageCurrent	int	запрашиваемая страница
pageSize	int	размер запрашиваемого списка
target	enum / int	контакты, компании или заданный фильтр задач	допустимые значения смотри ниже
signature	string(32)	подпись

Допустимые значения параметра target

Значение	Описание	Примечание
contact	контакты	значение по умолчанию
company	компании
идентификатор фильтра контактов	доступные фильтры можно получить функцией task.getFilterList

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

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <contacts count="count" totalCount="totalCount">
    <contact>
      <id></id>
      <general></general>
      <name></name>
      <lastName></lastName>
      <isCompany></isCompany>
      <post></post>
      <email></email>
      <mobilePhone></mobilePhone>
      <workPhone></workPhone>
      <homePhone></homePhone>
      <address></address>
      <description></description>
      <sex></sex>
      <skype></skype>
      <icq></icq>
      <userPic></userPic>
      <birthday></birthday>
      <havePlanfixAccess>{true|false}</havePlanfixAccess>
      <user>
        <login></login>
        <role></role>
        <status></status>
        <email></email>
      </user>
      <contractors>
        <client>
          <id></id>
          <name></name>
        </client>
        <client>
          <id></id>
          <name></name>
        </client>
        <!-- ... -->
      </contractors>
    </contact>
    <!-- ... -->
  </contacts>
</response>

Название	Тип	Значение	Примечание
contacts		список контактов
contacts count	int	количество контактов в списке
contacts totalCount	int	количество контактов удовлетворяющих условию запроса
contact		узел, описывающий контакт
id	int	идентификатор контакта
general	int	номер контакта
name	string	Имя Отчество
lastName	string	Фамилия
isCompany	boolean	Является компанией
post	string	Должность
email	string	адрес электронной почты
mobilePhone	string	Мобильный телефон
workPhone	string	Рабочий телефон
homePhone	string	Домашний телефон
address	string	Адрес
description	string	Дополнительная информация
sex	enum	пол	допустимые значения смотри в разделе пол клиента
skype	string	skype-контакт
icq	string	номер-icq
userPic	string	ссылка на изображение
birthday	DateTime	дата рождения
signature	string(32)	подпись
contractors		список контрагентов, к которым он относится
contractors.client		описание контрагента
contractors.client.id	int	идентификатор клиента/контрагента
contractors.client.name	string	имя/название контрагента
havePlanfixAccess	bool	имеет ли контакт доступ к ПланФикс	данный параметр возвращается только пользователю с правами администратор
user		учетные данные контакта	данный параметр возвращается только пользователю с правами администратор
user.login	string	логин в системе
user.role	string	роль
user.status	enum	статус
user.email	string	адрес электронной почты

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

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

Перейти

@@ Строка 7: / Строка 7: @@
    <pageCurrent></pageCurrent>
    <pageSize></pageSize>
-   <sortType></sortType>
+   <target></target>
-  <havePlanfixAccess></havePlanfixAccess>
-  <client>
-    <id></id>
-  </client>
    <signature></signature>
 </request>
@@ Строка 22: / Строка 18: @@
 |pageSize ||int ||размер запрашиваемого списка ||
 |-
-|sortType ||enum ||тип сортировки ||список допустимых значений смотри в разделе [[ПланФикс API:Типы сортировок контактов|типы сортировок контактов]]
+|target ||enum / int ||контакты, компании или заданный фильтр задач || допустимые значения смотри ниже
 |-
-|havePlanfixAccess || bool||имеет ли контакт доступ в ПланФикс ||необязательный параметр, допустимое значение только '''true'''
+|signature ||string(32) || подпись||
 |-
-|client.id || int||фильтр по контрагенту ||необязательный параметр
+|}
+=== Допустимые значения параметра target ===
+{| class="wikitable" style="margin-top: 1em; width:100% "
+!Значение !! Описание !! Примечание
 |-
-|signature ||string(32) || подпись||
+|contact|| контакты|| значение по умолчанию
+|-
+|company|| компании||
+|-
+|идентификатор фильтра контактов|| доступные фильтры можно получить функцией [[ПланФикс API task.getFilterList|task.getFilterList]]||
 |-
 |}
@@ Строка 39: / Строка 43: @@
      <contact>
        <id></id>
+      <general></general>
        <name></name>
        <lastName></lastName>
+      <isCompany></isCompany>
        <post></post>
        <email></email>
@@ Строка 88: / Строка 94: @@
 |-
 |id||int||идентификатор контакта ||
+|-
+|general||int||номер контакта ||
 |-
 |name ||string ||Имя Отчество ||
 |-
 |lastName ||string || Фамилия||
+|-
+|isCompany|| boolean|| Является компанией||
 |-
 |post || string|| Должность||