2GIS

Проекты

Проект — это агломерация, включающая крупный город и ближайшие населённые пункты. Теперь можно реализовать выбор города, как это сделано в Онлайн-версии 2ГИС, являющейся партнёром API.

URL: http://catalog.api.2gis.ru/project/list

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

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

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

Пример: 1234567890.

version Да Строка Указывает версию API, с которой идет работа. Возможные значения: 1.3.
output Нет Строка Формат ответа. Может принимать значения xml, json, jsonp. По умолчанию используется json.
callback Нет Строка

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

Пример: myCallback_1

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

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

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

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

Параметры проекта
Параметр Тип Описание
id Число Идентификатор проекта. Пример: 32
name Строка Название проекта. Пример: Москва
code Строка Буквенный идентификатор проекта. Пример: n_novgorod
alias Строка Псевдоним проекта. Пример: nnovgorod
language Строка Язык проекта. Возможные значения: ru
grammatical_cases Объект

Склонение названия проекта. Объект с ключами genitive — в родительном падеже и prepositional — в предложном падеже.

country_code Строка Код страны в формате ISO 3166. Пример: kz
timezone Строка

Часовой пояс в формат Time Zone Database.

Примеры:

  • Asia/Novosibirsk
  • Europe/Moscow
  • Indian/Chagos
actual_extent Строка Геометрия проекта в формате WKT. Пример: POLYGON((82.5066233234198 55.249037769223,83.3965344871157 55.249037769223,83.3965344871157 54.5530320570113,82.5066233234198 54.5530320570113,82.5066233234198 55.249037769223)).
centroid Строка Исторический центр главного города, рекомендуется для центрирования проекта. Точка в формате WKT. Пример: POINT(83.062249469999145 54.956108471916146).
min_zoomlevel Число Минимальный уровень масштаба, для которого есть тайлы проекта. Пример: 9.
max_zoomlevel Число Максимальный уровень масштаба, для которого есть тайлы проекта. Пример: 17.
zoomlevel Число Уровень масштаба, рекомендуемый для дефолтного отображения всего проекта. Пример: 11.
transport Булев Наличие данных по общественному транспорту: true — данные есть, false — данных нет.
traffic Булев Наличие данных по пробкам: true — данные есть, false — данных нет.
flamp Булев Присутствие проекта на flamp.ru: true — присутствует, false — не присутствует.
firmscount Число Количество фирм в проекте. Пример: 42839.
filialscount Число Количество филиалов в проекте. Пример: 60975.
rubricscount Число Количество рубрик в проекте. Пример: 953.
geoscount Число Количество геообъектов в проекте. Пример: 143452.
transport_routes_count Число Количество маршрутов общественного транспорта в проекте. Пример: 100501.

Примеры

Получить список проектов

Запрос: http://catalog.api.2gis.ru/project/list?version=1.3&key=1234567890

Ответ: