2GIS

Филиалы фирмы

Выводит список филалов фирмы по уникальному идентификатору. Например, Starbucks имеет 50 кофеен в городе. Starbucks — это фирма, а каждая отдельная кофейня — филиал. Использование метода позволяет в результатах поиска или карточке фирмы дать ссылку на список всех филиалов и показать их на карте.

URL: http://catalog.api.2gis.ru/firmsByFilialId

Параметры запроса

Параметр Обязательное Тип Описание
key Да Строка

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

Пример: 1234567890.

version Да Строка Указывает версию API, с которой идет работа. Возможные значения: 1.3
firmid Да Строка Идентификатор фирмы. Пример: 4504136498283164
page Нет Число Номер запрашиваемой страницы. Значение по умолчанию: 1.
pagesize Нет Число Количество результатов поиска, выводимых на одной странице. Значение по умолчанию: 20. Ограничение: от 5 до 50.
output Нет Строка Формат ответа. Может принимать значения xml, json, jsonp. По умолчанию используется json.
callback Нет Строка

Название callback функции для jsonp-запроса. Ограничение: последовательность латинских букв, цифр и знака подчеркивания. Максимальная длина названия callback функции — 128 символов. В случае неправильного задания используется значение по умолчанию (dgCallback).

Пример: myCallback_1

Параметры ответа

Параметр Тип Описание
api_version Строка Версия API, с которой идет работа. Возможные значения: 1.3
response_code Строка Код ответа API. Подробнее см. Коды ответов.
В случае успешного ответа
firm_id Строка Идентификатор фирмы, для которой производился поиск филиалов. Пример: 4504136498283164
total Число Количество филиалов, найденных по запросу.
result Массив См. Параметры филиала.
В случае ошибки
error_code Строка Код ошибки, см. Коды ошибок.
error_message Строка

Описание ошибки.

Пример: API version must be set. Supported versions are: 1.3

Параметры филиала
Параметр Тип Описание
id Строка Уникальный идентификатор филиала. Пример: 141265769336625.
lon Строка Долгота координаты места расположения филиала. Система координат WGS84. Пример: 82.9117574728652.
lat Строка Широта координаты места расположения филиала. Система координат WGS84. Пример: 55.0346747796494.
name Строка Название филиала. Пример: Сибакадемстрой Недвижимость, агентство недвижимости.
firm_group Объект Информация о фирме, к которой относится филиал. Объект с ключами id — уникальный идентификатор фирмы и count — количество филиалов фирмы.
hash Строка Уникальный хэш, требуется для передачи в запрос на получение профиля филиала.
city_name Строка Город, к которому относится филиал.
address Строка Адрес, по которому располагается филиал. Пример: Димитрова проспект, 7 - 2 этаж.
rubrics Массив

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

Пример: ["Пряжа","Товары для творчества и рукоделия","Швейная фурнитура"].

reviews_count Число Количество отзывов на flamp.ru. Параметр присутствует в ответе, только если есть хотя бы один отзыв.

Пример

Получить филиалы фирмы 4504136498283164 (Starbucks). Результаты отдавать по 5 филиалов на странице. Взять результаты со страницы 3.

Запрос: http://catalog.api.2gis.ru/firmsByFilialId?firmid=4504136498283164&pagesize=5&page=3&version=1.3&key=1234567890

Ответ: