Api session items zones: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
46,429 edits
Replaced content with "Api session items Zone Endpoints. Edit items with event: editorzoning. Default Query: <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?f=JSON&token=API_TOKEN</syntaxhighlight> Example Response: <syntaxhighlight lang="text" copy>[ ]</syntaxhighlight> ==Limit Queries== version=100: <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?version=100&token=API_TOKE..."
Tag: Replaced
No edit summary
 
(23 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session items [[Zone]] Endpoints.
API Endpoint: /api/session/items/zones/


Edit items with event: [[Api session event editor zoning|editorzoning]].
Edit items with events described at [[Api session event editor zoning]].


Default Query:
Default Query:
Line 22: Line 22:
FOO:  
FOO:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones-foo/?crs=3857&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones-foo/?crs=3857&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Get Queries==
attributes:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/attributes/?token=API_TOKEN</syntaxhighlight>
max version:  
max version:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/version/?token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/version/?token=API_TOKEN</syntaxhighlight>
size:  
count:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/size/?token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/count/?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?f=HTML&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?f=HTML&token=API_TOKEN&crs=3857</syntaxhighlight>
JSON:  
JSON:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?f=JSON&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?f=JSON&token=API_TOKEN&crs=3857</syntaxhighlight>
GEOJSON:  
GEOJSON:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?f=GEOJSON&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?f=GEOJSON&token=API_TOKEN&crs=3857</syntaxhighlight>
GPKG:  
GPKG:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?f=GPKG&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?f=GPKG&token=API_TOKEN&crs=3857</syntaxhighlight>
DXF:  
DXF:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?f=DXF&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?f=DXF&token=API_TOKEN&crs=3857</syntaxhighlight>
CSV:  
CSV:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?f=CSV&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?f=CSV&token=API_TOKEN&crs=3857</syntaxhighlight>
SSV:  
SSV:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?f=SSV&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?f=SSV&token=API_TOKEN&crs=3857</syntaxhighlight>
SMILE:  
SMILE:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?f=SMILE&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?f=SMILE&token=API_TOKEN&crs=3857</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?f=ZIPJSON&token=API_TOKEN&crs=3857</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zones/?f=ZIPSMILE&token=API_TOKEN&crs=3857</syntaxhighlight>
==Api Model CategoryZone==
==Api Model Category==
API Model description of CategoryZone
API Enumeration description of Category


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|allowedCategories
| SOCIAL
|Category<nowiki>[]</nowiki>
|  
|
|-
| NORMAL
|
|-
| LUXE
|
|-
| ROAD
|  
|-
|-
|attributes
| PAVED_AREA
|Map&lt;String,double[]&gt;
|  
|
|-
|-
|center
| EDUCATION
|Point
|  
|
|-
|-
|excelID
| HEALTHCARE
|int
|  
|[[Excel Sheet]] ID
|-
|-
|excelUpdated
| PARK
|boolean
|  
|
|-
|-
|id
| NATURE
|int
|  
|
|-
|-
|maquetteOverride
| INDUSTRY
|Map&lt;String,double[]&gt;
|  
|
|-
|-
|name
| OFFICES
|String
|  
|
|-
|-
|outline
| OTHER
|Outline
|  
|
|-
|-
|parentZoneID
| SENIOR
|int
|  
|[[Zone]] ID
|-
|-
|permitterID
| UNDERGROUND
|int
|  
|[[Stakeholder]] ID
|-
|-
|polygons
| SHOPPING
|MultiPolygon
|  
|
|-
|-
|sourceIDs
| AGRICULTURE
|int<nowiki>[]</nowiki>
|  
|[[Source]] ID
|-
|-
|version
| LEISURE
|int
|  
|
|-
| STUDENT
|
|-
| GARDEN
|
|-
| INTERSECTION
|
|-
| BRIDGE
|  
|}
|}


==Api Model Zone==
==Api Model CategoryZone==
API Model description of Zone
API Model description of CategoryZone


{|class=wikitable
{|class=wikitable
Line 121: Line 129:
!Description
!Description
|-
|-
|attributes
| allowedCategories
|Map&lt;String,double[]&gt;
| Category<nowiki>[]</nowiki>
|
| [[Category]]<nowiki>[]</nowiki>
|-
| attributes
| Map&lt;String,double[]&gt;
|  
|-
|-
|center
| center
|Point
| Point
|
| [[Point]]
|-
|-
|excelID
| excelID
|int
| int
|[[Excel Sheet]] ID  
| [[Excel Sheet]] ID  
|-
|-
|excelUpdated
| excelUpdated
|boolean
| boolean
|
|  
|-
|-
|id
| id
|int
| int
|
|  
|-
|-
|maquetteOverride
| maquetteOverride
|Map&lt;String,double[]&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|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
|
| [[MultiPolygon]]
|-
|-
|sourceIDs
| sourceIDs
|int<nowiki>[]</nowiki>
| int<nowiki>[]</nowiki>
|[[Source]] ID  
| [[Source]]s ID  
|-
|-
|version
| version
|int
| int
|
|  
|}
|}


==Api Model ZoneAttribute==
==Api Model GeometryCollection==
API Enumeration description of ZoneAttribute
API Model description of GeometryCollection


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|}
==Api Model MultiPolygon==
API Model description of MultiPolygon
{|class=wikitable
!Name
!Type
!Description
|-
| type
| String
| [[MultiPolygon]]
|-
| coordinates
| double[][][][]
| array of [[Polygon]]s; [[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
{|class=wikitable
!Name
!Description
|-
| NONE
|
|-
| SIMPLE
|
|-
| DASHED
|
|}
==Api Model Point==
API Model description of Point
{|class=wikitable
!Name
!Type
!Description
|-
| type
| String
| [[Point]]
|-
| coordinates
| double[]
| x, y, (optional) z
|}
==Api Model Zone==
API Model description of Zone
{|class=wikitable
!Name
!Type
!Description
|-
| attributes
| Map&lt;String,double[]&gt;
|
|-
| center
| Point
| [[Point]]
|-
| excelID
| int
| [[Excel Sheet]] ID
|-
| excelUpdated
| boolean
|
|-
| id
| int
|
|-
| maquetteOverride
| Map&lt;String,double[]&gt;
|
|-
|-
|MAX_BUILDING_HEIGHT
| name
|
| String
|  
|-
|-
|MAX_ROOF_GUTTER_HEIGHT
| outline
|
| Outline
|  
|-
|-
|MAX_FLOORS
| parentZoneID
|
| int
| [[Zone]] ID
|-
|-
|MIN_FLOORS
| permitterID
|
| int
| [[Stakeholder]] ID
|-
|-
|AMOUNT_FLOORS
| polygons
|
| MultiPolygon
| [[MultiPolygon]]
|-
|-
|MAX_BUILDING_PCT
| sourceIDs
|
| int<nowiki>[]</nowiki>
| [[Source]]s ID
|-
|-
|MONUMENTAL
| version
|
| int
|  
|}
|}


Line 208: Line 312:


[[Category:API]]
[[Category:API]]
[[Category:Items]]

Latest revision as of 07:14, 7 July 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_TOKEN

Example Response: 

[ ]

Limit Queries

version=100: 

https://engine.tygron.com/api/session/items/zones/?version=100&token=API_TOKEN

Pseudo-Mercator: 

https://engine.tygron.com/api/session/items/zones/?crs=3857&token=API_TOKEN

Degrees: 

https://engine.tygron.com/api/session/items/zones/?crs=4326&token=API_TOKEN

Amersfoort / RD New: 

https://engine.tygron.com/api/session/items/zones/?crs=28992&token=API_TOKEN

Local Coordinates: 

https://engine.tygron.com/api/session/items/zones/?crs=LOCAL&token=API_TOKEN

bbox=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_TOKEN

FOO: 

https://engine.tygron.com/api/session/items/zones-foo/?crs=3857&token=API_TOKEN

Get Queries

attributes: 

https://engine.tygron.com/api/session/items/zones/attributes/?token=API_TOKEN

max version: 

https://engine.tygron.com/api/session/items/zones/version/?token=API_TOKEN

count: 

https://engine.tygron.com/api/session/items/zones/count/?token=API_TOKEN

Formats

HTML: 

https://engine.tygron.com/api/session/items/zones/?f=HTML&token=API_TOKEN&crs=3857

JSON: 

https://engine.tygron.com/api/session/items/zones/?f=JSON&token=API_TOKEN&crs=3857

GEOJSON: 

https://engine.tygron.com/api/session/items/zones/?f=GEOJSON&token=API_TOKEN&crs=3857

GPKG: 

https://engine.tygron.com/api/session/items/zones/?f=GPKG&token=API_TOKEN&crs=3857

DXF: 

https://engine.tygron.com/api/session/items/zones/?f=DXF&token=API_TOKEN&crs=3857

CSV: 

https://engine.tygron.com/api/session/items/zones/?f=CSV&token=API_TOKEN&crs=3857

SSV: 

https://engine.tygron.com/api/session/items/zones/?f=SSV&token=API_TOKEN&crs=3857

SMILE: 

https://engine.tygron.com/api/session/items/zones/?f=SMILE&token=API_TOKEN&crs=3857

ZIPJSON: 

https://engine.tygron.com/api/session/items/zones/?f=ZIPJSON&token=API_TOKEN&crs=3857

ZIPSMILE: 

https://engine.tygron.com/api/session/items/zones/?f=ZIPSMILE&token=API_TOKEN&crs=3857

Api 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[] Category[]
attributes Map<String,double[]>
center Point 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 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 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 MultiPolygon
sourceIDs int[] Sources ID
version int

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_items_zones&oldid=89404"