Api session items measures: Difference between revisions
Replaced content with "Api session items Measure Endpoints. Edit items with event: editormeasure. Default Query: <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/measures/?f=JSON&token=API_TOKEN</syntaxhighlight> Example Response: <syntaxhighlight lang="text" copy>[ { "actualHeightChangeM3" : null, "buildingIDs" : [ 1405 ], "buildingPermitProcessed" : null, "center" : { "type" : "Point", "coordinates" :..." Tag: Replaced |
No edit summary |
||
| Line 152: | Line 152: | ||
|} | |} | ||
==Api Model | ==Api Model EmptyMultiPolygon== | ||
API | API Model description of EmptyMultiPolygon | ||
{|class=wikitable | {|class=wikitable | ||
!Name | !Name | ||
!Type | |||
!Description | |||
|} | |||
==Api Model GeoTiffSpatial== | |||
API Model description of GeoTiffSpatial | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | !Description | ||
|- | |- | ||
| | |autoMP | ||
|boolean | |||
| | |||
|- | |||
|geoTiffIDs | |||
|int<nowiki>[]</nowiki> | |||
|[[GeoTIFF]] ID | |||
|- | |||
|id | |||
|int | |||
| | |||
|- | |||
|multiPolygon | |||
|MultiPolygon | |||
| | |||
|- | |||
|terrainTypeID | |||
|int | |||
| | | | ||
|} | |||
==Api Model GeometryCollection== | |||
API Model description of GeometryCollection | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|} | |||
==Api Model GridSpatial== | |||
API Model description of GridSpatial | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
|autoMP | |||
|boolean | |||
| | |||
|- | |||
|id | |||
|int | |||
| | |||
|- | |||
|multiPolygon | |||
|MultiPolygon | |||
| | |||
|- | |||
|overlayIDs | |||
|int<nowiki>[]</nowiki> | |||
|[[Overlay]] ID | |||
|- | |||
|terrainTypeID | |||
|int | |||
| | |||
|} | |||
==Api Model LeveeSpatial== | |||
API Model description of LeveeSpatial | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
|angleOverride | |||
|double | |||
| | |||
|- | |||
|heightOverride | |||
|double | |||
| | |||
|- | |||
|id | |||
|int | |||
| | |||
|- | |||
|isRelativeOverride | |||
|Boolean | |||
| | |||
|- | |||
|leveeID | |||
|int | |||
|[[Levee]] ID | |||
|- | |||
|multiPolygon | |||
|MultiPolygon | |||
| | |||
|- | |||
|sidePolygon | |||
|MultiPolygon | |||
| | |||
|- | |||
|topPolygon | |||
|MultiPolygon | |||
| | |||
|} | |||
==Api Model LineString== | |||
API Model description of LineString | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|} | |} | ||
| Line 355: | Line 470: | ||
|int | |int | ||
| | | | ||
|} | |||
==Api Model MeasureEditType== | |||
API Enumeration description of MeasureEditType | |||
{|class=wikitable | |||
!Name | |||
!Description | |||
|- | |||
|BUILDING | |||
| | |||
|- | |||
|RAISE | |||
| | |||
|- | |||
|FLATTEN | |||
| | |||
|- | |||
|WATER | |||
| | |||
|- | |||
|UPGRADE | |||
| | |||
|- | |||
|LEVEE | |||
| | |||
|- | |||
|GEOTIFF | |||
| | |||
|- | |||
|GRID | |||
| | |||
|} | |||
==Api Model MultiPolygon== | |||
API Model description of MultiPolygon | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|} | |||
==Api Model Point== | |||
API Model description of Point | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|} | |||
==Api Model TerrainSpatial== | |||
API Model description of TerrainSpatial | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
|id | |||
|int | |||
| | |||
|- | |||
|innerHeight | |||
|double | |||
| | |||
|- | |||
|innerPolygon | |||
|MultiPolygon | |||
| | |||
|- | |||
|innerPrep | |||
|PreparedGeometry | |||
| | |||
|- | |||
|measureEditType | |||
|MeasureEditType | |||
| | |||
|- | |||
|outerPolygon | |||
|MultiPolygon | |||
| | |||
|- | |||
|outerPrep | |||
|PreparedGeometry | |||
| | |||
|- | |||
|outerRings | |||
|LineString<nowiki>[]</nowiki> | |||
| | |||
|- | |||
|relative | |||
|boolean | |||
| | |||
|- | |||
|terrainTypeID | |||
|int | |||
| | |||
|} | |||
==Api Model TimeState== | |||
API Enumeration description of TimeState | |||
{|class=wikitable | |||
!Name | |||
!Description | |||
|- | |||
|NOTHING | |||
| | |||
|- | |||
|WAITING_FOR_DATE | |||
| | |||
|- | |||
|REQUEST_PLOT_OWNER_APPROVAL | |||
| | |||
|- | |||
|REQUEST_ZONING_APPROVAL | |||
| | |||
|- | |||
|REQUEST_CONSTRUCTION_APPROVAL | |||
| | |||
|- | |||
|CONSTRUCTION_APPROVED | |||
| | |||
|- | |||
|CONSTRUCTION_DENIED | |||
| | |||
|- | |||
|PENDING_CONSTRUCTION | |||
| | |||
|- | |||
|CONSTRUCTING | |||
| | |||
|- | |||
|READY | |||
| | |||
|- | |||
|PENDING_UPGRADE | |||
| | |||
|- | |||
|WAITING_FOR_DEMOLISH_DATE | |||
| | |||
|- | |||
|REQUEST_DEMOLISH_ZONING_APPROVAL | |||
| | |||
|- | |||
|REQUEST_DEMOLISH_APPROVAL | |||
| | |||
|- | |||
|DEMOLISH_APPROVED | |||
| | |||
|- | |||
|DEMOLISH_DENIED | |||
| | |||
|- | |||
|PENDING_DEMOLISHING | |||
| | |||
|- | |||
|DEMOLISHING | |||
| | |||
|- | |||
|DEMOLISH_FINISHED | |||
| | |||
|} | |||
==Api Model UpgradeSpatial== | |||
API Model description of UpgradeSpatial | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
|id | |||
|int | |||
| | |||
|- | |||
|multiPolygon | |||
|MultiPolygon | |||
| | |||
|- | |||
|upgradeID | |||
|int | |||
|[[Upgrade Type]] ID | |||
|} | |} | ||
Revision as of 14:06, 20 April 2026
Api session items Measure Endpoints.
Edit items with event: editormeasure.
Default Query:
https://engine.tygron.com/api/session/items/measures/?f=JSON&token=API_TOKENExample Response:
[ {
"actualHeightChangeM3" : null,
"buildingIDs" : [ 1405 ],
"buildingPermitProcessed" : null,
"center" : {
"type" : "Point",
"coordinates" : [ 659086.4055532492, 6799091.1227987455, 55.402 ]
},
"clientActionEvents" : { },
"confirmationsRequired" : false,
"constructionCostsFixed" : -1.0,
"constructionCostsM3" : 0.0,
"custom" : false,
"dependencyIDs" : [ ],
"description" : "",
"geoTiffSpatials" : [ ],
"gridSpatials" : [ ],
"id" : 0,
"imageName" : "measure.png",
"imageVersion" : 0,
"incomeFixed" : 0.0,
"landOwnerPermissions" : { },
"leveeSpatials" : [ ],
"name" : "Measure",
"ownerID" : 2,
"serverActionEvents" : { },
"sourceIDs" : [ ],
"state" : "NOTHING",
"terrainSpatials" : [ {
"id" : 1,
"innerHeight" : 49.559317009580646,
"innerPolygon" : {
"type" : "MultiPolygon",
"coordinates" : [ [ [ [ 659142.0614489131, 6799231.181467466 ], [ 659142.7646998417, 6799263.655208195 ], [ 659061.5757606464, 6799265.410856503 ], [ 659060.8741338538, 6799232.937108732 ], [ 659142.0614489131, 6799231.181467466 ] ] ] ]
},
"measureEditType" : "WATER",
"outerPolygon" : {
"type" : "MultiPolygon",
"coordinates" : [ [ [ [ 659041.5063109348, 6799223.619708879 ], [ 659155.0675307526, 6799218.219617132 ], [ 659158.153389331, 6799283.110281363 ], [ 659044.592169513, 6799288.5104164 ], [ 659041.5063109348, 6799223.619708879 ] ] ] ]
},
"relative" : false,
"terrainTypeID" : 3
}, {
"id" : 2,
"innerHeight" : 0.0,
"innerPolygon" : {
"type" : "MultiPolygon",
"coordinates" : [ ]
},
"measureEditType" : "FLATTEN",
"outerPolygon" : {
"type" : "MultiPolygon",
"coordinates" : [ ]
},
"relative" : false,
"terrainTypeID" : 1
} ],
"upgradeSpatials" : [ ],
"version" : 4
}, {
"actualHeightChangeM3" : null,
"buildingIDs" : [ 1410, 1411, 1412, 1413, 1414, 1415, 1416, 1417, 1418, 1419 ],
"buildingPermitProcessed" : null,
"center" : {
"type" : "Point",
"coordinates" : [ 659256.3616506538, 6799141.129437042, 58.377 ]
},
"clientActionEvents" : { },
"confirmationsRequired" : false,
"constructionCostsFixed" : -1.0,
"constructionCostsM3" : 0.0,
"custom" : false,
"dependencyIDs" : [ ],
"description" : "",
"geoTiffSpatials" : [ ],
"gridSpatials" : [ ],
"id" : 1,
"imageName" : "measure.png",
"imageVersion" : 0,
"incomeFixed" : 0.0,
"landOwnerPermissions" : { },
"leveeSpatials" : [ ],
"name" : "Measure (2)",
"ownerID" : 2,
"serverActionEvents" : { },
"sourceIDs" : [ ],
"state" : "NOTHING",
"terrainSpatials" : [ ],
"upgradeSpatials" : [ ],
"version" : 1
} ]Limit Queries
version=100:
https://engine.tygron.com/api/session/items/measures/?version=100&token=API_TOKENPseudo-Mercator:
https://engine.tygron.com/api/session/items/measures/?crs=3857&token=API_TOKENDegrees:
https://engine.tygron.com/api/session/items/measures/?crs=4326&token=API_TOKENAmersfoort / RD New:
https://engine.tygron.com/api/session/items/measures/?crs=28992&token=API_TOKENLocal Coordinates:
https://engine.tygron.com/api/session/items/measures/?crs=LOCAL&token=API_TOKENbbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785:
https://engine.tygron.com/api/session/items/measures/?crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=API_TOKENFOO:
https://engine.tygron.com/api/session/items/measures-foo/?crs=3857&token=API_TOKENShow Queries
max version:
https://engine.tygron.com/api/session/items/measures/version/?token=API_TOKENsize:
https://engine.tygron.com/api/session/items/measures/size/?token=API_TOKENFormats
HTML:
https://engine.tygron.com/api/session/items/measures/?f=HTML&token=API_TOKENJSON:
https://engine.tygron.com/api/session/items/measures/?f=JSON&token=API_TOKENGEOJSON:
https://engine.tygron.com/api/session/items/measures/?f=GEOJSON&token=API_TOKENGPKG:
https://engine.tygron.com/api/session/items/measures/?f=GPKG&token=API_TOKENDXF:
https://engine.tygron.com/api/session/items/measures/?f=DXF&token=API_TOKENCSV:
https://engine.tygron.com/api/session/items/measures/?f=CSV&token=API_TOKENSSV:
https://engine.tygron.com/api/session/items/measures/?f=SSV&token=API_TOKENSMILE:
https://engine.tygron.com/api/session/items/measures/?f=SMILE&token=API_TOKENZIPJSON:
https://engine.tygron.com/api/session/items/measures/?f=ZIPJSON&token=API_TOKENZIPSMILE:
https://engine.tygron.com/api/session/items/measures/?f=ZIPSMILE&token=API_TOKENApi Model ActionType
API Enumeration description of ActionType
| Name | Description |
|---|---|
| CONSTRUCTION_PLAN | |
| CONSTRUCTION_PLAN_CANCEL |
Api Model EmptyMultiPolygon
API Model description of EmptyMultiPolygon
| Name | Type | Description |
|---|
Api Model GeoTiffSpatial
API Model description of GeoTiffSpatial
| Name | Type | Description |
|---|---|---|
| autoMP | boolean | |
| geoTiffIDs | int[] | GeoTIFF ID |
| id | int | |
| multiPolygon | MultiPolygon | |
| terrainTypeID | int |
Api Model GeometryCollection
API Model description of GeometryCollection
| Name | Type | Description |
|---|
Api Model GridSpatial
API Model description of GridSpatial
| Name | Type | Description |
|---|---|---|
| autoMP | boolean | |
| id | int | |
| multiPolygon | MultiPolygon | |
| overlayIDs | int[] | Overlay ID |
| terrainTypeID | int |
Api Model LeveeSpatial
API Model description of LeveeSpatial
| Name | Type | Description |
|---|---|---|
| angleOverride | double | |
| heightOverride | double | |
| id | int | |
| isRelativeOverride | Boolean | |
| leveeID | int | Levee ID |
| multiPolygon | MultiPolygon | |
| sidePolygon | MultiPolygon | |
| topPolygon | MultiPolygon |
Api Model LineString
API Model description of LineString
| Name | Type | Description |
|---|
Api Model MapMeasure
API Model description of MapMeasure
| Name | Type | Description |
|---|---|---|
| actualHeightChangeM3 | double | |
| buildingIDs | int[] | Building ID |
| buildingPermitProcessed | Set | |
| center | Point | |
| clientActionEvents | Map<ActionType,java.util.List<nl.tytech.data.core.item.CodedEvent>> | |
| confirmationsRequired | boolean | |
| constructionCostsFixed | double | |
| constructionCostsM3 | double | |
| custom | boolean | |
| dependencyIDs | int[] | Measure ID |
| description | String | |
| geoTiffSpatials | GeoTiffSpatial[] | |
| gridSpatials | GridSpatial[] | |
| id | int | |
| imageName | String | |
| imageVersion | int | |
| incomeFixed | double | |
| landOwnerPermissions | Map<int,Boolean> | |
| leveeSpatials | LeveeSpatial[] | |
| name | String | |
| ownerID | int | Stakeholder ID |
| serverActionEvents | Map<ActionType,java.util.List<nl.tytech.data.core.item.CodedEvent>> | |
| sourceIDs | int[] | Source ID |
| state | TimeState | |
| terrainSpatials | TerrainSpatial[] | |
| upgradeSpatials | UpgradeSpatial[] | |
| version | int |
Api Model Measure
API Model description of Measure
| Name | Type | Description |
|---|---|---|
| clientActionEvents | Map<ActionType,java.util.List<nl.tytech.data.core.item.CodedEvent>> | |
| confirmationsRequired | boolean | |
| constructionCostsFixed | double | |
| custom | boolean | |
| dependencyIDs | int[] | Measure ID |
| description | String | |
| id | int | |
| imageName | String | |
| imageVersion | int | |
| incomeFixed | double | |
| landOwnerPermissions | Map<int,Boolean> | |
| name | String | |
| ownerID | int | Stakeholder ID |
| serverActionEvents | Map<ActionType,java.util.List<nl.tytech.data.core.item.CodedEvent>> | |
| sourceIDs | int[] | Source ID |
| state | TimeState | |
| version | int |
Api Model MeasureEditType
API Enumeration description of MeasureEditType
| Name | Description |
|---|---|
| BUILDING | |
| RAISE | |
| FLATTEN | |
| WATER | |
| UPGRADE | |
| LEVEE | |
| GEOTIFF | |
| GRID |
Api Model MultiPolygon
API Model description of MultiPolygon
| Name | Type | Description |
|---|
Api Model Point
API Model description of Point
| Name | Type | Description |
|---|
Api Model TerrainSpatial
API Model description of TerrainSpatial
| Name | Type | Description |
|---|---|---|
| id | int | |
| innerHeight | double | |
| innerPolygon | MultiPolygon | |
| innerPrep | PreparedGeometry | |
| measureEditType | MeasureEditType | |
| outerPolygon | MultiPolygon | |
| outerPrep | PreparedGeometry | |
| outerRings | LineString[] | |
| relative | boolean | |
| terrainTypeID | int |
Api Model TimeState
API Enumeration description of TimeState
| Name | Description |
|---|---|
| NOTHING | |
| WAITING_FOR_DATE | |
| REQUEST_PLOT_OWNER_APPROVAL | |
| REQUEST_ZONING_APPROVAL | |
| REQUEST_CONSTRUCTION_APPROVAL | |
| CONSTRUCTION_APPROVED | |
| CONSTRUCTION_DENIED | |
| PENDING_CONSTRUCTION | |
| CONSTRUCTING | |
| READY | |
| PENDING_UPGRADE | |
| WAITING_FOR_DEMOLISH_DATE | |
| REQUEST_DEMOLISH_ZONING_APPROVAL | |
| REQUEST_DEMOLISH_APPROVAL | |
| DEMOLISH_APPROVED | |
| DEMOLISH_DENIED | |
| PENDING_DEMOLISHING | |
| DEMOLISHING | |
| DEMOLISH_FINISHED |
Api Model UpgradeSpatial
API Model description of UpgradeSpatial
| Name | Type | Description |
|---|---|---|
| id | int | |
| multiPolygon | MultiPolygon | |
| upgradeID | int | Upgrade Type ID |