Получение информации о входе метро

Осуществляет получение информации о входе на станцию по ее идентификатору.

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

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

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

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

Пример: 1234567890.

id Да Строка

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

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.full_address_name

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

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

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

result* Структура

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

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

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

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

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

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

Массив найденных входов

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

Уникальный идентификатор входа

region_id Строка

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

station_id* Строка

Уникальный идентификатор станции, к которой относится вход.

type* Строка

Тип объекта

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

  • station_entrance — вход на станцию.

type_name Строка

subtype* Строка

Тип станции

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

  • railway — Железнодорожный вокзал
  • metro — Cтанция метро
  • river_transport — Речной порт

name* Строка

Название станции.

full_name* Строка

Полное название станции.

comment Строка

Комментарий ко входу

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

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

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

Адрес дома, в котором расположен вход

address_name Строка

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

full_address_name Строка

Тоже что и address_name, но с указанием города.

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

Примеры:

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

is_routing_available Булев

Если true, то проезд до объекта возможен, если false или отсутствует, то нет

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

Время работы входа

geometry Структура

Геометрия входа

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

Остановочные платформы остановки

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

Маршруты транспорта, проходящие через остановочный пункт

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

Связанные объекты

reviews Структура

Отзывы о геообъекте

Принадлежность к административной территории (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.schedule)
Параметр Тип Описание
Mon Структура

Понедельник

Tue Структура

Вторник

Wed Структура

Среда

Thu Структура

Четверг

Fri Структура

Пятница

Sat Структура

Суббота

Sun Структура

Воскресенье

is_24x7 Булев

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

comment Строка

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

Примеры:

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

Геометрия входа (items.geometry)
Параметр Тип Описание
centroid Строка

Визуальный центр геометрии объекта.

Примеры:

  • POINT(83.306820839303 54.6230101954005)

hover Строка

Геометрия области, используемой для определения попадания курсора в зону объекта.

Примеры:

  • POLYGON((36.193851601974 51.7466070840044,36.1943391434488 51.7466070840044,36.1943391434488 51.7474670961949,36.193851601974 51.7474670961949,36.193851601974 51.7466070840044))

selection Строка

Геометрия для выделения объекта.

Примеры:

  • POINT(83.306820839303 54.6230101954005)

style Строка | Null

Идентификатор стиля для отображения.

Остановочные платформы остановки (items.platforms)
Параметр Тип Описание
id* Строка

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

geometry Структура

Геометрия остановочной платформы

Геометрия остановочной платформы (items.platforms.geometry)
Параметр Тип Описание
centroid Строка

Визуальный центр геометрии объекта.

Примеры:

  • POINT(83.306820839303 54.6230101954005)

hover Строка

Геометрия области, используемой для определения попадания курсора в зону объекта.

Примеры:

  • POLYGON((36.193851601974 51.7466070840044,36.1943391434488 51.7466070840044,36.1943391434488 51.7474670961949,36.193851601974 51.7474670961949,36.193851601974 51.7466070840044))

selection Строка

Геометрия для выделения объекта.

Примеры:

  • POINT(83.306820839303 54.6230101954005)

style Строка | Null

Идентификатор стиля для отображения.

Маршруты транспорта, проходящие через остановочный пункт (items.routes)
Параметр Тип Описание
id Строка

Идентификатор маршрута

subtype* Строка

Тип маршрута.

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

  • bus — автобус
  • trolleybus — троллейбус
  • tram — трамвай
  • shuttle_bus — маршрутное такси
  • metro — метро
  • suburban_train — электропоезд
  • funicular_railway — фуникулёр
  • monorail — монорельс
  • river_transport — водный транспорт
  • cable_car — канатная дорога
  • light_rail — скоростной трамвай
  • premetro — метротрам
  • light_metro — лёгкое метро
  • aeroexpress — аэроэкспресс

name* Строка

Имя маршрута.

Примеры:

  • Ключ-Камышенское плато

color Строка

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

Примеры:

  • #D10000

direction_type Строка

Тип направления маршрута

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

  • bidirectional — ходит от начальной до конечной остановки и обратно
  • one_way — ходит только в одну сторону
  • circular — круговой маршрут с конечной остановкой
  • loop — круговой маршрут без конечных остановок

from_name Строка

Начальная остановка маршрута.

Примеры:

  • Ключ-Камышенское плато

to_name Строка

Конечная остановка маршрута

Примеры:

  • Тюленина

comment Строка

Комментарий

Примеры:

  • Дзержинская линия

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

Направления маршрута

Направления маршрута (items.routes.directions)
Параметр Тип Описание
id Строка

Уникальный 64-ех битный идентификатор направления маршрута (subroute).

type* Строка

Направление маршрута

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

  • forward — прямое направление
  • backward — обратное направление
  • additional — дополнительное направление
  • circular — круговой маршрут с конечной остановкой
  • loop — замкнутый маршрут без конечной остановки

name Строка

Название направления маршрута.

Примеры:

  • Маршрут
  • Обратный маршрут
  • До ТК Толмачёвский

geometry Структура

Геометрия направления маршрута

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

Последовательность остановочных платформ маршрута

Геометрия направления маршрута (items.routes.directions.geometry)
Параметр Тип Описание
centroid Строка

Визуальный центр геометрии объекта.

Примеры:

  • POINT(83.306820839303 54.6230101954005)

hover Строка

Геометрия области, используемой для определения попадания курсора в зону объекта.

