Поиск мест. /2.0/catalog/branch/search

Координаты левой верхней вершины прямоугольной области видимости в формате `lon, lat`. Параметры `viewpoint1` и `viewpoint2` передают область карты, куда смотрел пользователь перед вводом запроса. Используется как один из критериев для выбора, где нужны результаты, и для ранжирования. Не ограничивает жёстко результаты поиска только переданной областью.

viewpoint1

Координаты нижней правой вершины прямоугольной области видимости в формате `lon, lat`. Параметры `viewpoint1` и `viewpoint2` передают область карты, куда смотрел пользователь перед вводом запроса. Используется как один из критериев для выбора, где нужны результаты, и для ранжирования. Не ограничивает жёстко результаты поиска только переданной областью.

viewpoint2

 Сортировка результатов. Допустимые значения: <ul> <li>`relevance` — по убыванию релевантности. В поиске участвует название организации и категории, в которые входит организация. Учитывает максимум разных факторов: точность соответствия запроса объекту, популярность объектов, рейтинг, расположение, реклама и многое другое;</li> <li>`distance` — по возрастанию расстояния. <br>Расстояние рассчитывается до центра площадных геообъектов (городов, районов и т.д.) и по кратчайшему расстоянию до линейных (улиц). <br>Если передан параметр `sort_point`, то расстояние рассчитывается до этой точки;</li> <li>`rating` — по убыванию рейтинга;</li> <li>`flamp_rating` — по убыванию рейтинга Флампа;</li> <li>`creation_time` — по убыванию даты создания филиала организации;</li> <li>`opened_time` — по убыванию даты открытия;</li> <li>`name` — по наименованию (в алфавитном порядке по возрастанию).</li> </ul>

sort

Время генерации рекламных весов в формате TIMESTAMP

Присутствует, если применяется цветовое кодирование, например в случае станций метро.

Тип маршрута. 

Возможные значения:

 * `bus` — автобус;
 * `trolleybus` — троллейбус;
 * `tram` — трамвай;
 * `shuttle_bus` — маршрутное такси;
 * `metro` — метро;
 * `suburban_train` — электропоезд;
 * `funicular_railway` — фуникулёр;
 * `monorail` — монорельс;
 * `river_transport` — водный транспорт;
 * `cable_car` — канатная дорога;
 * `light_rail` — скоростной трамвай;
 * `premetro` — метротрам;
 * `light_metro` — лёгкое метро;
 * `aeroexpress` — аэроэкспресс.

Тип станции. 

Возможные значения:

 * `stop` — остановка городского наземного транспорта;
 * `railway` — железнодорожный вокзал;
 * `metro` — станция метро;
 * `river_transport` — речной порт;
 * `trolleybus` — троллейбус;
 * `tram` — трамвай;
 * `funicular_railway` — фуникулёр;
 * `monorail` — монорельс;
 * `cable_car` — канатная дорога;
 * `light_rail` — скоростной трамвай;
 * `premetro` — метротрам;
 * `light_metro` — лёгкое метро.

Адрес, по которому располагается филиал организации.

Уточнение о местоположении филиала по указанному адресу.

Представление поля address в виде одной строки.

Псевдоним названия организации.

Собственное имя здания.

Динамические свойства филиала.

Время внесения информации о филиале в БД.

Численность сотрудников организации. Поле доступно только в коммерческом API. 

Доступные варианты:

 * нет данных
 * до 15
 * 16-100
 * 101-250
 * 251-1000
 * более 1000

Аттрибуты для электрозаправок.

Информация об этажах здания.

Количество этажей в здании.

Представление адреса в виде одной строки с указанием города.

Признак наличия информации о квартирах в здании

Уникальный идентификатор филиала организации.

Признак удаленного объекта

Если true, то проезд до объекта возможен, если false или отсутствует, то нет.

Индивидуальный номер налогоплательщика. Поле доступно только в коммерческом API.

Связанные объекты.

Возможные значения:
 * `entrances` — точки входа;
 * `database_entrances` — точки входа;
 * `branches` — организации;
 * `servicing` — обслуживающие организации;
 * `providers` — провайдеры;
 * `airports` — аэропорты;
 * `parking` — парковки;
 * `nearest_parking` — ближайшие парковки;
 * `nearest_stations` — ближайшие остановки;
 * `railway_terminals` — железнодорожные вокзалы;
 * `bus_terminals` — автовокзалы;
 * `hotels` — отели;
 * `river_ports` — речные порты;
 * `seaports` — морские порты;
 * `attractions` — достопримечательности;
 * `landmarks` — ориентиры.

