PDF Печать

Список клиентов

URI:
/BumsCrmApiV01/Contractor/list.api
/BumsCrmApiV01/Contractor/list.xml
См. "Общие правила запросов"

Версия Мегаплана: 2012.07+

Входные параметры

ПараметрТипОписание
FilterIdintegerИдентификатор фильтра
LimitintegerСколько выбрать клиентов (LIMIT) Выборка происходит с начала от меньших ID к большим
Offset*integerНачиная с какого выбирать клиента (OFFSET)
qsstringУсловие поиска
PhonestringНомер телефона в произвольном формате
ModelarrayМассив в формате имя поля => значение. Используется для фильтрации по конкретным значениям полей.


  • Offset — порядковый номер в получившейся выборке. Например если у нас 10 клиентов и 5 — с именем Иван,
то запрос
$request→post( '/BumsCrmApiV01/Contractor/list.api', array(
'Limit' => 1,
'Offset' => 3,
'qs' => 'Иван'
)
Вернет третьего по порядку из этих пяти.

Выходные данные

ПараметрТипОписание
IdintegerИдентификатор клиента
NamestringИмя клиента
BirthdaydatetimeДата рождения
DescriptionstringОписание клиента
EmailstringE-mail
Facebookstring Facebook
JabberstringJabber
Payersobject (Id, Name)Список плательщиков
PersonTypestringТип клиента
PreferTransportstringПредпочтительный способ связи
PromisingRatestringПерспективность
Responsiblesobject (Id, Name)Ответственные
SitestringСайт
TimeCreateddatetimeВремя создания
TimeUpdateddatetimeВремя обновления
TwitterstringTwitter
TypestringТип




Пример ответа в JSON-формате

{
  "status":
  {
    "code":"ok",
    "message":null
  },
  "params":
  {
    "FilterId":0,
    "Limit":0,
    "Offset":0,
    "qs":""
  },
  "data":
  {
    "clients":[
      {
        "Id":1022073,
        "Name":"Denisov Ivan",
        "Birthday":"1980-01-01",
        "Description":"",
        "Email":"oleg@test.com",
        "Facebook":"",
        "Jabber":"",
        "Payers":[{"Id":1020826,"Name":""}],
        "PersonType":"company",
        "PreferTransport":"",
        "PromisingRate":"0",
        "Responsibles":[{"Id":1000000,"Name":"Name"}],
        "Site":"",
        "TimeCreated":"2012-08-23 12:56:45",
        "TimeUpdated":"2012-08-23 13:56:45",
        "Twitter":"",
        "Type":{"Id":1,"Name":"Клиент"}
      }
    ]
  }
}


Пример ответа в XML-формате

<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <params>
    <filter_id>0</filter_id>
    <limit>0</limit>
    <offset>0</offset>
    <qs></qs>
  </params>
  <data>
    <clients>
      <item>
        <id>1022073</id>
        <name>Denisov Ivan</name>
        <birthday>1980-01-01</birthday>
        <description></description>
        <email>oleg@test.com</email>
        <facebook></facebook>
        <jabber></jabber>
        <players>
          <id>1020826</id>
          <name></name>
        </players>
        <person_type>company</person_type>
        <prefer_transport></prefer_transport>
        <promising_rate></promising_rate>
        <responsibles>
          <id>1020826</id>
          <name></name>
        </responsibles>
        <site></site>
        <time_created>2012-08-23 12:56:45</time_created>
        <time_updated>2012-08-23 12:56:45</time_updated>
        <twitter></twitter>
        <type>
          <id>1</id>
          <name>Клиент</name>
        </type>
      </item>
    </clients>
  </data>
</response>


Назад к оглавлению