Примеры:

  • POLYGON((36.193851601974 51.7466070840044,36.1943391434488 51.7466070840044,36.1943391434488 51.7474670961949,36.193851601974 51.7474670961949,36.193851601974 51.7466070840044))

selection Строка

Геометрия для выделения объекта.

Примеры:

  • POINT(83.306820839303 54.6230101954005)

style Строка | Null

Идентификатор стиля для отображения.

Последовательность остановочных платформ маршрута (items.routes.directions.platforms)
Параметр Тип Описание
id* Строка

Идентификатор остановочной платформы.

station_id* Строка

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

name* Строка

Название остановки.

Примеры:

  • Кинотеатр Маяковского

place_name Строка

Краткое описание места расположения остановочной платформы.

Примеры:

  • Кинотеатр Маяковского

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

Другие маршруты, на которые можно пересесть на данной остановочной платформе

geometry Структура

Геометрия остановочной платформы

Другие маршруты, на которые можно пересесть на данной остановочной платформе (items.routes.directions.platforms.transitions)
Параметр Тип Описание
route_id* Строка

Идентификатор связанного маршрута.

route_name* Строка

Название связанного маршрута.

route_type* Строка

Тип маршрута.

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

  • bus — автобус
  • trolleybus — троллейбус
  • tram — трамвай
  • shuttle_bus — маршрутное такси
  • metro — метро
  • suburban_train — электропоезд
  • funicular_railway — фуникулёр
  • monorail — монорельс
  • river_transport — водный транспорт
  • cable_car — канатная дорога
  • light_rail — скоростной трамвай
  • premetro — метротрам
  • light_metro — лёгкое метро
  • aeroexpress — аэроэкспресс

color Строка

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

Примеры:

  • #D10000

station_id* Строка

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

station_name* Строка

Название остановки.

Геометрия остановочной платформы (items.routes.directions.platforms.geometry)
Параметр Тип Описание
centroid Строка

Визуальный центр геометрии объекта.

Примеры:

  • POINT(83.306820839303 54.6230101954005)

hover Строка

Геометрия области, используемой для определения попадания курсора в зону объекта.

Примеры:

  • POLYGON((36.193851601974 51.7466070840044,36.1943391434488 51.7466070840044,36.1943391434488 51.7474670961949,36.193851601974 51.7474670961949,36.193851601974 51.7466070840044))

selection Строка

Геометрия для выделения объекта.

Примеры:

  • POINT(83.306820839303 54.6230101954005)

style Строка | Null

Идентификатор стиля для отображения.

Связанные объекты (items.links)
Параметр Тип Описание
entrances Массив структур

Точки входа

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

Ближайшие остановки

Точки входа (items.links.entrances)
Параметр Тип Описание
id Строка

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

name Строка

Описание входа

comment Строка

Комментарий ко входу

is_primary Булев

Является ли вход основным.

geometry Структура

Геометрия входа

Геометрия входа (items.links.entrances.geometry)
Параметр Тип Описание
points* Массив

Точки

vectors Массив

Векторы

Ближайшие остановки (items.links.nearest_stations)
Параметр Тип Описание
id* Строка

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

name* Строка

Название остановки

Примеры:

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

comment Строка

Дополнительный комментарий к названию остановки, например, название линии (или линий) метро, к которым относится станция.

Примеры:

  • Вторая линия
  • Ленинская линия

color Строка

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

Примеры:

  • #D10000

route_types* Массив

Массив типов транспорта, проходящего через эту остановку.

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

Расстояние от описываемого объекта до ближайшей остановочной платформы данной остановки, в метрах.

entrance Структура

Вход

internal_transition Булев

Существует ли внутренний переход на эту станцию из описываемого объекта

Вход (items.links.nearest_stations.entrance)
Параметр Тип Описание
id Строка

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

name* Строка

Название входа: данные из комментария или имя.

geometry* Структура

Геометрия входа

Геометрия входа (items.links.nearest_stations.entrance.geometry)
Параметр Тип Описание
centroid Строка

Визуальный центр геометрии объекта.

Примеры:

  • POINT(83.306820839303 54.6230101954005)

hover Строка

Геометрия области, используемой для определения попадания курсора в зону объекта.

Примеры:

  • POLYGON((36.193851601974 51.7466070840044,36.1943391434488 51.7466070840044,36.1943391434488 51.7474670961949,36.193851601974 51.7474670961949,36.193851601974 51.7466070840044))

selection Строка

Геометрия для выделения объекта.

Примеры:

  • POINT(83.306820839303 54.6230101954005)

style Строка | Null

Идентификатор стиля для отображения.

Отзывы о геообъекте (items.reviews)
Параметр Тип Описание
general_rating Число

Общий рейтинг объекта.

Примеры:

  • 4.73

general_review_count Целое число

Общее количество отзывов.

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

Список провайдеров

Список провайдеров (items.reviews.items)
Параметр Тип Описание
tag* Строка

Название провайдера.

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

  • flamp
  • foursquare
  • 2gis_reviews

is_reviewable* Булев

Можно ли отображать отзывы к этому объекту, а также создавать новые отзывы.

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

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

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

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

to* Строка

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

Примеры

  • Получить вход с идентификатором 141643726454789.

    Запрос:

    http://catalog.api.2gis.ru/2.0/transport/station_entrance/get?id=141643726454789&key=1234567890

    Ответ:

  • Получить остановку с идентификаторм 141643726454795.

    Запрос:

    http://catalog.api.2gis.ru/2.0/transport/station_entrance/get?id=141643726454795&key=1234567890

    Ответ: