Получение профиля

Выводит подробную информацию о профиле филиала по его уникальному идентификатору.

URL: http://catalog.api.2gis.ru/2.0/catalog/branch/get

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

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

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

Пример: 1234567890.

id Да Строка

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

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

Пример: 1234567890_07dd2164eb829f6d7532f9a9b56d3ffd30.

Можно также передать несколько идентификаторов через запятую.

format Нет Строка Формат ответа. Может принимать значения:
  • xml
  • json
  • jsonp
По умолчанию используется json.
callback Нет Строка

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

Пример: myCallback

locale Нет Строка Локаль на которой отдавать результат. Возможные значения:
  • cs_CZ
  • en_CY
  • es_CL
  • it_IT
  • ru_RU
  • ru_KZ
  • ru_UA
  • en_AE
  • ar_AE
  • ru_KG
  • uk_UA
По умолчанию используется ru_RU.
fields Нет Строка

Дополнительные поля, которые необходимо отобразить в ответе, перечисляются через запятую. Допустимые значения:

  • items.region_id
  • items.point
  • items.adm_div
  • items.dates
  • items.photos
  • items.see_also
  • items.flags
  • items.locale
  • items.address
  • items.schedule
  • items.name_ex
see_also_size Нет Число

Максимальное количество результатов в see_also. По умолчанию 2. Ограничение: от 2 до 4.

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

Параметр Тип Описание
meta* Структура

Общая информация об ответе

result* Структура

Основной результат

Общая информация об ответе (meta)
Параметр Тип Описание
code* Целое число

Код ответа API. Подробнее см. Коды ответов

Основной результат (result)
Параметр Тип Описание
total* Целое число

Количество найденных объектов

items* Массив структур

Массив найденных объектов

Массив найденных объектов (items)
Параметр Тип Описание
id* Строка

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

Примеры:

  • 141265769336625_f91d4H3777058262347790J0e8g28765

region_id Строка

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

Входит в ответ, если указать items.region_id в fields.

type* Строка

Допустимые значения:

  • branch

name* Строка

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

Примеры:

  • Солнышко, кафе

name_ex Структура

Составные части наименования организации

Входит в ответ, если указать items.name_ex в fields.

alias Строка

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

Примеры:

  • shintop_set_avtomarketov

point Структура | Null

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

Входит в ответ, если указать items.point в fields.

reg_bc_url Строка

URL для регистрации бизнес-коннекшна просмотра профиля.

adm_div Массив структур

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

Входит в ответ, если указать items.adm_div в fields.

address Структура | Null

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

Входит в ответ, если указать items.address в fields.

address_name Строка

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

Примеры:

  • Димитрова проспект, 7

address_comment Строка

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

Примеры:

  • 3й подъезд
  • 4 этаж
  • офис 413

employees_org_count Строка

Численность сотрудников организации. Доступные варианты:

Доступ ограничен. Для получения разрешений обратитесь в поддержку.

Примеры:

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

itin Строка

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

Доступ ограничен. Для получения разрешений обратитесь в поддержку.

Примеры:

  • 1234567890

org* Структура

Организация, к которой относится филиал

attribute_groups Массив структур

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

locale Строка

Текущая локаль для региона.

Входит в ответ, если указать items.locale в fields.

Примеры:

  • ru_RU
  • it_IT

contact_groups Массив структур

Контакты филиала

schedule Структура | Null

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

Входит в ответ, если указать items.schedule в fields.

rubrics Массив структур

Рубрики филиала

ads Структура

Рекламные материалы данного филиала

dates Структура

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

Входит в ответ, если указать items.dates в fields.

photos Структура | Массив

Deprecated! Свойство не поддерживается и в ближайшее время будет удалено из ответа API. Фотографии объекта.

Входит в ответ, если указать items.photos в fields.

see_also Массив структур

Список 'смотри также'

Входит в ответ, если указать items.see_also в fields.

flags Структура

Список признаков филиала

Входит в ответ, если указать items.flags в fields.

context Структура

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

Составные части наименования организации (items.name_ex)
Параметр Тип Описание
primary* Строка

Собственное имя филиала.

Примеры:

  • Солнышко
  • Базальт, ООО

extension Строка

Расширение имени филиала.

Примеры:

  • кафе
  • независимая экспертная компания

legal_name Строка

Юридическое название филиала

Примеры:

  • ООО Базальт

description Строка

Описание филиала

Примеры:

  • №3
  • Офис
  • Склад

addition Строка

Дополнительная информация к названию филиала, которая должна быть показана в развёрнутой карточке.

