🇷🇺
Та САМАЯ Россия
  • «Та САМАЯ Россия»
  • Регионы
    • /api/regions/
      • Получить краткую информацию о всех регионах
      • Получить информацию о всех регионах
      • Получить информацию о регионе по id
      • Получить только границу региона по id
      • Получить показатели региона по id
  • Исторические линии
    • /api/historical-lines
      • Получить список исторических линий
      • Получить историческую линию по id
      • Получить информацию о городе/объекте в исторической линии
  • Авторизация
    • /api/auth
      • Справка по авторизации
      • Войти в аккаунт администратора
      • Изменить пароль администратора
      • Изменить имя пользователя администратора
      • Выйти из аккаунта администратора
      • Обновить access- и refresh-токены
  • Администрирование
    • /api/admin/regions
      • Поиск новых регионов для добавления
      • Добавить новый регион
      • Изменить информацию о регионе и его показатели
        • Изменить герб региона (изображение)
        • Удалить герб региона (изображение)
      • Удалить регион
    • /api/admin/historical-lines
      • Добавить историческую линию
      • Изменить информацию об исторической линии
        • Изменить изображение маркера исторической линии
      • Удалить историческую линию
    • /api/admin/historical-lines/{line_id}/objects
      • Получить список объектов в исторической линии
      • Добавить объект в историческую линию
      • Изменить объект в исторической линии
        • Изменить изображение объекта
        • Удалить изображение объекта
      • Удалить объект в исторической линии
  • Переиспользуемые объекты
    • BaseStatusResponse
Powered by GitBook
On this page
  • GET /api/regions?line_id={guid}
  • Response
  1. Регионы
  2. /api/regions/

Получить информацию о всех регионах

GET /api/regions?line_id={guid}

Описание: возвращает все добавленные регионы

Query-параметры:

Параметр

Тип данных

Обяз.

Описание

line_id

guid

❓

Идентификатор исторической линии, в соответствии с которой будет заполняться свойство isActive в ответе. Если не указано, то isActive всегда = false.

Route-параметры: нет

Body запроса: нет


Response

JS:

{
  regions: [
    {
      id: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      title: "Свердловская область",
      displayTitle: {
        text: "Свердловская область",
        position: [59.250126, 60.475645],
        fontSize: 16
      },
      color: "#2E7D32",
      isActive: false,
      showIndicators: true,
      indicators: {
        coatOfArms: "http://localhost:8080/images/regions/image.png",
        excursions: 7
        partners: 9 
        participants: 9000
      }
      border: [
        [59.250126, 60.475645],
        [59.2493, 60.475048],
        [59.247203,60.4742]
      ]
    },
    {
      id: "4506601d-9109-4a6e-9cbf-a7c3b177c815",
      title: "Ямало-Ненецкий автономный округ",
      displayTitle: {
        text: "ЯНАО",
        position: [59.250126, 60.475645],
        fontSize: 16
      },
      color: "#2E7D32",
      isActive: true,
      showIndicators: false,
      indicators: {
        coatOfArms: "http://localhost:8080/images/regions/image.png",
        excursions: 7
        partners: 9 
        participants: 9000
      }
      border: [
        [59.250126, 60.475645],
        [59.2493, 60.475048],
        [59.247203,60.4742]
      ]
    },
  ]
}

Параметры:

Параметр

Тип данных

Обяз.

Описание

Значения

id

guid

✔️

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

0cad160e-c75b-4d8c-bda3-626778173b86

title

string

✔️

Название региона

"Ямало-Ненецкий автономный округ"

displayTitle

displayTitle*

❓

Информация об отображении названия региона на карте

{}

color

string

✔️

Цвет заливки региона

"#2E7D32"

isActive

bool

✔️

Активен ли регион

true/false

showIndicators

bool

✔️

Отображать ли показатели региона

true/false

indicators

indicator**

✔️

Объект с показателями региона

{}

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

PreviousПолучить краткую информацию о всех регионахNextПолучить информацию о регионе по id

Last updated 1 month ago