Получить информацию о регионе по id
GET /api/regions/{region_id:guid}?line_id={guid}
Описание: возвращает информацию о регионе по указанному id.
Query-параметры:
Параметр
Тип данных
Обяз.
Описание
line_id
guid
❓
Идентификатор исторической линии, в соответствии с которой будет заполняться свойство isActive в ответе. Если не указано, то isActive всегда = false
Route-параметры:
Параметр
Тип данных
Обяз.
Описание
region_id
guid
✔️
Идентификатор региона, информация о котором будем возвращена
Body запроса: нет
Response
JS:
Параметры:
Параметр
Тип данных
Обяз.
Описание
Значения
id
guid
✔️
Уникальный идентификатор региона
0cad160e-c75b-4d8c-bda3-626778173b86
title
string
✔️
Название региона
"Ямало-Ненецкий автономный округ"
displayTitle
displayTitle*
❓
Информация об отображении названия региона на карте
{}
color
string
✔️
Цвет заливки региона
"#2E7D32"
isActive
bool
✔️
Активен ли регион
true/false
showIndicators
bool
✔️
Отображать ли показатели региона
true/false
indicators
indicators**
✔️
Объект с показателями региона
{}
border
array of points***
✔️
Координаты точек границы региона
[[59.250126, 60.475645]]
point*** - условный объект географической точки, представляющий из себя массив из двух чисел с плавающей точкой, которые обозначают широту и долготу.
Объект displayTitle*:
Параметр
Тип данных
Обяз.
Описание
Значения
text
string
✔️
Отображаемое название региона
"ЯНАО"
position
point**
✔️
Местоположение отображаемого названия
[59.250126, 60.475645]
fontSize
string
✔️
Размер шрифта для отображения названия
20
Объект indicators**:
Параметр
Тип данных
Обяз.
Описание
Значения
coatOfArms
string
✔️
Ссылка на герб региона (изображение)
"http://localhost:8080/images/regions/image.png"
excursions
int
✔️
Кол-во экскурсий в регионе
7
partners
int
✔️
Кол-во партнеров в регионе
9
participants
int
✔️
Кол-во участников в регионе
9000
Last updated