Получение списка регионов
Получает список регионов. Регионы представляют собой иерархическую структуру географических областей (страны, регионы, города), где каждый регион имеет уникальный идентификатор, название и идентификатор родительского региона.
Request
GET
https://api.kit.yandex.net/v1/geo/regions
Responses
200 OK
Список регионов.
Body
application/json
{
"regions": [
{
"id": 225,
"name": "Москва",
"parent_id": 1
}
]
}
|
Name |
Description |
|
regions |
Type: RegionNode[] Example |
RegionNode
|
Name |
Description |
|
id |
Type: integer Уникальный идентификатор региона. |
|
name |
Type: string Название региона. Example: |
|
parent_id |
Type: integer Уникальный идентификатор родительского региона. Значение 0 означает, что регион является корневым. |
Example
{
"id": 225,
"name": "Москва",
"parent_id": 1
}
400 Bad Request
Некорректный запрос.
Body
application/json
{
"code": "VALIDATION_ERROR",
"message": "Invalid input",
"trace_id": "00000000000000000000000000000000"
}
|
Name |
Description |
|
code |
Type: string Example: |
|
message |
Type: string Example: |
|
trace_id |
Type: string Уникальный идентификатор запроса для отладки. Example: |
401 Unauthorized
Не авторизован.
Body
application/json
{
"code": "VALIDATION_ERROR",
"message": "Invalid input",
"trace_id": "00000000000000000000000000000000"
}
|
Name |
Description |
|
code |
Type: string Example: |
|
message |
Type: string Example: |
|
trace_id |
Type: string Уникальный идентификатор запроса для отладки. Example: |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
application/json
{
"code": "VALIDATION_ERROR",
"message": "Invalid input",
"trace_id": "00000000000000000000000000000000"
}
|
Name |
Description |
|
code |
Type: string Example: |
|
message |
Type: string Example: |
|
trace_id |
Type: string Уникальный идентификатор запроса для отладки. Example: |