🇷🇺
Та САМАЯ Россия
  • «Та САМАЯ Россия»
  • Регионы
    • /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/historical-lines/{line_id:guid}
  • Response
  1. Исторические линии
  2. /api/historical-lines

Получить историческую линию по id

GET /api/historical-lines/{line_id:guid}

Описание: возвращает информацию об исторической линии по указанному уникальному идентификатору

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

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

Параметр

Тип данных

Обяз.

Описание

Значения

line_id

guid

✔️

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

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

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


Response

JS:

{
  id: "0cad160e-c75b-4d8c-bda3-626778173b86",
  title: "Города герои",
  markerImage: "http://localhost:8080/images/markers/image.png",
  lineColor: "#2E7D32",
  lineStyle: "dashed",
  markerLegend: "Города, из которых прошли экскурсии",
  isActive: true,
  markers: [
    {
      id: "2f168d90-fa85-4e44-92be-3fbbaadb18f8",
      title: "Мегион",
      coords: [59.250126, 60.475645],
      order: 0
    },
    {
      id: "9a74e9db-ddfd-42d2-bc85-6b9c2da2190f",
      title: "Сургут",
      coords: [59.247203, 60.4742],
      order: 1
    }
  ],
  addedRegions: [
    {
      id: "91f7d1b7-6090-42a2-adf2-84577956ddf7",
      title: "Свердловская область",
      displayTitle: {
        text: "Свердловская область",
        position: [59.250126, 60.475645],
        fontSize: 20
      },
      color: "#2E7D32"
    },
    {
      id: "5a6a55d0-e0e7-41c7-b0da-9077f9eef7d1",
      title: "Московская область",
      displayTitle: null,
      color: "#2E7D32"
    }
  ]
}

Параметры:

Параметр

Тип данных

Обяз.

Описание

Значения

id

guid

✔️

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

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

title

string

✔️

Название исторической линии

"Города герои"

markerImage

string

✔️

Ссылка на изображение, отображаемое на маркерах (городах)

"http://localhost:8080/images/markers/image.png"

lineColor

string

✔️

Цвет линии на карте

"#2E7D32"

lineStyle

string

✔️

Стиль линии на карте

"solid"/"dashed"/ "dotted"

markerLegend

string

✔️

Текст для легенды маркера

"Города, из которых прошли экскурсии"

isActive

bool

✔️

Включена ли линия для отображения на главной странице

true/false

markers

array of markerInfo*

✔️

Список отображаемых точек исторической линии

[{}]

addedRegions

array of briefRegionInfo**

✔️

Список дополнительно добавленных в линию регионов

[{}]

Объект markerInfo*:

Параметр

Тип данных

Обяз.

Описание

Значения

id

guid

✔️

Уникальный идентификатор отображаемого объекта (города)

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

title

string

✔️

Название объекта

"Сургут"

coords

point****

✔️

Координаты маркера для отображения

"Города герои"

order

int

✔️

Порядковый номер маркера в исторической линии

"http://localhost:8080/images/markers/image.png"

point**** - условный объект географической точки, представляющий из себя массив из двух чисел с плавающей точкой, которые обозначают широту и долготу.

Объект briefRegionInfo**:

Параметр

Тип данных

Обяз.

Описание

Значения

id

guid

✔️

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

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

title

string

✔️

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

"Сургут"

displayTitle

displayTitle***

❓

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

{}

color

string

✔️

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

"#2E7D32"

Объект displayTitle***:

Параметр

Тип данных

Обяз.

Описание

Значения

text

string

✔️

Отображаемое название региона

"ЯНАО"

position

point**

✔️

Местоположение отображаемого названия

[59.250126, 60.475645]

fontSize

string

✔️

Размер шрифта для отображения названия

20

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

Last updated 9 days ago