Координаты точки поиска, заданные в системе координат WGS84, в формате lon,lat (items.point)
Параметр Тип Описание
lon* Число

Долгота

Примеры:

  • 55.10401153

lat* Число

Широта

Примеры:

  • 36.75896072

Принадлежность к административной территории (items.adm_div)
Параметр Тип Описание
id* Строка

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

type* Строка

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

Допустимые значения:

  • city — город
  • settlement — населённый пункт
  • division — округ
  • district — район
  • living_area — жилмассив, микрорайон
  • place — место

name* Строка

Имя объекта

Примеры:

  • Усть-Каменогорск

Адрес, по которому располагается филиал организации (items.address)
Параметр Тип Описание
building_id Строка

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

Примеры:

  • 20498230958

building_name Строка

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

Примеры:

  • Сан Сити

postcode Строка

Почтовый индекс.

Минимальная длина: 4

Максимальная длина: 12

Примеры:

  • 630007

components Массив любой из структур

Типичный адрес

Только номер дома

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

Типичный адрес (items.address.components)
Параметр Тип Описание
id Строка

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

type* Строка

Допустимые значения:

  • street_number

street* Строка

Название улицы.

Примеры:

  • Ленина
  • Красный проспект

street_id Строка

Идентификатор геометрии улицы.

number* Строка

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

Примеры:

  • 46
  • 21/2 корп. 7

Только номер дома (items.address.components)
Параметр Тип Описание
id Строка

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

type* Строка

Допустимые значения:

  • number

number* Строка

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

Примеры:

  • 213
  • Почтамт

Универсальное описание (items.address.components)
Параметр Тип Описание
id Строка

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

type* Строка

Допустимые значения:

  • location

comment* Строка

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

Организация, к которой относится филиал (items.org)
Параметр Тип Описание
id* Строка

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

Примеры:

  • 141265769336625

name* Строка

Собственное имя организации.

branch_count* Целое число

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

Примеры:

  • 7

Дополнительные атрибуты филиала (items.attribute_groups)
Параметр Тип Описание
name Строка

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

Примеры:

  • Гостиница

is_context* Булев

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

is_primary* Булев

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

rubric_ids* Массив

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

attributes* Массив структур

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

Список доп. атрибутов в данной группе (items.attribute_groups.attributes)
Параметр Тип Описание
tag Строка

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

Примеры:

  • hotel_room_internet

name* Строка

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

Примеры:

  • Бесплатный интернет в номерах

Контакты филиала (items.contact_groups)
Параметр Тип Описание
name Строка

Имя группы контактов.

Примеры:

  • Сервисный центр

comment Строка

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

Примеры:

  • Многокональный телефон

schedule Структура | Null

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

contacts* Массив структур

Список контактов

Расписание группы контактов (items.contact_groups.schedule)
Параметр Тип Описание
Mon Структура

Понедельник

Tue Структура

Вторник

Wed Структура

Среда

Thu Структура

Четверг

Fri Структура

Пятница

Sat Структура

Суббота

Sun Структура

Воскресенье

is_24x7 Булев

Признак того, что организация работает круглосуточно 7 дней в неделю.

comment Строка

Комментарий.

Примеры:

  • Кругосуточно в праздничные дни

Список контактов (items.contact_groups.contacts)
Параметр Тип Описание
type* Строка

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

Допустимые значения:

  • 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

value* Строка

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

Примеры:

  • Телефон в международном формат
  • Протокол не указывается

text Строка

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

Примеры:

  • e-mail Иванова

print_text Строка

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

Примеры:

  • e-mail Иванова

comment Строка

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

Примеры:

  • для деловой переписки

reg_bc_url Строка

Deprecated! Свойство не поддерживается и в ближайшее время будет удалено из ответа API. URL для регистрации дополнительного бизнес-коннекшна.

Расписание работы филиала (items.schedule)
Параметр Тип Описание
Mon Структура

Понедельник

Tue Структура

Вторник

Wed Структура

Среда

Thu Структура

Четверг

Fri Структура

Пятница

Sat Структура

Суббота

Sun Структура

Воскресенье

is_24x7 Булев

Признак того, что организация работает круглосуточно 7 дней в неделю.

comment Строка

Комментарий.

Примеры:

  • Кругосуточно в праздничные дни

Рубрики филиала (items.rubrics)
Параметр Тип Описание
id* Строка

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

short_id* Целое число

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

name* Строка

Собственное имя рубрики.

alias Строка

Транслированное название страницы в web.

parent_id Строка

Идентификатор объединяющей рубрики.

kind* Строка

Тип рубрики.

Допустимые значения:

  • primary — основная
  • additional — дополнительная

