Добавление клиентов

put
Добавить клиентов
https://api.lotinfo.ru/v1/CLIENTS
Эта конечная точка позволяет добавлять клиентов.
Request
Response
Request
Query Parameters
token
required
string
Ваш токен.
Form Data Parameters
encoding
optional
integer
Кодировка.
Значения: 0 - не кодировать, 1 - кодировать. По умолчанию: 0.
Пример закодированных символов: "\u0423\u043a\u0430\u0436".
data
required
array
Массив с данными о клиентах.

Параметры данных клиента:
- userId (integer) - ID пользователя.
- apiIdExchange (integer) - ID клиента в вашей системе.
Примечание: в этом параметре вы можете передать ID клиента в вашей системе, чтобы потом запросить его по этому же ID.
- fioF (string) - Фамилия клиента.
- fioI (string) - Имя клиента.
- fioO (string) - Отчество клиента.
- fioDesc (string) - Описание клиента.
- sex (string) - Пол.
Значения: "male" - мужской, "female" - женский.
- birthday (string) - День рождения.
Формат: дд.мм.гггг.
- deeps (integer) - Правоспособность.
Значения: 1 - Малолетний, 2 - Несовершеннолетний, 3 - Совершеннолетний.
- deepon (integer) - Дееспособность.
Значения: 1 - Дееспособный, 2 - Ограниченно дееспособный, 3 - Недееспособный.
- clientc (integer) - Тип клиента.
Значения: 1 - Клиент, 2 - Контрагент, 3 - Лид.
- family (integer) - Семейное положение.
Значения: 0 - Нет, 1 - В браке.
- address (string) - Адрес.
- regionId (integer) - ID региона.
Примечание: regionId не нужно указывать, если указан cityId, он определится автоматически.
- cityId (integer) - ID города.
- regionName (string) - Название региона. (Поиск regionId по названию региона.)
- cityName (string) - Название города. (Поиск cityId по названию города.)
Примечание: поиск по cityName возможет только, если указан regionId или regionName.
- userCategory (array) - Группы.
Значения: id Ваших значений.
- clientType (integer) - Тип клиента.
Значения: 0 - Физическое лицо, 1 - Агент, 3 - Застройщик, 4 - Подрядчик, 2 - Другое.
- agency (string) - Название агентства (если clientType = 1), Наименование организации (если clientType = 2, 3 или 4).

Следующие параметры описаны ниже в "Body Parameters":
- contacts (array) - Контакты.
- comments (array) - Комментарии.
- passport (object) - Паспортные данные.
- objects (array) - Объекты клиента.
- orders (array) - Заявки клиента.
Body Parameters
contacts
optional
array
Массив с данными контактов.

Параметры данных контакта:
- type (string, required) - Тип контакта.
Значения: "mobile" - мобильный телефон, "city" - городской телефон, "email" - email, "other" - другой.
- value (string, required) - Значение контакта.
Примечание: мобильный телефон должен начинаться с "7", городской телефон должен начинаться с "8".
- general (integer) - Главный контакт в типе.
Значения: 0 - не главный контакт, 1 - главный контакт.
Примечание: В каждом типе должен быть только один контакт с general = 1. "Mobile" и "city" считаются одним типом для general. Если не указать general ни одному контакту, он будет указан автоматически первому.
- comment (string) - Комментарий к контакту.
- spy (integer) - Отслеживание активности по контакту.
Значения: 0 - не отслеживать, 1 - отслеживать.
Примечание: указывается только у контактов с типом "mobile" и "city".
comments
optional
array
Массив с данными комментариев.

Параметры данных комментариев:
- value (string, required) - Текст комментария.
passport
optional
object
Паспортные данные клиента.

Параметры "passport":
- serial (integer) - Серия.
Формат: 4 цифры.
- number (integer) - Номер.
Формат: 6 цифр.
- sended (string) - Кем выдан.
- dateSended (string) - Дата выдачи.
Формат: дд.мм.гггг
- codePod (string) - Код подразделения.
Формат: 123-456.
- placeBirth (string) - Место рождения.
- propiska (string) - Прописка.
- placeHome (string) - Фактическое место проживания.
- snils (string) - СНИЛС.
Формат: "123-123-123 44"
objects
optional
array
Массив с данными об объектах клиента.

