Получение данных о полях

Получить список полей и их возможные значения

POST https://api.lotinfo.ru/v1/FIELDS

Эта конечная точка позволяет узнать, какие у нужного типа объекта есть поля и значения, которые может принимать поле.

Query Parameters

Name	Type	Description
token*	string	Ваш токен.

Request Body

Name	Type	Description
encoding	integer	Кодировка. Значения: 0 - не кодировать, 1 - кодировать. По умолчанию: 0. Пример закодированных символов: "\u0423\u043a\u0430\u0436".
type*	string	"list"
field*	string	По какому полю выдать результат. Значения: objects, orders.
objectType*	integer	Тип объекта. Значения: Покупка: 3 - Квартиры, 5 - Комнаты, 6 - Строящееся жилье, 7 - Склады, 8 - Индивидуальное жилье, 12 - Гаражи / паркинги, 13 - Офисы, 17 - Торговые площади, 19 - Земельные участки, 20 - Производственные помещения, 21 - Помещения свободного назначения. Аренда: 4 - Комнаты, 9 - Офисные помещения, 11 - Квартиры, 14 - Коттеджи, дома, 15 - Склады, 18 - Торговые помещения, 22 - Производственные помещения, 23 - Помещения свободного назначения.

200 Ответ (на запрос из примера).

HTTP/1.1 200 OK
Content-Type: application/json

{
  "result": [
    {
      "fields": {
        "agentComment": {
          "type": "standart",
          "typeField": "chars",
          "RUname": "Комментарии агента"
        },
        "balcony": {
          "type": "standart",
          "typeField": "set",
          "RUname": "Балкон",
          "values": [
            {
              "key": "1",
              "value": "Нет"
            },
            {
              "key": "2",
              "value": "Балкон"
            },
            {
              "key": "3",
              "value": "Лоджия"
            },
            
            ...
            
          ]
        },
        
        ...
        
      }
    }
  ]
}

400 Пример ответа на запрос с ошибкой. (Код сервера будет с кодом 200.)

HTTP/1.1 200 OK
Content-Type: application/json

{
  "errors": [
    {
      "error": 9,
      "error_text": "Укажите одно из доступных значений: list, find, parameters."
    }
  ]
}

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

POST https://api.lotinfo.ru/v1/FIELDS?TOKEN={ваш_токен} HTTP/1.1
Content-Type: application/json

{
  "type": "list",
  "field": "objects",
  "objectType": 3
}

Получить список доступных значений по полю

POST https://api.lotinfo.ru/v1/FIELDS

Эта конечная точка даёт возможность узнать значения по полям, которые имеют большое количество значений, иногда индивидуальных под каждого пользователя/агентство.

Query Parameters

Name	Type	Description
token*	string	Ваш токен.

Request Body

Name	Type	Description
encoding	integer	Кодировка. Значения: 0 - не кодировать, 1 - кодировать. По умолчанию: 0. Пример закодированных символов: "\u0423\u043a\u0430\u0436".
type*	string	"parameters"
field*	string	По какому полю выдать результат. Возможные значения "field": - userCategory - Ваши группы клиентов. - metro - Метро. Дополнительные параметры: cityId - ID города. - workers - Работники Вашего агентства. - services - Услуги агентства. - depts - Отделы агентства.

200 Ответ (на запрос из примера).

HTTP/1.1 200 OK
Content-Type: application/json

{
  "result": [
    {
      "metro": {
        "2468": "Новокосино",
        "2473": "Новогиреево",
        "2478": "Перово",
        "2483": "Шоссе энтузиастов",
        "2488": "Авиамоторная",
        "2493": "Площадь Ильича",
        "2498": "Марксистская",
        "2503": "Третьяковская",
        "2508": "Деловой центр",
        "2518": "Минская",
        "2523": "Ломоносовский проспект",
        "2528": "Раменки",
        "2533": "Речной вокзал",
        "2538": "Водный стадион",
        "2548": "Сокол",
        "2553": "Аэропорт",
        "2558": "Динамо",
        "2563": "Белорусская",
        
        ...
        
      }
    }
  ]
}

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

POST https://api.lotinfo.ru/v1/FIELDS?TOKEN={ваш_токен} HTTP/1.1
Content-Type: application/json

{
  "type": "parameters",
  "field": "metro",
  "cityId": 1067
}