Полное собственное название филиала или название организации.

Ссылка на оплату парковки (диплинк в другое приложение, на сайт).

Координаты точки поиска, заданные в системе координат WGS84 в формате lon, lat.

Описание назначения здания.

Уникальный идентификатор проекта.

Расписание работы филиала.

Параметры результата поиска. Возвращается только в поисковых методах версии 3.0.

Уникальный идентификатор сегмента.

Информация о горнолыжном подъемнике.

Идентификатор источника данных об объекте. Если отсутсвует, источник данных — 2GIS.

Набор блокирующих атрибутов, соответствующих запросу.

Данные о количестве квартир и материале здания. Поле доступно только в коммерческом API.

Смещение таймзоны в минутах относительно UTC0.

Лицензия филиала. Поле доступно только в коммерческом API.

Тип объекта. 

Возможные значения:

 * `branch` — филиал организации.

branch

Значение группы, полученное из Sapphire.

Идентификатор рубрики.

Локализованное название атрибута.

Количество организаций в рубрике.

Размеченная часть подсказки.

Строка подсказки для suggest.

Дата последнего обновления данных.

Количество филиалов организаций в данной метарубрике.

Короткая подпись к иконке для отображения в UI.

Количество геообъектов в данной метарубрике.

Ссылка на SVG-изображение.

Идентификатор метарубрики.

Количество организаций в данной метарубрике.

Поисковая строка, которая подставляется в строку поиска и которая передается в запрос для формирования выдачи.

Заголовок для отображения в UI.

CTA для раскрытия метарубрики.

Идентификатор метарубрики, филиалы которой требуется найти.

Признак того, что в запросе требуются ближайшие объекты.

Признак, что самый релеватный результат найден по частичному совпадению.

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

GTA баннеры и сторисы.

Уникальный почтовый код здания.

Уникальный идентификатор дома, к которому относится данный адрес.

Название здания (в адресе для филиалов).

Массив компонентов адреса. 

Возможные значения:

 * `street_number` — типичный адрес;
 * `number` — только номер дома;
 * `location` — универсальное описание.

Название места, к которому относится здание.

Универсальное описание.

Словесное описание местоположения строения.

location

Код ФИАС. Поле доступно только в коммерческом API.

Номер дома, включая дроби и буквенные обозначения. Возможно, имя собственное, если так принято.

Код ОКАТО. Поле доступно только в коммерческом API.

Код ОКТМО. Поле доступно только в коммерческом API.

number

Номер дома, включая дроби, корпуса и буквенные обозначения.

street_number

Принадлежность к административной территории.

Название территории (для использования в функционале «поделиться», для конечных точек маршрута и т.д.).

Детализированный тип административно-территориальной единицы.

Возможные значения:

 * `city` — город;
 * `microdistrict` — микрорайон;
 * `residential_district` — жилмассив;
 * `residential_quarter` — квартал;
 * `poselok` — посёлок;
 * `residential_complex` — жилой комплекс;
 * `selo` — село;
 * `derevnja` — деревня;
 * `cottage_estate` — коттеджный посёлок;
 * `urban_settlement` — посёлок городского типа;
 * `workers_settlement` — рабочий посёлок;
 * `dacha_settlement` — дачный посёлок;
 * `resort_settlement` — курортный посёлок;
 * `stanitsa` — станица;
 * `sloboda` — слобода;
 * `khutor` — хутор;
 * `aul` — аул;
 * `aal` — аал;
 * `town` — (военный) городок;
 * `farmstead` — заимка;
 * `vyselok` — выселок;
 * `municipality` — муниципальное образование;
 * `station` — станция;
 * `townhouse_settlement` — посёлок таунхаусов;
 * `territory` — территория;
 * `cooperative` — кооператив;
 * `partnership` — товарищество.

Идентификатор объекта административной единицы.

Заполняется только для type=city и принимает единственное значение true в случае, если город является главным городом текущего проекта (например Новосибирск).

Тип объекта административной единицы. 

Возможные значения:

 * `city` — город;
 * `settlement` — населённый пункт;
 * `division` — округ;
 * `district` — район;
 * `living_area` — жилмассив, микрорайон;
 * `place` — место;
 * `district_area` — район области;
 * `region` — регион (область/край/республика и т.п.);
 * `country` - страна.

Список действий по внешним рекламным ресурсам.

Рекламные материалы для доноров ЗМК («Здесь можно купить»).

