Api session items zones: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 55: | Line 55: | ||
!Description | !Description | ||
|- | |- | ||
|SOCIAL | | SOCIAL | ||
| | | | ||
|- | |- | ||
|NORMAL | | NORMAL | ||
| | | | ||
|- | |- | ||
|LUXE | | LUXE | ||
| | | | ||
|- | |- | ||
|ROAD | | ROAD | ||
| | | | ||
|- | |- | ||
|PAVED_AREA | | PAVED_AREA | ||
| | | | ||
|- | |- | ||
|EDUCATION | | EDUCATION | ||
| | | | ||
|- | |- | ||
|HEALTHCARE | | HEALTHCARE | ||
| | | | ||
|- | |- | ||
|PARK | | PARK | ||
| | | | ||
|- | |- | ||
|NATURE | | NATURE | ||
| | | | ||
|- | |- | ||
|INDUSTRY | | INDUSTRY | ||
| | | | ||
|- | |- | ||
|OFFICES | | OFFICES | ||
| | | | ||
|- | |- | ||
|OTHER | | OTHER | ||
| | | | ||
|- | |- | ||
|SENIOR | | SENIOR | ||
| | | | ||
|- | |- | ||
|UNDERGROUND | | UNDERGROUND | ||
| | | | ||
|- | |- | ||
|SHOPPING | | SHOPPING | ||
| | | | ||
|- | |- | ||
|AGRICULTURE | | AGRICULTURE | ||
| | | | ||
|- | |- | ||
|LEISURE | | LEISURE | ||
| | | | ||
|- | |- | ||
|STUDENT | | STUDENT | ||
| | | | ||
|- | |- | ||
|GARDEN | | GARDEN | ||
| | | | ||
|- | |- | ||
|INTERSECTION | | INTERSECTION | ||
| | | | ||
|- | |- | ||
|BRIDGE | | BRIDGE | ||
| | | | ||
|} | |} | ||
| Line 127: | Line 127: | ||
!Description | !Description | ||
|- | |- | ||
|allowedCategories | | allowedCategories | ||
|Category<nowiki>[]</nowiki> | | Category<nowiki>[]</nowiki> | ||
| | | | ||
|- | |- | ||
|attributes | | attributes | ||
|Map<String,double[]> | | Map<String,double[]> | ||
| | | | ||
|- | |- | ||
|center | | center | ||
|Point | | Point | ||
| | | | ||
|- | |- | ||
|excelID | | excelID | ||
|int | | int | ||
|[[Excel Sheet]] ID | | [[Excel Sheet]] ID | ||
|- | |- | ||
|excelUpdated | | excelUpdated | ||
|boolean | | boolean | ||
| | | | ||
|- | |- | ||
|id | | id | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|maquetteOverride | | maquetteOverride | ||
|Map<String,double[]> | | Map<String,double[]> | ||
| | | | ||
|- | |- | ||
|name | | name | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|outline | | outline | ||
|Outline | | Outline | ||
| | | | ||
|- | |- | ||
|parentZoneID | | parentZoneID | ||
|int | | int | ||
|[[Zone]] ID | | [[Zone]] ID | ||
|- | |- | ||
|permitterID | | permitterID | ||
|int | | int | ||
|[[Stakeholder]] ID | | [[Stakeholder]] ID | ||
|- | |- | ||
|polygons | | polygons | ||
|MultiPolygon | | MultiPolygon | ||
| | | | ||
|- | |- | ||
|sourceIDs | | sourceIDs | ||
|int<nowiki>[]</nowiki> | | int<nowiki>[]</nowiki> | ||
|[[Source]]s ID | | [[Source]]s ID | ||
|- | |- | ||
|version | | version | ||
|int | | int | ||
| | | | ||
|} | |} | ||
| Line 201: | Line 201: | ||
!Description | !Description | ||
|- | |- | ||
|type | | type | ||
|String | | String | ||
|[[#Api Model MultiPolygon|MultiPolygon]] | | [[#Api Model MultiPolygon|MultiPolygon]] | ||
|- | |- | ||
|coordinates | | coordinates | ||
|double[][][][] | | double[][][][] | ||
|array of [[#Api Model Polygon|Polygon]]s; [[#Api Model Polygon|Polygon]] is array of outer and optional inner rings; rings is array of coordinates; coordinates is array of [x,y,(optional) z] | | array of [[#Api Model Polygon|Polygon]]s; [[#Api Model Polygon|Polygon]] is array of outer and optional inner rings; rings is array of coordinates; coordinates is array of [x,y,(optional) z] | ||
|} | |} | ||
| Line 217: | Line 217: | ||
!Description | !Description | ||
|- | |- | ||
|NONE | | NONE | ||
| | | | ||
|- | |- | ||
|SIMPLE | | SIMPLE | ||
| | | | ||
|- | |- | ||
|DASHED | | DASHED | ||
| | | | ||
|} | |} | ||
| Line 235: | Line 235: | ||
!Description | !Description | ||
|- | |- | ||
|type | | type | ||
|String | | String | ||
|[[#Api Model Point|Point]] | | [[#Api Model Point|Point]] | ||
|- | |- | ||
|coordinates | | coordinates | ||
|double[] | | double[] | ||
|x, y, (optional) z | | x, y, (optional) z | ||
|} | |} | ||
| Line 252: | Line 252: | ||
!Description | !Description | ||
|- | |- | ||
|attributes | | attributes | ||
|Map<String,double[]> | | Map<String,double[]> | ||
| | | | ||
|- | |- | ||
|center | | center | ||
|Point | | Point | ||
| | | | ||
|- | |- | ||
|excelID | | excelID | ||
|int | | int | ||
|[[Excel Sheet]] ID | | [[Excel Sheet]] ID | ||
|- | |- | ||
|excelUpdated | | excelUpdated | ||
|boolean | | boolean | ||
| | | | ||
|- | |- | ||
|id | | id | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|maquetteOverride | | maquetteOverride | ||
|Map<String,double[]> | | Map<String,double[]> | ||
| | | | ||
|- | |- | ||
|name | | name | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|outline | | outline | ||
|Outline | | Outline | ||
| | | | ||
|- | |- | ||
|parentZoneID | | parentZoneID | ||
|int | | int | ||
|[[Zone]] ID | | [[Zone]] ID | ||
|- | |- | ||
|permitterID | | permitterID | ||
|int | | int | ||
|[[Stakeholder]] ID | | [[Stakeholder]] ID | ||
|- | |- | ||
|polygons | | polygons | ||
|MultiPolygon | | MultiPolygon | ||
| | | | ||
|- | |- | ||
|sourceIDs | | sourceIDs | ||
|int<nowiki>[]</nowiki> | | int<nowiki>[]</nowiki> | ||
|[[Source]]s ID | | [[Source]]s ID | ||
|- | |- | ||
|version | | version | ||
|int | | int | ||
| | | | ||
|} | |} | ||
Revision as of 11:44, 8 June 2026
API Endpoint: /api/session/items/zones/
Edit items with events described at Api session event editor zoning.
Default Query:
https://engine.tygron.com/api/session/items/zones/?f=JSON&token=API_TOKENExample Response:
[ ]Limit Queries
version=100:
https://engine.tygron.com/api/session/items/zones/?version=100&token=API_TOKENPseudo-Mercator:
https://engine.tygron.com/api/session/items/zones/?crs=3857&token=API_TOKENDegrees:
https://engine.tygron.com/api/session/items/zones/?crs=4326&token=API_TOKENAmersfoort / RD New:
https://engine.tygron.com/api/session/items/zones/?crs=28992&token=API_TOKENLocal Coordinates:
https://engine.tygron.com/api/session/items/zones/?crs=LOCAL&token=API_TOKENbbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785:
https://engine.tygron.com/api/session/items/zones/?crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=API_TOKENFOO:
https://engine.tygron.com/api/session/items/zones-foo/?crs=3857&token=API_TOKENShow Queries
max version:
https://engine.tygron.com/api/session/items/zones/version/?token=API_TOKENsize:
https://engine.tygron.com/api/session/items/zones/size/?token=API_TOKENFormats
HTML:
https://engine.tygron.com/api/session/items/zones/?f=HTML&token=API_TOKENJSON:
https://engine.tygron.com/api/session/items/zones/?f=JSON&token=API_TOKENGEOJSON:
https://engine.tygron.com/api/session/items/zones/?f=GEOJSON&token=API_TOKENGPKG:
https://engine.tygron.com/api/session/items/zones/?f=GPKG&token=API_TOKENDXF:
https://engine.tygron.com/api/session/items/zones/?f=DXF&token=API_TOKENCSV:
https://engine.tygron.com/api/session/items/zones/?f=CSV&token=API_TOKENSSV:
https://engine.tygron.com/api/session/items/zones/?f=SSV&token=API_TOKENSMILE:
https://engine.tygron.com/api/session/items/zones/?f=SMILE&token=API_TOKENZIPJSON:
https://engine.tygron.com/api/session/items/zones/?f=ZIPJSON&token=API_TOKENZIPSMILE:
https://engine.tygron.com/api/session/items/zones/?f=ZIPSMILE&token=API_TOKENApi Model Category
API Enumeration description of Category
| Name | Description |
|---|---|
| SOCIAL | |
| NORMAL | |
| LUXE | |
| ROAD | |
| PAVED_AREA | |
| EDUCATION | |
| HEALTHCARE | |
| PARK | |
| NATURE | |
| INDUSTRY | |
| OFFICES | |
| OTHER | |
| SENIOR | |
| UNDERGROUND | |
| SHOPPING | |
| AGRICULTURE | |
| LEISURE | |
| STUDENT | |
| GARDEN | |
| INTERSECTION | |
| BRIDGE |
Api Model CategoryZone
API Model description of CategoryZone
| Name | Type | Description |
|---|---|---|
| allowedCategories | Category[] | |
| attributes | Map<String,double[]> | |
| center | Point | |
| excelID | int | Excel Sheet ID |
| excelUpdated | boolean | |
| id | int | |
| maquetteOverride | Map<String,double[]> | |
| name | String | |
| outline | Outline | |
| parentZoneID | int | Zone ID |
| permitterID | int | Stakeholder ID |
| polygons | MultiPolygon | |
| sourceIDs | int[] | Sources ID |
| version | int |
Api Model GeometryCollection
API Model description of GeometryCollection
| Name | Type | Description |
|---|
Api Model MultiPolygon
API Model description of MultiPolygon
| Name | Type | Description |
|---|---|---|
| type | String | MultiPolygon |
| coordinates | double[][][][] | array of Polygons; Polygon is array of outer and optional inner rings; rings is array of coordinates; coordinates is array of [x,y,(optional) z] |
Api Model Outline
API Enumeration description of Outline
| Name | Description |
|---|---|
| NONE | |
| SIMPLE | |
| DASHED |
Api Model Point
API Model description of Point
| Name | Type | Description |
|---|---|---|
| type | String | Point |
| coordinates | double[] | x, y, (optional) z |
Api Model Zone
API Model description of Zone
| Name | Type | Description |
|---|---|---|
| attributes | Map<String,double[]> | |
| center | Point | |
| excelID | int | Excel Sheet ID |
| excelUpdated | boolean | |
| id | int | |
| maquetteOverride | Map<String,double[]> | |
| name | String | |
| outline | Outline | |
| parentZoneID | int | Zone ID |
| permitterID | int | Stakeholder ID |
| polygons | MultiPolygon | |
| sourceIDs | int[] | Sources ID |
| version | int |