GET v4/selRegions

Метод для отримання списку регіонів. вер.4

Параметри запиту

Формат запиту (URI parameters)

Відсутній.

Тіло запиту (body parameters)

Відсутнє.

Параметри відповіді

Опис

Назва	Опис	Tип
id	ID регіону	integer
clientID	ID клієнта	integer
name	Назва	string
radius	Радіус	integer
area	Площа	decimal number
areaHa	Площа, га	decimal number
x	Координата x центру кругового регіону	decimal number
y	Координата y центру кругового регіону	decimal number
leftTopX	Координата x верхньої лівої вершини регіону довільної форми	decimal number
leftTopY	Координата y верхньої лівої вершини регіону довільної форми	decimal number
rightBottomX	Координата x нижнього правої вершини регіону довільної форми	decimal number
rightBottomY	Координата y нижнього правої вершини регіону довільної форми	decimal number
baseRegionID		integer
type	Тип регіону	RegionType
countryID	ID країни	integer
countryName	Назва країни	string
regionID	ID області	integer
regionName	Назва області	string
districtID	ID району області	integer
districtName	Назва району області	string
verticles	Координати регіону	Collection of RegionVerticle
сadastralNumber	Кадастровий номер	string
contractNumber	Договір	string
contractWithName	З ким укладено договір	string
сontractDateFrom	Дата початку договору	date
сontractDateTo	Дата закінчення договору	date
isOtherTenants	Ознака субаренди	boolean
comment	Коментар	string
color	Колір регіону у форматі HEX	string

Формат відповіді

application/json

Приклад:

[
  {
    "id": 1,
    "clientID": 2,
    "name": "sample string 3",
    "radius": 4,
    "area": 5.1,
    "areaHa": 0.0,
    "x": 6.1,
    "y": 7.1,
    "leftTopX": 1.1,
    "leftTopY": 1.1,
    "rightBottomX": 1.1,
    "rightBottomY": 1.1,
    "baseRegionID": 8,
    "type": 1,
    "countryID": 1,
    "countryName": "sample string 10",
    "regionID": 1,
    "regionName": "sample string 11",
    "districtID": 1,
    "districtName": "sample string 12",
    "verticles": [
      {
        "id": 1,
        "regionID": 2,
        "x": 3.1,
        "y": 4.1
      },
      {
        "id": 1,
        "regionID": 2,
        "x": 3.1,
        "y": 4.1
      }
    ],
    "сadastralNumber": "sample string 22",
    "contractNumber": "sample string 23",
    "contractWithName": "sample string 24",
    "сontractDateFrom": "2024-11-21T08:23:37.6572619+02:00",
    "сontractDateTo": "2024-11-21T08:23:37.6572619+02:00",
    "isOtherTenants": true,
    "comment": "sample string 26",
    "color": "sample string 27"
  },
  {
    "id": 1,
    "clientID": 2,
    "name": "sample string 3",
    "radius": 4,
    "area": 5.1,
    "areaHa": 0.0,
    "x": 6.1,
    "y": 7.1,
    "leftTopX": 1.1,
    "leftTopY": 1.1,
    "rightBottomX": 1.1,
    "rightBottomY": 1.1,
    "baseRegionID": 8,
    "type": 1,
    "countryID": 1,
    "countryName": "sample string 10",
    "regionID": 1,
    "regionName": "sample string 11",
    "districtID": 1,
    "districtName": "sample string 12",
    "verticles": [
      {
        "id": 1,
        "regionID": 2,
        "x": 3.1,
        "y": 4.1
      },
      {
        "id": 1,
        "regionID": 2,
        "x": 3.1,
        "y": 4.1
      }
    ],
    "сadastralNumber": "sample string 22",
    "contractNumber": "sample string 23",
    "contractWithName": "sample string 24",
    "сontractDateFrom": "2024-11-21T08:23:37.6572619+02:00",
    "сontractDateTo": "2024-11-21T08:23:37.6572619+02:00",
    "isOtherTenants": true,
    "comment": "sample string 26",
    "color": "sample string 27"
  }
]