Поиск категорий по ключевым словам

• Категории
  • getПоиск категорий

API docs by Redocly

Справочник категорий (2.0)

2GIS API Support: api@2gis.ru URL: https://docs.2gis.com/

Категории

Поиск категорий

Осуществляет поиск категорий по ключевым словам.

query Parameters

key required	string Уникальный ключ пользователя API.
region_id required	string Идентификатор региона.
q required	string [ 1 .. 400 ] characters Произвольная поисковая строка.
page	integer Default: 1 Номер запрашиваемой страницы.
page_size	integer [ 1 .. 50 ] Default: 20 Количество результатов поиска, выводимых на одной странице.
fields	Array of strings Дополнительные поля, которые необходимо отобразить в ответе, перечисляются через запятую. Список доступных полей: items.region_id — уникальный идентификатор проекта; items.is_reviewable_on_flamp — разрешены ли отзывы к организациям этой категории непосредственно на flamp.ru; items.rubrics — массив дочерних категорий; items.rubrics.region_id — идентификатор региона; items.rubrics.is_reviewable_on_flamp — разрешены ли отзывы к организациям этой категории непосредственно на flamp.ru.

Responses

Response Schema:

application/jsontext/xmlapplication/json

required	object Основной результат
required	object (ObjMeta) Метаданные ответа

https://catalog.api.2gis.com/2.0/catalog/rubric/search

Response samples

• 200
• 400
• 403
• 404
• 408
• 500

Content type

application/jsontext/xmlapplication/json

{

• "result": {

  • "items": [

    • {

      • "id": "4503719886454906",
      • "type": "rubric",
      • "region_id": "1",
      • "icon_url": "string",
      • "branch_count": "25",
      • "seo_name": "Аварийные (аварийно-диспетчерские) службы",
      • "parent_id": "4503719886460203",
      • "tag": "string",
      • "keyword": "Молочный шоколад",
      • "name": "Аварийные службы",
      • "org_count": "10",
      • "search_attributes": {

        • "additional_context": [

          • 0

          ],
        • "suggested_text": "string",
        • "dgis_address_details": {

          • "address": "12",
          • "entrance": "1",
          • "apartment": "15",
          • "precision": "string"

          },
        • "external_source": 1,
        • "suggest_parts": [

          • {

            • "is_suggested": true,
            • "text": "string"

            }

          ]

        },
      • "caption": "string",
      • "alias": "avarijjnye_sluzhby",
      • "title": "string",
      • "geo_count": "2"

      }

    ],
  • "total": 1

  },
• "meta": {

  • "issue_date": "string",
  • "code": 200,
  • "api_version": "dev"

  }

}