Получение данных по объектам

post
Список объектов

https://api.lotinfo.ru/v1/OBJECTS
Эта конечная точка позволяет получать списки объектов.
Request
Response
Request
Query Parameters
token
required
string
Ваш токен.
Form Data Parameters
encoding
optional
integer
Кодировка. Значения: 0 - не кодировать, 1 - кодировать. По умолчанию: 0. Пример закодированных символов: "\u0423\u043a\u0430\u0436".
filter
optional
object
Фильтры для поиска. Параметры "filter": - userId (integer) - ID пользователя. - systemId (integer) - ID объекта. - objectType (integer) - Тип объекта. Значения: 3 - Квартиры, 5 - Комнаты, 6 - Строящееся жилье, 7 - Склады, 8 - Индивидуальное жилье, 12 - Гаражи / паркинги, 13 - Офисы, 17 - Торговые площади, 19 - Земельные участки, 20 - Производственные помещения, 21 - Помещения свободного назначения. - lightHouse (integer) - Маяк или не маяк. Значения: 0 - Не маяк, 1 - Маяк. Примечание: указывается этот параметр или параметр oStatus. - tocorpsite (integer) - Выгрузка на корп. сайт. Значения: 0 - Не помечен на выгрузку в корп. сайт, 1 - Помечен на выгрузку в корп. сайт. - apiIdExchange (integer) - ID объекта в вашей системе. Примечание: этот параметр вы указываете при добавлении объекта по API. - systemStatus (integer) - Статус объекта. Значения: 0 - Актуальные, 1 - Архив, 2 - Удалённые. - advStatus (integer) - Статус в рекламе. Значения: 1 - В рекламе, 0 - Не в рекламе. - addDate (object) - Дата добавления. Параметры: - min (optional) - Нижний порог. - max (optional) - Верхний порог. Формат: Unix time. - editDate (object) - Дата изменения. Параметры: - min (optional) - Нижний порог. - max (optional) - Верхний порог. Формат: Unix time. - delDate (object) - Дата удаления. Параметры: - min (optional) - Нижний порог. - max (optional) - Верхний порог. Формат: Unix time. - archDate (object) - Дата архивирования. Параметры: - min (optional) - Нижний порог. - max (optional) - Верхний порог. Формат: Unix time. - dogType (integer) - Вид отношений. Значения: 1 - Письменный договор, 2 - Устный договор, 3 - Договор отсутствует. - avans (integer) - Наличие аванса. Значения: 0 - Нет, 1 - Да. - inRegistrate (integer) - Регистрация. Значения: 0 - Нет, 1 - На регистрации. - type - district (integer) - Микрорайон. Значения: id районов. - street (integer) - Улица. Значения: id улиц. - streetName (string) - Название улицы. (Поиск street по названию улицы.) - home (string) - Дом. Значения: номер дома. - corp (string) - Корпус. Значения: номер корпуса. - regionId (integer) - ID региона. Примечание: regionId не нужно указывать, если указан cityId, он определится автоматически. - cityId (integer) -ID города. - regionName (string) - Название региона. (Поиск regionId по названию региона.) - cityName (string) - Название города. (Поиск cityId по названию региона.) Примечание: поиск по cityName возможен только, если указан regionId или regionName. - color (integer) - Цвет в системе. - priceMeter (object) - Цена за квадратный метр. Параметры: - min (integer) - Нижний порог. - max (integer) - Верхний порог. - price (object) - Цена объекта. Параметры: - min (integer) - Нижний порог. - max (integer) - Верхний порог. - room (object) - Количество комнат. Параметры: - min (integer) - Нижний порог. - max (integer) - Верхний порог. - sumarea (object) - Площадь объекта. Параметры: - min (integer) - Нижний порог. - max (integer) - Верхний порог. - floor (object) - Номер этажа. Параметры: - min (integer) - Нижний порог. - max (integer) - Верхний порог. - floors (object) - Количество этажей. Параметры: - min (integer) - Нижний порог. - max (integer) - Верхний порог. - date_home (object) - Дата постройки объекта. Параметры: - min (integer) - Верхний порог. - max (integer) - Нижний порог. - oStatus (integer) - Статус объекта. Значения: 0 - Мониторинг, 1 - Маяк, 2 - Реальный объект на продажу, 3 - Реальный объект для внутреннего использования. - rechange (string) - Обмен. Значения: "yes" - Готовы рассмотреть, "conditions" - Рассматривается с условиями. - rechangeUslType (integer) - Условия обмена. Значения: 1 - Мне нужна доплата, 2 - Готов доплатить. - rechangeUslMoney (object) - Сумма доплаты. Параметры: - min (integer) - Верхний порог. - max (integer) - Нижний порог. Формат: сумма в рублях. - rechangeUslregionId (integer) - Регион обмена. Значения: id регионов. Примечание: rechangeUslregionId не нужно указывать, если указан rechangeUslcityId, он определится автоматически. - rechangeUslcityId (integer) - Город обмена. Значения: id городов. - rechangeUslregionName (string) - Название региона обмена. (Поиск rechangeUslregionId по названию региона.) - rechangeUslcityName (string) - Название города обмена. (Поиск rechangeUslcityId по названию города.) Примечание: поиск по rechangeUslcityName возможен только, если указан rechangeUslregionId или rechangeUslregionName. Также возможен поиск по полям из списка "fields".
order
optional
object
Поля сортировки. Параметры "order": - id - ID объекта. - district - Микрорайон. - sumarea - Площадь объекта. - price - Цена объекта. - equalsnew - Не просмотренные предложения. - room - Количество комнат. - floor - Номер этажа. - floors - Количество этажей. - address - Адрес. - advStatus - Статус в рекламе. - priceMeter - Цена за квадратный метр. - addDate - Дата добавления. - editDate - Дата изменения. - delDate - Дата удаления. - archDate - Дата архивирования. Значения для всех полей: asc - по возрастанию, desc - по убыванию.
projection
optional
array
Выводимые поля. Значения "projection": названия полей, которые необходимо вывести.
nomedia
optional
integer
Не выводить данные о медиафайлах (и документах). Может быть равно 1 или быть не указано. 1 - не выводить данные.
noclient
optional
integer
Не выводить данные о клиентах. Может быть равно 1 или быть не указано. 1 - не выводить данные.
limit
optional
integer
Максимальное число выводимых объектов. По умолчанию: 3000. Максимальное значение: 3000.
offset
optional
integer
Сдвиг. По умолчанию: 0.
Response
200: OK
Пример ответа (на запрос из примера ниже).
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": [
{
"systemId": {
"fieldName": "ID в системе lotinfo",
"fieldType": "key",
"fieldMulti": "not_multi",
"values": [
{
"id": "107"
}
]
},
"addDate": {
"fieldName": "Дата добавления",
"fieldType": "value",
"fieldMulti": "not_multi",
"values": [
{
"value": "2021-04-21T18:29:02+05:00"
}
]
}
}
]
}
400: Bad Request
Пример ответа на запрос с ошибкой. (Ответ сервера будет с кодом 200.)
HTTP/1.1 200 OK
Content-Type: application/json
{
"errors": [
{
"error": 7,
"error_text": "Неизвестный пользователь: 124."
}
]
}

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