Рекламные материалы данного филиала (items.ads)
Параметр Тип Описание
is_social Булев

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

warning Строка

Deprecated! Свойство не поддерживается и в ближайшее время будет удалено из ответа API. Текст предупреждения.

Примеры:

  • Курение вредит вашему здоровью

text Строка

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

Примеры:

  • Только у нас только сейчас только здесь

article Строка

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

Примеры:

  • <strong>Рекламная статья</strong><br/>Покупайте наших слонов.

text_warning Строка

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

Примеры:

  • Курение вредит вашему здоровью

article_warning Строка

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

Примеры:

  • Курение вредит вашему здоровью

link Структура

Рекламная ссылка

Рекламная ссылка (items.ads.link)
Параметр Тип Описание
value* Строка

URL адрес.

Примеры:

  • http://krutaya-kompanya.ru/sale?ref=2gis

text Строка

Описание для ссылки.

Примеры:

  • Распродажа, узнай больше

Время внесения информации о филиале в БД (items.dates)
Параметр Тип Описание
created_at Строка

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

Примеры:

  • 2012-04-18T12:08:03.273144+07:00

Список 'смотри также' (items.see_also)
Параметр Тип Описание
id* Строка

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

type* Строка

Тип.

Допустимые значения:

  • branch

name* Строка

Название филиала организации.

Примеры:

  • Сибакадемстрой Недвижимость, агентство недвижимости

name_ex* Структура

Составные части наименования организации

org* Структура

Организация, к которой относится филиал

point Структура | Null

Координаты точки поиска

address_name Строка

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

Примеры:

  • Димитрова проспект, 7

address_comment Строка

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

Примеры:

  • 3й подъезд
  • 4 этаж
  • офис 413

ads Структура

Рекламные материалы данного филиала

main_photo_url Строка

URL основного фото филиала.

Примеры:

  • http://cephgw1.2gis.com/e453e1c7df0cff5c97824fefa879c65b.jpg

address Структура | Null

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

Составные части наименования организации (items.see_also.name_ex)
Параметр Тип Описание
primary* Строка

Собственное имя филиала.

Примеры:

  • Солнышко
  • Базальт, ООО

extension Строка

Расширение имени филиала.

Примеры:

  • кафе
  • независимая экспертная компания

legal_name Строка

Юридическое название филиала

Примеры:

  • ООО Базальт

description Строка

Описание филиала

Примеры:

  • №3
  • Офис
  • Склад

addition Строка

Дополнительная информация к названию филиала, которая должна быть показана в развёрнутой карточке.

Организация, к которой относится филиал (items.see_also.org)
Параметр Тип Описание
id* Строка

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

Примеры:

  • 141265769336625

name* Строка

Собственное имя организации.

branch_count* Целое число

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

Примеры:

  • 7

Координаты точки поиска (items.see_also.point)
Параметр Тип Описание
lon* Число

Долгота

Примеры:

  • 55.10401153

lat* Число

Широта

Примеры:

  • 36.75896072

Рекламные материалы данного филиала (items.see_also.ads)
Параметр Тип Описание
is_social Булев

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

warning Строка

Deprecated! Свойство не поддерживается и в ближайшее время будет удалено из ответа API. Текст предупреждения.

Примеры:

  • Курение вредит вашему здоровью

text Строка

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

Примеры:

  • Только у нас только сейчас только здесь

article Строка

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

Примеры:

  • <strong>Рекламная статья</strong><br/>Покупайте наших слонов.

text_warning Строка

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

Примеры:

  • Курение вредит вашему здоровью

article_warning Строка

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

Примеры:

  • Курение вредит вашему здоровью

link Структура

Рекламная ссылка

options Структура

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

Рекламная ссылка (items.see_also.ads.link)
Параметр Тип Описание
value* Строка

URL адрес.

Примеры:

  • http://krutaya-kompanya.ru/sale?ref=2gis

text Строка

Описание для ссылки.

Примеры:

  • Распродажа, узнай больше

Структура рекламных опций (items.see_also.ads.options)
Параметр Тип Описание
logo Структура

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

actions Массив структур

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

videos Массив структур

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

buy_here Массив структур

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

buy_here_owner Массив структур

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

cb Структура

Контекстный баннер

Логотип рекламодателя (items.see_also.ads.options.logo)
Параметр Тип Описание
img_url Строка

bg_color Строка

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

Примеры:

  • #D10000

bg_img_url Строка

text_color Строка

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

Примеры:

  • #D10000

Список действий по внешним рекламным ресурсам (items.see_also.ads.options.actions)
Параметр Тип Описание
img_url Строка