Рекламные материалы для owner'а owned рубрики.

Идентификаторы маркировки креативов.

Рекламные материалы для доноров FMCG.

Рекламные материалы для owner'а FMCG.

Список рекламных изображений.

Содержит ФИО (для ИП) или наименование (для юридического лица), форму собственности (ИП, ООО и т.п.).

Логотип рекламодателя.

Логотип рекламодателя для маркера.

Признак наличия сторис у филиала или организации.

Признак наличия рекламной poi на карте.

Реклама в подсказчике.

Список рекламных видеоматериалов.

Дополнительные атрибуты филиала.

Список допоплнительных атрибутов в данной группе.

Признак того, что есть пересечение между контекстными рубриками и рубриками дополнительных атрибутов этой группы.

Признак того, что есть пересечение между primary рубриками филиала и рубриками дополнительных атрибутов этой группы.

Название группы дополнительных атрибутов.

Массив идентификаторов рубрик, связанных с группой дополнительных атрибутов

Алиас города, в котором находится объект.

Ключ описывает значение балла загруженности для которого заданы временные интервалы и дни. Допустимые значения балла: 1 — 10. В данным могут присутствовать не все баллы.

Ключ описывает день недели для которого представлены интервалы с заданным баллом. Допустимые значения: "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun".

Значения интервалов 0 — 23. (0 — с 0 до 1, 23 — с 23 до 24 часов).

Комментарий к группе контактов.

Расписание группы контактов.

Уточняющая информация о контакте.

Значение контакта для вывода на принтер.

Значение контакта для вывода на экран.

Тип контакта.

Возможные значения:

 * `email` — электронная почта;
 * `website` — сайт, протокол http;
 * `phone` — телефон;
 * `fax` — факс;
 * `icq` — аккаунт в ICQ;
 * `jabber` — Jabber;
 * `skype` — Skype;
 * `vkontakte` — ВКонтакте;
 * `twitter` — Twitter;
 * `instagram` — Instagram;
 * `facebook` — Facebook;
 * `pobox` — P.O.Box (абонентский ящик);
 * `youtube` — Youtube;
 * `odnoklassniki` — ok.ru;
 * `googleplus` — Google +;
 * `linkedin` — Linkedin;
 * `pinterest` — Pinterest; `whatsapp` — Whatsapp; `telegram` — Telegram; `viber` — Viber; `jivo` — Jivo.

Ссылка на сайт или социальную сеть.

Техническое значение контакта.

Расстояние до некой точки в метрах. Считается относительно переданной в запросе точки в параметре `point` или `sort_point`, и переданном параметре `sort=distance`.

Попадает ли объект в границы сортировки.

Код группы обслуживающих организаций.

Коды групп обслуживающих организаций.

Дата открытия организации в формате ISO 8601.

Дата удаления организации из базы в формате ISO 8601.

Дата последнего изменения информации об организации в формате ISO 8601.

Объект, описывающий свойства доставки организации

Номер телефона для связи с компанией с целью оформления заказа

Блок «Возможно, вы имели ввиду».

Наиболее релевантная категория при полнотекстовом поиске (параметр q).

Возможные значения:

 * `geo` — геообъект;
 * `branch` — филиал;
 * `transport` — транспорт (маршрут, остановка, остановочная платформа).

Города при безрезультативном поиске.

Контекстные рубрики безрезультативного поиска.

Разрешение на отправку письма в компанию.

email, на которые необходимо отправлять письма в компанию.

Дополнительные данные филиала, такие как буклеты и фотографии.

Количество фотографий в альбоме.

URL первой фотографии альбома.

Код альбома.

Возможные значения:

 * `common`;
 * `view`;
 * `facilities`.

URL основного фото персональной страницы филиала в справочнике 2ГИС.

Тип буклета.

Возможные значения:
 * `buildings`;
 * `saunas`.

Заголовок персональной страницы филиала в справочнике 2ГИС.

Адрес персональной страницы филиала в справочнике 2ГИС.

Код персональной страницы филиала в справочнике 2ГИС.

URL основного фото скидок филиала в справочнике 2ГИС.

Адрес скидок филиала в справочнике 2ГИС.

Код скидок филиала в справочнике 2ГИС.

Фильтры для дополнительного поиска.

Фильтр по дополнительным атрибутам.

Список признаков объекта.

Признак наличия у здания 3D модели на карте. Присутствует только, если значение равно true.

Заполняется только для type=city и принимает единственное значение true в случае, если город является главным городом текущего проекта (например Новосибирск)

