Список рубрик

Выводит список рубрик конкретного региона. Использование рекомендовано только для проектов, уже использующих рубрикатор как элемент навигации.

URL: http://catalog.api.2gis.ru/2.0/catalog/rubric/list

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

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

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

Пример: 1234567890.

region_id Да Строка

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

Пример: 1

parent_id Нет Строка

Идентификатор родительской рубрики (по умолчанию используется 0).

Пример: 140857747439618

sort Нет Строка

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

  • name — по алфавиту,
  • popularity — по убыванию популярности.

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

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.

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

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

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

result* Структура

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

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

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

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

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

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

Объединяющая рубрика

Рубрика

Объединяющая рубрика (items)
Параметр Тип Описание
id* Строка

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

Примеры:

  • 4503719886454906

type* Строка

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

  • general_rubric

name* Строка

Название рубрики.

Примеры:

  • Аварийные службы

alias Строка

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

Примеры:

  • avarijjnye_sluzhby

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

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

Примеры:

  • 10

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

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

Примеры:

  • 25

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

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

Примеры:

  • 4503719886454906

type* Строка

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

  • rubric — рубрика
  • general_rubric — объединяющая рубрика

name* Строка

Название рубрики.

Примеры:

  • Аварийные службы

alias* Строка

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

Примеры:

  • avarijjnye_sluzhby

parent_id* Строка

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

Примеры:

  • 4503719886460203

is_reviewable_on_flamp Булев

Разрешены ли отзывы к организациям этой рубрики непосредственно на flamp.ru.

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

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

Примеры:

  • 10

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

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

Примеры:

  • 25

Примеры

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

    Запрос:

    http://catalog.api.2gis.ru/2.0/catalog/rubric/list?region_id=1&sort=name&key=1234567890

    Ответ:

  • Выбрать все дочерние рубрики для parent_id = 140857747445035 для региона, в который входит город Бердск.

    Запрос:

    http://catalog.api.2gis.ru/2.0/catalog/rubric/list?region_id=1&parent_id=140857747445035&key=1234567890

    Ответ: