Api session items parametricdesigns: 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
51,321 edits
Replaced content with "Api session items Parametric Designs Endpoints. Edit items with event: editorparametric. Default Query: <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/?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..."
Tag: Replaced
No edit summary
 
(25 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session items [[Parametric Design]]s Endpoints.
API Endpoint: /api/session/items/parametricdesigns/


Edit items with event: [[Api session event editor parametric|editorparametric]].
Edit items with events described at [[Api session event editor parametric]].


Default Query:
Default Query:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/?f=JSON&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/?token=API_TOKEN</syntaxhighlight>
Example Response:
Example Response:
<syntaxhighlight lang="text" copy>[ ]</syntaxhighlight>
<syntaxhighlight lang="text" copy>[ ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
version=100:  
Version=100:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/?version=100&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/?version=100&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Get Queries==
max version:  
Attributes:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/attributes/?token=API_TOKEN</syntaxhighlight>
Max version:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/version/?token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/version/?token=API_TOKEN</syntaxhighlight>
size:  
Count:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/size/?token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/count/?token=API_TOKEN</syntaxhighlight>
Specific Item by ID:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/{id}/?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  
Line 37: Line 41:
!Description
!Description
|-
|-
|ROAD
| ROAD
|
|  
|-
|-
|SPACED
| SPACED
|
|  
|}
|}


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


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|BACKYARD_DISTANCE_M
|
|-
|WATER_WIDTH_M
|
|-
|KEEP_EXISTING_ROADS
|
|-
|ROAD_WIDTH_M
|
|-
|ROAD_DISTANCE_Y_M
|
|-
|ROAD_SEARCH_DISTANCE_M
|
|-
|SIDEWALK_WIDTH_M
|
|-
|PARKING_WIDTH_M
|
|-
|PARKING_LENGTH_M
|
|-
|FRACTION_BUILDINGS
|
|-
|FRACTION_ROADS
|
|-
|FRACTION_WATER
|
|-
|FRACTION_PUBLIC_GREEN
|
|-
|FRACTION_GARDENS
|
|-
|FRACTION_PARKING
|
|-
|FRACTION_REMAINDER
|
|}
|}


==Api Model Example==
==Api Model MultiPolygon==
API Enumeration description of Example
API Model description of MultiPolygon


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|CITY_NEIGHBORHOOD
| type
|
| String
|-
| [[MultiPolygon]]
|URBAN_NEIGHBORHOOD
|
|-
|-
|SUBURBAN_NEIGHBORHOOD
| 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]
|WINDMILL_AREA
|
|}
|}


==Api Model FunctionType==
==Api Model ParametricDesign==
API Enumeration description of FunctionType
API Model description of ParametricDesign


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|ROAD
| alignment
|
| Alignment
|  
|-
|-
|WATER
| attributes
|
| Map&lt;String,double[]&gt;
|  
|-
|-
|PARKING
| center
|
| Point
| [[Point]]
|-
|-
|SIDEWALK
| gardenID
|
| int
| [[Function]] ID
|-
|-
|BUILDING
| id
|
| int
|  
|-
|-
|GARDEN
| maquetteOverride
|
| Map&lt;String,double[]&gt;
|  
|-
|-
|PUBLIC_GREEN
| name
|
| String
|  
|-
|-
|REMAINDER
| parkingID
|
| int
| [[Function]] ID
|-
| plotDesigns
| PlotDesign<nowiki>[]</nowiki>
| [[Plot]]Design<nowiki>[]</nowiki>
|-
| polygons
| MultiPolygon
| [[MultiPolygon]]
|-
| publicGreenID
| int
| [[Function]] ID
|-
| roadID
| int
| [[Function]] ID
|-
| sidewalkID
| int
| [[Function]] ID
|-
| sourceIDs
| int<nowiki>[]</nowiki>
| [[Source]]s ID
|-
| version
| int
|
|-
| waterID
| int
| [[Terrain Type]] ID
|}
|}


==Api Model PDResult==
==Api Model PlotDesign==
API Model description of PDResult
API Model description of PlotDesign


{|class=wikitable
{|class=wikitable
Line 160: Line 155:
!Description
!Description
|-
|-
|areaExisting
| attributes
|Map&lt;FunctionType,double&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|bandMPs
| functionID
|Map&lt;FunctionType,java.util.Map<java.lang.Integer, java.util.List<org.locationtech.jts.geom.MultiPolygon>>&gt;
| int
|
| [[Function]] ID
|-
|-
|detailMPs
| id
|Map&lt;FunctionType,java.util.Map<java.lang.Integer, java.util.List<org.locationtech.jts.geom.MultiPolygon>>&gt;
| int
|
|
|-
| multiPolygon
| MultiPolygon
| [[MultiPolygon]]
|}
|}


==Api Model ParametricDesign==
==Api Model Point==
API Model description of ParametricDesign
API Model description of Point


{|class=wikitable
{|class=wikitable
Line 181: Line 180:
!Description
!Description
|-
|-
|alignment
| type
|Alignment
| String
|
| [[Point]]
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|center
|Point
|
|-
|gardenID
|int
|[[Function]] ID
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|parkingID
|int
|[[Function]] ID
|-
|plotDesigns
|PlotDesign<nowiki>[]</nowiki>
|
|-
|polygons
|MultiPolygon
|
|-
|publicGreenID
|int
|[[Function]] ID
|-
|roadID
|int
|[[Function]] ID
|-
|sidewalkID
|int
|[[Function]] ID
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|-
|-
|waterID
| coordinates
|int
| double[]
|[[Terrain Type]] ID
| x, y, (optional) z
|}
|}


Line 251: Line 194:


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

Latest revision as of 09:53, 23 September 2026

API Endpoint: /api/session/items/parametricdesigns/

Edit items with events described at Api session event editor parametric.

Default Query: 

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

Example Response: 

[ ]

Limit Queries

Version=100: 

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

Get Queries

Attributes: 

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

Max version: 

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

Count: 

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

Specific Item by ID: 

https://engine.tygron.com/api/session/items/parametricdesigns/{id}/?token=API_TOKEN

Formats

HTML: 

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

JSON: 

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

CSV: 

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

SSV: 

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

SMILE: 

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

ZIPJSON: 

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

ZIPSMILE: 

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

Api Model Alignment

API Enumeration description of Alignment

Name Description
ROAD
SPACED

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 ParametricDesign

API Model description of ParametricDesign

Name Type Description
alignment Alignment
attributes Map<String,double[]>
center Point Point
gardenID int Function ID
id int
maquetteOverride Map<String,double[]>
name String
parkingID int Function ID
plotDesigns PlotDesign[] PlotDesign[]
polygons MultiPolygon MultiPolygon
publicGreenID int Function ID
roadID int Function ID
sidewalkID int Function ID
sourceIDs int[] Sources ID
version int
waterID int Terrain Type ID

Api Model PlotDesign

API Model description of PlotDesign

Name Type Description
attributes Map<String,double[]>
functionID int Function ID
id int
multiPolygon MultiPolygon MultiPolygon

Api Model Point

API Model description of Point

Name Type Description
type String Point
coordinates double[] x, y, (optional) z

See also

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