Заполняется только для type=adm_div, subtype=city|settlement и принимает единственное значение true в случае, если населённый пункт является районным центром.

Заполняется только для type=adm_div, subtype=city|settlement и принимает единственное значение true в случае, если населённый пункт является областным центром.

Есть ли для объекта фотографии.

Строка, наличие которой говорит о том, что филиал временно не работает. В строке выгружается код причины закрытия.

Дополнительные сведения о временно не работающем филиале.

Идентификатор этажа по умолчанию для отображения на карте при показе этажей здания.

Массив этажей здания. Сортировка: от нижних этажей к верхним.

Визуальный центр геометрии объекта.

Геометрия области, используемой для определения попадания курсора в зону объекта.

Геометрия для выделения объекта.

Идентификатор объекта.

Признак того, что это главный объект в группе объектов гибрида.

Идентификатор организации.

Подтип поглощенного объекта. 

Возможные значения:

 * `place` — место;
 * `stop` — остановка городского наземного транспорта;
 * `railway` — железнодорожный вокзал;
 * `metro` — станция метро;
 * `river_transport` — речной порт;
 * `trolleybus` — троллейбус;
 * `tram` — трамвай;
 * `funicular_railway` — фуникулёр;
 * `monorail` — монорельс;
 * `cable_car` — канатная дорога;
 * `light_rail` — скоростной трамвай;
 * `premetro` — метротрам;
 * `light_metro` — лёгкое метро.

Тип объекта.

Возможные значения:

 * `branch` — филиал;
 * `building` — здание;
 * `attraction` — достопримечательность;
 * `adm_div` — административная территория;
 * `station` — остановка;
 * `station_platform` — остановочная платформа;
 * `station_entrance` — вход на станцию.

Идентификатор рекламной компании.

Идентификатор алгоритма, по которому был подобран баннер. Для фолбэк баннеров будут использоваться их идентификаторы алгоритмов. Для GTA будет единый алгоритм 17. Идентификатор алгоритма нужен для того, чтобы в БСС различать старые и новые баннеры явным образом, а не по комбинации наличия/отсутствия полей в баннере.

Идентификатор аукциона, который был проведен чтобы получить этот идентификатор филиала. Этот идентификатор должен быть передан в bss при посылке показа.

Будет заполнятся версией рекламных материалов. Используется для скрытия конкретного баннера на стороне продукта и дальнейшего возобновления (аналог логики возобновления показа кб).

Признак рекламности баннера

В discovery выдаче - признак приоритета баннера при его показе (0 - самый высокий, 2 - самый низкий).

Идентификатор рубрики, в которой старый алгоритм нашел этот рекламный баннер.

Хеш для регистрации BC, а также открытия филиала.

Идентификатор первой рубрики филиала.

Идентификатор проекта.

Идентификатор сегмента.

Идентификатор алгоритма, по которому был подобран сторис. Идентификатор алгоритма нужен для того, чтобы в BSS различать сторисы явным образом, а не по комбинации наличия/отсутствия полей в сторисе.

Идентификаторы маркировки креативов, представляет собой список строковых идентификаторов зарегистрированных в Едином реестре интернет-рекламы.

Uuid сторис, генерируется при создании сторис. Так же используется в BSS.

Уникальный идентификатор организации.

Идентификатор проекта, в котором расположены филиалы.

Текст. Поле не обязательно в discovery_list, обязательно в organization_stories.

Uuid слайда, генерируется при создании слайда. Так же используется в BSS.

Интервал свайпа слайда в мс.

Шаблон страницы, который описывает визуальную часть слайда.

Тип действия кнопки. Может быть либо link, либо phone, либо open_card. Значение value будет соответствующим.

Заголовок (Название фирмы).

Правила акции, юридическое, ФАС (возможны html теги).

Положение текста. `left_top` - текст прикрепляется к верху страницы и имеет выравнивание Align Left (имеет свой слой фейдов). `left_bottom` - текст прикрепляется к низу страницы (выше кнопки) и имеет выравнивание Align Left. Дефолтное значение `left_top`.

Длительность видео в секундах.

Текст рекламной статьи.

Текст предупреждения для рекламной статьи.

Является ли рекламодатель обладателем социального пакета.

Структура рекламных опций.

Текст короткого рекламного объявления.

Текст предупреждения для короткого рекламного объявления.

Достопримечательности.

Ближайшие станции метро.

Ближайшие остановочные платформы.

Железнодорожные вокзалы.