bg_color Строка

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

Примеры:

  • #D10000

bg_img_url Строка

text_color Строка

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

Примеры:

  • #D10000

Список рекламных видео материалов (items.see_also.ads.options.videos)
Параметр Тип Описание
resources_description_url* Строка

Рекламные материалы для доноров ЗМК ('Здесь можно купить') (items.see_also.ads.options.buy_here)
Параметр Тип Описание
owned_rubric_id* Строка

branch_id* Строка

org_id* Строка

hash* Строка

is_primary Булев

custom_title* Строка

title* Строка

logo Структура

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

actions Массив структур

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

videos Массив структур

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

ads_texts* Структура

Рекламные тексты

Логотип рекламодателя (items.see_also.ads.options.buy_here.logo)
Параметр Тип Описание
img_url Строка

bg_color Строка

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

Примеры:

  • #D10000

bg_img_url Строка

text_color Строка

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

Примеры:

  • #D10000

Список действий по внешним рекламным ресурсам (items.see_also.ads.options.buy_here.actions)
Параметр Тип Описание
img_url Строка

bg_color Строка

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

Примеры:

  • #D10000

bg_img_url Строка

text_color Строка

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

Примеры:

  • #D10000

Список рекламных видео материалов (items.see_also.ads.options.buy_here.videos)
Параметр Тип Описание
resources_description_url* Строка

Рекламные тексты (items.see_also.ads.options.buy_here.ads_texts)
Параметр Тип Описание
text* Строка

text_warning Строка

article Строка

article_warning Строка

Рекламные материалы для owner'а какой-то owned рубрики (items.see_also.ads.options.buy_here_owner)
Параметр Тип Описание
owned_rubric_id* Строка

control_title* Строка

Контекстный баннер (items.see_also.ads.options.cb)
Параметр Тип Описание
branch_id* Строка

rubric_id* Строка

org_id* Строка

hash* Строка

title* Строка

text Строка

text_warning Строка

position* Целое число

logo Структура

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

actions Массив структур

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

Логотип рекламодателя (items.see_also.ads.options.cb.logo)
Параметр Тип Описание
img_url Строка

bg_color Строка

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

Примеры:

  • #D10000

bg_img_url Строка

text_color Строка

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

Примеры:

  • #D10000

Список действий по внешним рекламным ресурсам (items.see_also.ads.options.cb.actions)
Параметр Тип Описание
img_url Строка

bg_color Строка

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

Примеры:

  • #D10000

bg_img_url Строка

text_color Строка

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

Примеры:

  • #D10000

Адрес, по которому располагается филиал организации (items.see_also.address)
Параметр Тип Описание
building_id Строка

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

Примеры:

  • 20498230958

postcode Строка

Почтовый индекс.

Минимальная длина: 4

Максимальная длина: 12

Примеры:

  • 630007

components Массив

Компоненты адреса.

reg_bc_url Строка

Deprecated! Свойство не поддерживается и в ближайшее время будет удалено из ответа API. URL для регистрации дополнительного бизнес-коннекшна.

Список признаков филиала (items.flags)
Параметр Тип Описание
photos Булев

Есть ли для филиала фотографии.

badges Массив структур

Массив бэйджиков

Массив бэйджиков (items.flags.badges)
Параметр Тип Описание
type* Строка

Тип бейджа

text Строка

Текст в бейдже

Динамические свойства филиала (items.context)
Параметр Тип Описание
distance Целое число

Расстояние до некой точки в метрах.

Примеры:

  • 3483

is_in_bound Булев

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

Примеры:

  • true

stop_factors Массив структур

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

servicing_group Строка

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

servicing_groups Массив

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

Набор блокирующих атрибутов, соответствующих запросу (items.context.stop_factors)
Параметр Тип Описание
name* Строка

Имя дополнительного атрибута.

Примеры:

  • Прачечная

tag Строка

Идентификатор фильтра по атрибуту. Может отсутствовать если по данному атрибуту нельзя фильтровать.

Примеры:

  • hotel_details_laundry

День недели (items.contact_groups.schedule.Mon|Tue|Wed|Thu|Fri|Sat|Sun)
Параметр Тип Описание
working_hours* Массив структур

Интервалы времени работы

Интервалы времени работы (items.contact_groups.schedule.Mon.working_hours)
Параметр Тип Описание
from* Строка

Значение в формате hh:mm

to* Строка

Значение в формате hh:mm

Примеры

  • Получить информацию о 2ГИС.

    Запрос:

    http://catalog.api.2gis.ru/2.0/catalog/branch/get?id=141265769366740&key=1234567890

    Ответ: