Получение данных по заявкам

post
Список заявок

https://api.lotinfo.ru/v1/ORDERS
Эта конечная точка позволяет получать списки заявок.
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 заявки. - objectTypes (array) - Типы объектов недвижимости. Значения: Покупка: 3 - Квартиры, 5 - Комнаты, 6 - Строящееся жилье, 7 - Склады, 8 - Индивидуальное жилье, 12 - Гаражи / паркинги, 13 - Офисы, 17 - Торговые площади, 19 - Земельные участки, 20 - Производственные помещения, 21 - Помещения свободного назначения. Аренда: 4 - Комнаты, 9 - Офисные помещения, 11 - Квартиры, 14 - Коттеджи, дома, 15 - Склады, 18 - Торговые помещения, 22 - Производственные помещения, 23 - Помещения свободного назначения. Примечание: Тип (покупка или аренда) должен совпадать с полем type. - dogType (string) - Тип заявки. Значения: "1" - Устный договор, "2" - Письменный договор, "3" - Без договора, "lost" - Просроченный договор, "ufrskik" - На регистрации в УФРСКиК, "avans" - Аванс / задаток. - home (integer) - Номер дома. - color (integer) - Цвет в системе. - clientsGroup (integer) - Группы клиентов. Значения: id Ваших значений. - 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. - district (integer) - ID района. - districtAdm (integer) - ID административного района. - regionId (integer) - ID региона. Примечание: regionId не нужно указывать, если указан cityId, он определится автоматически. - cityid (integer) - ID города. - regionName (string) - Название региона. (Поиск regionId по названию региона.) - cityName (string) - Название города. (Поиск cityId по названию города.) Примечание: поиск по cityName возможет только, если указан regionId или regionName. - workers (array) - ID сотрудников, кому принадлежат заявки. Значения: id сотрудников. Примечание: сотрудник должен быть прикреплён к агентству. - type (string) - Тип (аренда или продажа). Значения: "rent" - аренда, не указан - продажа. Также возможен поиск по полям из списка "fields".
order
optional
object
Поля сортировки. Параметры "order": - id - ID заявки. - district - ID района. - sumarea - Площадь. - mls - МЛС. - price - Цена за объект. - priceMeter - Цена за квадратный метр. - room - Количество комнат. - floor - Этаж. - addDate - Дата добавления. - editDate - Дата изменения. - delDate - Дата удаления. - archDate - Дата архивирования. - maxMls - МЛС/СПП вознаграждение. - equalsBNew - Не просмотренные предложения. Значения для всех полей: asc - по возрастанию, desc - по убыванию.
projection
optional
array
Выводимые поля. Значения "projection": названия полей, которые необходимо вывести.
limit
optional
integer
Максимальное число выводимых заявок. По умолчанию: 3000. Максимальное значение: 3000.
offset
optional
integer
Сдвиг. По умолчанию: 0.
Response
200: OK
Пример ответа (на запрос из примера ниже).
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": [
{
"id": {
"fieldName": "ID в системе lotinfo",
"fieldType": "key",
"fieldMulti": "not_multi",
"values": [
{
"id": "1"
}
]
},
"regionId": {
"fieldName": "Регион",
"fieldType": "key_value",
"fieldMulti": "not_multi",
"values": [
{
"value": "Москва и Московская обл.",
"id": "107"
}
]
},
"cityId": {
"fieldName": "Регион",
"fieldType": "key_value",
"fieldMulti": "not_multi",
"values": [
{
"value": "Москва",
"id": "1067"
}
]
}
},
{
"id": {
"fieldName": "ID в системе lotinfo",
"fieldType": "key",
"fieldMulti": "not_multi",
"values": [
{
"id": "2"
}
]
},
"regionId": {
"fieldName": "Регион",
"fieldType": "key_value",
"fieldMulti": "not_multi",
"values": [
{
"value": "Москва и Московская обл.",
"id": "107"
}
]
},
"cityId": {
"fieldName": "Регион",
"fieldType": "key_value",
"fieldMulti": "not_multi",
"values": [
{
"value": "Москва",
"id": "1067"
}
]
}
}
]
}
400: Bad Request
Пример ответа на запрос с ошибкой. (Ответ сервера будет с кодом 200.)
HTTP/1.1 200 OK
Content-Type: application/json
{
"errors": [
{
"error": 9,
"error_text": "Укажите одно из доступных значений: 0 (ASC), 1 (DESC)",
"error_field": "price"
}
]
}

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

POST https://api.lotinfo.ru/v1/ORDERS?TOKEN={ваш_токен} HTTP/1.1
Content-Type: application/json
{
"limit": 5,
"filter": {
"userId": 123,
"dogType": 3,
"objectTypes": [3]
},
"order": {
"price": "asc",
"room": "desc"
},
"projection": ["id", "regionId", "cityId"]
}

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

Клиент

"fieldType": "client"

id - ID клиента. name - Комментарий.

"client": {
"fieldName": "Клиент",
"fieldType": "client",
"fieldMulti": "not_multi",
"values": [
{
"id": "101",
"name": ""
}
]
}

Агент

"fieldType": "agent"

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

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