2GIS

Рубрики

Осуществляет выбор рубрик, для которых указанная рубрика является родительской. Функция дополняет поисковую строку. Использование рекомендовано только для проектов, уже использующих рубрикатор, как элемент навигации. Получение фирм в рубрике осуществлется методом «Поиск фирм в рубрике».

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

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

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

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

Пример: 1234567890.

version Да Строка Указывает версию API, с которой идет работа. Возможные значения: 1.3
where Да. Не менее 2-х символов Строка

Название города. Кодировка UTF8. Примеры:

  • Москва
  • Раменское
  • Новосибирск
id Нет Число Идентификатор рубрики. Для выбора конкретной рубрики нужно указать её id, в этом случае parent_id проигнорируется. По умолчанию параметр не используется.
parent_id Нет Число Идентификатор родительской рубрики. Для выбора корневых рубрик нужно либо не указать parent_id, либо оставить его пустым.
show_children Нет Число

Показывать ли дочерние рубрики. Возможные значения:

1 — показывать,

любое другое значение — не показывать.

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

sort Нет Строка

Тип сортировки ответа. Возможные значения:

name — по алфавиту,

popularity — по популярности.

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

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

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

Пример: myCallback_1

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

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

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

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

Параметры рубрики
Параметр Тип Описание
id Строка Идентификатор рубрики. Пример: 4503719886454906
name Строка Название рубрики. Пример: Аварийные службы
alias Строка Транслитерированое название рубрики. Пример: avarijjnye_sluzhby
parent_id Строка Идентификатор родительской рубрики, для которой был получен список. Пример: 4503719886460203
children Массив Список дочерних рубрик. Массив объектов с ключами id, name, alias.

Примеры

  • Выбрать все родительские рубрики для проекта, в который входит город Химки.

    Запрос: http://catalog.api.2gis.ru/rubricator?where=химки&version=1.3&key=1234567890

    Ответ:

  • Выбрать дочерние рубрики для рубрики 140857747439618 ("Досуг / Развлечения / Общественное питание") в Новосибирске.

    Запрос: http://catalog.api.2gis.ru/rubricator?parent_id=140857747439618&version=1.3&key=1234567890&where=новосибирск

    Ответ: