Получение региона по id
Справочник регионов (2.0)
2GIS API Support: api@2gis.ru URL: https://docs.2gis.com/
Получение информации о регионе
Выводит подробную информацию о регионе по его уникальному идентификатору.
query Parameters
key required | string Уникальный ключ пользователя API. |
id required | string Идентификатор региона. Конфликтует с параметром |
branch_id required | string Идентификатор филиала. Конфликтует с параметром |
fields | Array of strings Дополнительные поля, которые необходимо отобразить в ответе, перечисляются через запятую.
|
Responses
Response Schema: application/jsonapplication/jsontext/xml
application/json
application/json
text/xml
required | object (ObjMeta) Метаданные ответа |
required | object Основной результат |
Response Schema: application/json
object (ObjMetaBadRequest) Метаданные ответа |
Response Schema: application/json
object (ObjMetaForbidden) Метаданные ответа |
Response Schema: application/json
object (ObjMetaNotFound) Метаданные ответа |
Response Schema: application/json
object (ObjMetaServerError) Метаданные ответа |
https://catalog.api.2gis.com/2.0/region/get
Response samples
- 200
- 400
- 403
- 404
- 500
Content type
application/json
application/json
text/xml
{- "meta": {
- "code": 200,
- "api_version": "dev",
- "issue_date": "string"
}, - "result": {
- "total": 1,
- "items": [
- {
- "id": "123456",
- "type": "region",
- "flags": {
- "2gis_reviews": true,
- "pedestrian_routing": true,
- "flamp": true,
- "gdpr": true,
- "truck_graph": true,
- "public_transport": true,
- "has_net_booklet": true,
- "metro": true,
- "road_network": true,
- "parking_layer": true,
- "traffic": true
}, - "code": "nnovgorod",
- "name": "Москва",
- "online_languages": {
- "default_lang": "string",
- "available": "string"
}, - "tips_languages": "{\"ru\": \"ru\"}",
- "bounds": "POLYGON((83.4457915421126 53.4866943332863,84.0879338133862 53.4866943332863,84.0879338133862 53.1585977185895,83.4457915421126 53.1585977185895,83.4457915421126 53.4866943332863)",
- "default_pos": {
- "lon": "43.2988455",
- "lat": "56.7724145",
- "zoom": "11"
}, - "locales": "ru_RU",
- "statistics": {
- "branch_count": 0,
- "route_count": 0,
- "rubric_count": 0,
- "org_count": 0
}, - "time_zone": {
- "name": "Asia/Novosibirsk",
- "offset": 240
}, - "satellites": [
- {
- "id": "123456",
- "geometry": "POLYGON((83.4457915421126 53.4866943332863,84.0879338133862 53.4866943332863,84.0879338133862 53.1585977185895,83.4457915421126 53.1585977185895,83.4457915421126 53.4866943332863)",
- "centroid": "POINT(83.4457915421126 53.4866943332863)",
- "name": "Москва"
}
], - "locale": "ru_RU",
- "uri_aliases": [
- "string"
], - "name_grammatical_cases": {
- "accusative": "Новосибирск",
- "dative": "Новосибирску",
- "genitive": "Новосибирска",
- "prepositional": "Новосибирске"
}, - "settlements": [
- "string"
], - "seo": {
- "title": "string",
- "description": "string"
}, - "domain": "ru",
- "uri_code": "nnovgorod",
- "country_code": "st",
- "zoom_level": {
- "min": 22,
- "max": 22
}
}
]
}
}