Параметры данных объектов:
- id (integer) - ID объекта.
Примечание: объект должен принадлежать пользователю.
- name (string) - Имя клиента.
- lpr (integer) - Лицо принимающее решение (ЛПР).
Значения: 0 - не ЛПР, 1 - ЛПР.
Примечание: ЛПР у одного из владельцев объекта должен быть 1. Если он не будет указан, мы его укажем автоматически.
- doled (string) - Доля.
Формат: 1/3.
orders
optional
array
Массив с данными о заявках клиента.

Параметры данных заявок:
- id (integer) - ID заявки.
- name (string) - Имя/название/комментарий.
Response
200: OK
Пример ответа (на запрос из примера ниже) с выводом уведомлений ("notices").
В результатах выдачи "id" - это ID созданных клиентов.
HTTP/1.1 200 OK
Content-Type: application/json
​
{
  "result": [
    {
      "id": 101
    },
    {
      "id": 102
    }
  ],
  "notices": [
    {
      "notice": 5,
      "notice_text": "У этого объекта уже был клиент с ЛПР=1, теперь ЛПР=1 у клиента 2.",
      "notice_field": "lpr",
      "notice_array": 1
    }
  ]
}
400: Bad Request
Пример ответа на запрос с ошибкой.
(Ответ сервера будет с кодом 200.)
HTTP/1.1 200 OK
Content-Type: application/json
​
{
  "errors": [
    {
      "error": 7,
      "error_text": "Неизвестный пользователь: 124.",
      "error_field": "userId",
      "error_array": 0
    }
  ]
}
Пример запроса
PUT https://api.lotinfo.ru/v1/CLIENTS?TOKEN={ваш_токен} HTTP/1.1
Content-Type: application/json
​
{
  "code": 101010,
  "data": [
    {
      "userId": 123,
      "fioF": "Иванов",
      "fioI": "Иван",
      "fioO": "Иванович",
      "fioDesc": "Описание перрвого клиента",
      "sex": "male",
      "birthday": "10.01.1985",
      "address": "ул. Ленина",
      "cityId": "1067"
    },
    {
      "userId": 123,
      "fioF": "Васильев",
      "fioI": "Василий",
      "fioO": "Васильевич",
      "fioDesc": "Описание второго клиента",
      "sex": "male",
      "birthday": "20.02.1975",
      "deeps": "3",
      "deepon": "1",
      "address": "ул. Молодёжная",
      "regionName": "Москва",
      "cityName": "Одинцово",
      "clientc": "1",
      "userCategory": [10, 12, 25],
      "contacts": [
        {
          "type": "mobile",
          "value": 79998886655
        },
        {
          "type": "mobile",
          "value": 79998886644,
          "general": 1,
          "spy": 1,
          "comment": "Комментарий для второго телефона"
        }
      ],
      "comments": [
        {
          "value": "Первый комментарий"
        },
        {
          "value": "Второй комментарий"
        }
      ],
      "passport": {
        "serial": "1234",
        "number": "123456",
        "sended": "Отделом УФМС России по Москве",
        "dateSended": "5.9.2010",
        "codePod": "770-077",
        "placeBirth": "гор. Москва",
        "propiska": "Адрес прописки",
        "placeHome": "Место проживания",
        "snils": "123-123-123 44"
      },
      "objects": [
        {
          "id": 234,
          "lpr": 1
        },
        {
          "id": 235,
          "name": "Василий",
          "lpr": 1,
          "doled": "1/2"
        }
      ],
      "orders": [
        {
          "id": 789,
          "name": "Добавление заявки"
        }
      ]
    }
  ]
}
​
База клиентов - Previous
Получение данных по клиентам
Next - База клиентов
Изменение клиента
Last updated 2 months ago
Добавление клиентов

putДобавить клиентов

Пример запроса

put
Добавить клиентов
