Api session items parametricdesigns: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
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
 
(2 intermediate revisions by the same user not shown)
Line 44: Line 44:
|}
|}


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


{|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 GeometryCollection==
API Enumeration description of Example
API Model description of GeometryCollection
 
{|class=wikitable
!Name
!Description
|-
|CITY_NEIGHBORHOOD
|
|-
|URBAN_NEIGHBORHOOD
|
|-
|SUBURBAN_NEIGHBORHOOD
|
|-
|WINDMILL_AREA
|
|}
 
==Api Model FunctionType==
API Enumeration description of FunctionType


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|ROAD
|
|-
|WATER
|
|-
|PARKING
|
|-
|SIDEWALK
|
|-
|BUILDING
|
|-
|GARDEN
|
|-
|PUBLIC_GREEN
|
|-
|REMAINDER
|
|}
|}


==Api Model PDResult==
==Api Model MultiPolygon==
API Model description of PDResult
API Model description of MultiPolygon


{|class=wikitable
{|class=wikitable
Line 159: Line 69:
!Type
!Type
!Description
!Description
|-
|areaExisting
|Map&lt;FunctionType,double&gt;
|
|-
|bandMPs
|Map&lt;FunctionType,java.util.Map<java.lang.Integer, java.util.List<org.locationtech.jts.geom.MultiPolygon>>&gt;
|
|-
|detailMPs
|Map&lt;FunctionType,java.util.Map<java.lang.Integer, java.util.List<org.locationtech.jts.geom.MultiPolygon>>&gt;
|
|}
|}


Line 244: Line 142:
|int
|int
|[[Terrain Type]] ID  
|[[Terrain Type]] ID  
|}
==Api Model PlotDesign==
API Model description of PlotDesign
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|functionID
|int
|[[Function]] ID
|-
|id
|int
|
|-
|multiPolygon
|MultiPolygon
|
|}
==Api Model Point==
API Model description of Point
{|class=wikitable
!Name
!Type
!Description
|}
|}


Line 251: Line 183:


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

Latest revision as of 14:14, 24 April 2026

Api session items Parametric Designs Endpoints.

Edit items with event: editorparametric.

Default Query:

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

Example Response:

[ ]

Limit Queries

version=100:

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

Show Queries

max version:

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

size:

https://engine.tygron.com/api/session/items/parametricdesigns/size/?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 EmptyMultiPolygon

API Model description of EmptyMultiPolygon

Name Type Description

Api Model GeometryCollection

API Model description of GeometryCollection

Name Type Description

Api Model MultiPolygon

API Model description of MultiPolygon

Name Type Description

Api Model ParametricDesign

API Model description of ParametricDesign

Name Type Description
alignment Alignment
attributes Map<String,double[]>
center Point
gardenID int Function ID
id int
maquetteOverride Map<String,double[]>
name String
parkingID int Function ID
plotDesigns PlotDesign[]
polygons MultiPolygon
publicGreenID int Function ID
roadID int Function ID
sidewalkID int Function ID
sourceIDs int[] Source 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

Api Model Point

API Model description of Point

Name Type Description