Добавить новый регион

POST /api/admin/regions

Описание: выполняется поиск региона с указанным идентификатором на OpenStreetMap API, затем добавление информации о найденном регионе в базу данных

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

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

Body запроса:

JS:

{
  region_id: 72196,
  line_id: "91f7d1b7-6090-42a2-adf2-84577956ddf7"
}

Параметры:

Параметр

Тип данных

Обяз.

Описание

Значения

region_id

int

✔️

Уникальный идентификатор региона в базе данных OpenStreetMap

72196

line_id

Guid

Уникальный идентификатор истор. линии, в которую будет добавлен регион. Если не указано, то регион добавится как стандартный и будет отображаться с каждой истор. линией

"91f7d1b7-6090-42a2-adf2-84577956ddf7"


Response

JS:

{
  id: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  title: "Свердловская область",
  displayTitle: {
    text: "Свердловская область",
    position: [59.250126, 60.475645],
    fontSize: 16
  },
  color: "#2E7D32",
  isActive: true,
  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

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

Ссылка на герб региона (изображение)

null

excursions

int

✔️

Кол-во экскурсий в регионе

0

partners

int

✔️

Кол-во партнеров в регионе

0

participants

int

✔️

Кол-во участников в регионе

0

Last updated