GET v1/getRegion?ID={ID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Region| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
ID регіону |
integer |
None. |
| clientID |
ID клієнта |
integer |
None. |
| name |
Назва |
string |
None. |
| radius |
Радіус |
integer |
None. |
| area |
Площа |
decimal number |
None. |
| areaHa |
Площа, га |
decimal number |
None. |
| x |
Координата x центру кругового регіону |
decimal number |
None. |
| y |
Координата y центру кругового регіону |
decimal number |
None. |
| leftTopX |
Координата x верхньої лівої вершини регіону довільної форми |
decimal number |
None. |
| leftTopY |
Координата y верхньої лівої вершини регіону довільної форми |
decimal number |
None. |
| rightBottomX |
Координата x нижнього правої вершини регіону довільної форми |
decimal number |
None. |
| rightBottomY |
Координата y нижнього правої вершини регіону довільної форми |
decimal number |
None. |
| baseRegionID | integer |
None. |
|
| type |
Тип регіону |
RegionType |
None. |
| countryID |
ID країни |
integer |
None. |
| countryName |
Назва країни |
string |
None. |
| regionID |
ID області |
integer |
None. |
| regionName |
Назва області |
string |
None. |
| districtID |
ID району області |
integer |
None. |
| districtName |
Назва району області |
string |
None. |
| verticles |
Координати регіону |
Collection of RegionVerticle |
None. |
| cadastralNumber |
Кадастровий номер |
string |
None. |
| contractNumber |
Договір |
string |
None. |
| contractWithName |
З ким укладено договір |
string |
None. |
| contractDateFrom |
Дата початку договору |
date |
None. |
| contractDateTo |
Дата закінчення договору |
date |
None. |
| isOtherTenants |
Ознака субаренди |
boolean |
None. |
| comment |
Коментар |
string |
None. |
| color |
Колір регіону у форматі HEX |
string |
None. |
Response Formats
application/json, text/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 9",
"regionID": 1,
"regionName": "sample string 10",
"districtID": 1,
"districtName": "sample string 11",
"verticles": [
{
"id": 1,
"regionID": 2,
"x": 3.1,
"y": 4.1
},
{
"id": 1,
"regionID": 2,
"x": 3.1,
"y": 4.1
}
],
"cadastralNumber": "sample string 21",
"contractNumber": "sample string 22",
"contractWithName": "sample string 23",
"contractDateFrom": "2026-06-10T07:12:36.3371135+03:00",
"contractDateTo": "2026-06-10T07:12:36.3371135+03:00",
"isOtherTenants": true,
"comment": "sample string 25",
"color": "sample string 26"
}