Api session items parametricdesigns: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (11 intermediate revisions by the same user not shown) | |||
| Line 4: | Line 4: | ||
Default Query: | Default Query: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/? | <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: | |||
<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> | ||
== | ==Get Queries== | ||
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> | ||
Count: | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/ | <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 63: | Line 67: | ||
| type | | type | ||
| String | | String | ||
| [[ | | [[MultiPolygon]] | ||
|- | |- | ||
| coordinates | | coordinates | ||
| double[][][][] | | double[][][][] | ||
| array of [[ | | 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] | ||
|} | |} | ||
| Line 88: | Line 92: | ||
| center | | center | ||
| Point | | Point | ||
| [[ | | [[Point]] | ||
|- | |- | ||
| gardenID | | gardenID | ||
| int | | int | ||
| | | [[Function]] ID | ||
|- | |- | ||
| id | | id | ||
| Line 108: | Line 112: | ||
| parkingID | | parkingID | ||
| int | | int | ||
| | | [[Function]] ID | ||
|- | |- | ||
| plotDesigns | | plotDesigns | ||
| Line 116: | Line 120: | ||
| polygons | | polygons | ||
| MultiPolygon | | MultiPolygon | ||
| [[ | | [[MultiPolygon]] | ||
|- | |- | ||
| publicGreenID | | publicGreenID | ||
| int | | int | ||
| | | [[Function]] ID | ||
|- | |- | ||
| roadID | | roadID | ||
| int | | int | ||
| | | [[Function]] ID | ||
|- | |- | ||
| sidewalkID | | sidewalkID | ||
| int | | int | ||
| | | [[Function]] ID | ||
|- | |- | ||
| sourceIDs | | sourceIDs | ||
| int<nowiki>[]</nowiki> | | int<nowiki>[]</nowiki> | ||
| | | [[Source]]s ID | ||
|- | |- | ||
| version | | version | ||
| Line 140: | Line 144: | ||
| waterID | | waterID | ||
| int | | int | ||
| | | [[Terrain Type]] ID | ||
|} | |} | ||
| Line 157: | Line 161: | ||
| functionID | | functionID | ||
| int | | int | ||
| | | [[Function]] ID | ||
|- | |- | ||
| id | | id | ||
| Line 165: | Line 169: | ||
| multiPolygon | | multiPolygon | ||
| MultiPolygon | | MultiPolygon | ||
| [[ | | [[MultiPolygon]] | ||
|} | |} | ||
| Line 178: | Line 182: | ||
| type | | type | ||
| String | | String | ||
| [[ | | [[Point]] | ||
|- | |- | ||
| coordinates | | coordinates | ||
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_TOKENExample Response:
[ ]Limit Queries
Version=100:
https://engine.tygron.com/api/session/items/parametricdesigns/?version=100&token=API_TOKENGet Queries
Attributes:
https://engine.tygron.com/api/session/items/parametricdesigns/attributes/?token=API_TOKENMax version:
https://engine.tygron.com/api/session/items/parametricdesigns/version/?token=API_TOKENCount:
https://engine.tygron.com/api/session/items/parametricdesigns/count/?token=API_TOKENSpecific Item by ID:
https://engine.tygron.com/api/session/items/parametricdesigns/{id}/?token=API_TOKENFormats
HTML:
https://engine.tygron.com/api/session/items/parametricdesigns/?f=HTML&token=API_TOKENJSON:
https://engine.tygron.com/api/session/items/parametricdesigns/?f=JSON&token=API_TOKENCSV:
https://engine.tygron.com/api/session/items/parametricdesigns/?f=CSV&token=API_TOKENSSV:
https://engine.tygron.com/api/session/items/parametricdesigns/?f=SSV&token=API_TOKENSMILE:
https://engine.tygron.com/api/session/items/parametricdesigns/?f=SMILE&token=API_TOKENZIPJSON:
https://engine.tygron.com/api/session/items/parametricdesigns/?f=ZIPJSON&token=API_TOKENZIPSMILE:
https://engine.tygron.com/api/session/items/parametricdesigns/?f=ZIPSMILE&token=API_TOKENApi 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 |