Api session items measures: 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
43,025 edits
No edit summary
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 64: Line 64:
   } ],
   } ],
   "upgradeSpatials" : [ ],
   "upgradeSpatials" : [ ],
   "version" : 3
   "version" : 4
}, {
}, {
   "actualHeightChangeM3" : null,
   "actualHeightChangeM3" : null,
Line 119: Line 119:
==Formats==
==Formats==
HTML:  
HTML:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/measures/?f=HTML&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/measures/?f=HTML&token=API_TOKEN&crs=3857</syntaxhighlight>
JSON:  
JSON:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/measures/?f=JSON&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/measures/?f=JSON&token=API_TOKEN&crs=3857</syntaxhighlight>
GEOJSON:  
GEOJSON:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/measures/?f=GEOJSON&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/measures/?f=GEOJSON&token=API_TOKEN&crs=3857</syntaxhighlight>
GPKG:  
GPKG:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/measures/?f=GPKG&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/measures/?f=GPKG&token=API_TOKEN&crs=3857</syntaxhighlight>
DXF:  
DXF:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/measures/?f=DXF&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/measures/?f=DXF&token=API_TOKEN&crs=3857</syntaxhighlight>
CSV:  
CSV:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/measures/?f=CSV&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/measures/?f=CSV&token=API_TOKEN&crs=3857</syntaxhighlight>
SSV:  
SSV:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/measures/?f=SSV&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/measures/?f=SSV&token=API_TOKEN&crs=3857</syntaxhighlight>
SMILE:  
SMILE:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/measures/?f=SMILE&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/measures/?f=SMILE&token=API_TOKEN&crs=3857</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/measures/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/measures/?f=ZIPJSON&token=API_TOKEN&crs=3857</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/measures/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/measures/?f=ZIPSMILE&token=API_TOKEN&crs=3857</syntaxhighlight>
==Api Model ActionType==
==Api Model ActionType==
API Enumeration description of ActionType
API Enumeration description of ActionType
Line 174: Line 174:
| multiPolygon
| multiPolygon
| MultiPolygon
| MultiPolygon
| [[#Api Model MultiPolygon|MultiPolygon]]
| [[MultiPolygon]]
|-
|-
| terrainTypeID
| terrainTypeID
Line 208: Line 208:
| multiPolygon
| multiPolygon
| MultiPolygon
| MultiPolygon
| [[#Api Model MultiPolygon|MultiPolygon]]
| [[MultiPolygon]]
|-
|-
| overlayIDs
| overlayIDs
Line 249: Line 249:
| multiPolygon
| multiPolygon
| MultiPolygon
| MultiPolygon
| [[#Api Model MultiPolygon|MultiPolygon]]
| [[MultiPolygon]]
|-
|-
| sidePolygon
| sidePolygon
| MultiPolygon
| MultiPolygon
| [[#Api Model MultiPolygon|MultiPolygon]]
| [[MultiPolygon]]
|-
|-
| topPolygon
| topPolygon
| MultiPolygon
| MultiPolygon
| [[#Api Model MultiPolygon|MultiPolygon]]
| [[MultiPolygon]]
|}
|}


Line 291: Line 291:
| center
| center
| Point
| Point
| [[#Api Model Point|Point]]
| [[Point]]
|-
|-
| clientActionEvents
| clientActionEvents
Line 505: Line 505:
| type
| type
| String
| String
| [[#Api Model MultiPolygon|MultiPolygon]]
| [[MultiPolygon]]
|-
|-
| coordinates
| coordinates
| double[][][][]
| double[][][][]
| array of [[#Api Model Polygon|Polygon]]s; [[#Api Model Polygon|Polygon]] is array of outer and optional inner rings; rings is array of coordinates; coordinates is array of [x,y,(optional) z]
| 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 522: Line 522:
| type
| type
| String
| String
| [[#Api Model Point|Point]]
| [[Point]]
|-
|-
| coordinates
| coordinates
Line 547: Line 547:
| innerPolygon
| innerPolygon
| MultiPolygon
| MultiPolygon
| [[#Api Model MultiPolygon|MultiPolygon]]
| [[MultiPolygon]]
|-
|-
| innerPrep
| innerPrep
Line 559: Line 559:
| outerPolygon
| outerPolygon
| MultiPolygon
| MultiPolygon
| [[#Api Model MultiPolygon|MultiPolygon]]
| [[MultiPolygon]]
|-
|-
| outerPrep
| outerPrep
Line 657: Line 657:
| multiPolygon
| multiPolygon
| MultiPolygon
| MultiPolygon
| [[#Api Model MultiPolygon|MultiPolygon]]
| [[MultiPolygon]]
|-
|-
| upgradeID
| upgradeID

Latest revision as of 07:44, 22 June 2026

API Endpoint: /api/session/items/measures/

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

Default Query: 

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

Example 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_TOKEN

Pseudo-Mercator: 

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

Degrees: 

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

Amersfoort / RD New: 

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

Local Coordinates: 

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

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

FOO: 

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

Show Queries

max version: 

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

size: 

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

Formats

HTML: 

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

JSON: 

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

GEOJSON: 

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

GPKG: 

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

DXF: 

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

CSV: 

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

SSV: 

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

SMILE: 

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

ZIPJSON: 

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

ZIPSMILE: 

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

Api Model ActionType

API Enumeration description of ActionType

Name Description
CONSTRUCTION_PLAN
CONSTRUCTION_PLAN_CANCEL

Api Model GeoTiffSpatial

API Model description of GeoTiffSpatial

Name Type Description
autoMP boolean
geoTiffIDs int[] Geo Tiffs ID
id int
multiPolygon 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 MultiPolygon
overlayIDs int[] Overlays 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 MultiPolygon
sidePolygon MultiPolygon MultiPolygon
topPolygon MultiPolygon 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[] Buildings ID
buildingPermitProcessed Set
center Point Point
clientActionEvents Map<ActionType,java.util.List<nl.tytech.data.core.item.CodedEvent>> Map<ActionType,java.util.List<nl.tytech.data.core.Item.CodedEvent>>
confirmationsRequired boolean
constructionCostsFixed double
constructionCostsM3 double
custom boolean
dependencyIDs int[] Measures ID
description String
geoTiffSpatials GeoTiffSpatial[] GeoTIFFSpatial[]
gridSpatials GridSpatial[] GridSpatial[]
id int
imageName String
imageVersion int
incomeFixed double
landOwnerPermissions Map<int,Boolean>
leveeSpatials LeveeSpatial[] Leveespatial[]
name String
ownerID int Stakeholder ID
serverActionEvents Map<ActionType,java.util.List<nl.tytech.data.core.item.CodedEvent>> Map<ActionType,java.util.List<nl.tytech.data.core.Item.CodedEvent>>
sourceIDs int[] Sources ID
state TimeState Timestate
terrainSpatials TerrainSpatial[] 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>> Map<ActionType,java.util.List<nl.tytech.data.core.Item.CodedEvent>>
confirmationsRequired boolean
constructionCostsFixed double
custom boolean
dependencyIDs int[] Measures 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>> Map<ActionType,java.util.List<nl.tytech.data.core.Item.CodedEvent>>
sourceIDs int[] Sources ID
state TimeState 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
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 Point

API Model description of Point

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

Api Model TerrainSpatial

API Model description of TerrainSpatial

Name Type Description
id int
innerHeight double
innerPolygon MultiPolygon MultiPolygon
innerPrep PreparedGeometry
measureEditType MeasureEditType MeasureEditType
outerPolygon MultiPolygon 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 MultiPolygon
upgradeID int Upgrade Type ID

See also

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