POST https://api.lotinfo.ru/v1/OBJECTS?TOKEN={ваш_токен} HTTP/1.1
Content-Type: application/json
{
"limit": 5,
"nomedia": "1",
"filter": {
"userId": 123,
"systemStatus": "0",
"tocorpsite": "0",
"date_home": {
"min": 2010
},
"floor": {
"min": 5,
"max": 10
},
"objectType": 3
},
"order": {
"room": "asc",
"price": "desc"
},
"projection": ["systemId", "addDate"]
}

Кастомные поля

Клиенты

"fieldType": "client"

id - ID клиента. lpr - Лицо принимающее решения. name - Комментарий. doled - Доля.

"clients": {
"fieldName": "Клиенты",
"fieldType": "client",
"fieldMulti": "multi",
"values": [
{
"id": "114",
"lpr": "1",
"name": "Клиент 1",
"doled": ""
},
{
"id": "115",
"lpr": "0",
"name": "Клиент 2",
"doled": ""
}
]
}

Медиа

"fieldType": "media"

link - Ссылка на медиафайл. typeContent - Тип контента. typeId - ID типа. type - Описание типа на русском.

"media": {
"fieldName": "Медиафайлы",
"fieldType": "media",
"fieldMulti": "multi",
"values": [
{
"link": "https:\/\/files.lotinfo.ru\/objects\/35f4.jpg",
"typeContent": "image",
"type": "Фото объекта",
"typeId": "2"
},
{
"link": "https:\/\/files.lotinfo.ru\/objects\/ef2d.jpg",
"typeContent": "image",
"type": "Фото объекта",
"typeId": "2"
}
]
}

Документы

"fieldType": "media"

link - Ссылка на документ. typeContent - Тип контента. typeId - ID типа. type - Описание типа на русском. name - Название документа.

"documents": {
"fieldName": "Документы",
"fieldType": "docs",
"fieldMulti": "multi",
"values": [
{
"link": "https:\/\/files.lotinfo.ru\/usersFiles\/900f.jpg",
"typeContent": "image",
"type": "Документы основания",
"typeId": "1",
"name": "Справка ЕГРН"
}
]
}

Агент

"fieldType": "agent"

user - ФИО агента, id - ID клиента, phone - Номер телефона, publicPhone - Номер телефона для публикации.

"agent": {
"fieldName": "Агент",
"fieldType": "agent",
"fieldMulti": "not_multi",
"values": [
{
"user": "Иванов Иван Иванович",
"id": "125",
"phone": "79998887766",
"publicPhone": ""
}
]
}