Api session items scenarios

Api session items Scenario Endpoints.

Edit items with event: editorscenario.

Default Query:

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

Example Response:

[ {
  "attributes" : null,
  "description" : "",
  "events" : [ ],
  "id" : 0,
  "limitNeighborhoodIDs" : [ ],
  "limitType" : "DEFAULT",
  "maquetteOverride" : null,
  "name" : "Scenario",
  "restartTestrun" : true,
  "version" : 2
} ]

Limit Queries

version=100:

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

Show Queries

max version:

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

size:

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

Scenarios (GeoJSON):

https://engine.tygron.com/web/scenarios.geojson?token=API_TOKEN

Formats

HTML:

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

JSON:

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

CSV:

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

SSV:

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

SMILE:

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

ZIPJSON:

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

ZIPSMILE:

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

Api Model ActionLog

API Model description of ActionLog

Name	Type	Description
action	ParticipantEventType
budget	double
buildingIDs	int[]
id	int
itemID	int
mapLink	MapLink
mp	MultiPolygon
point	Point
scoreAfter	Map<int,double>
scoreBefore	Map<int,double>
simTime	long
stakeholderID	int	Stakeholder ID
subject	String
version	int

Api Model ActionMenu

API Model description of ActionMenu

Name	Type	Description
attributeActionIDs	int[]	Attribute Action ID
buildable	Map<int,java.util.List<java.lang.Integer>>
color	TColor
eventBundleIDs	int[]	Event Bundle ID
functionIDs	int[]	Function ID
id	int
imageName	String
imageVersion	int
leveeIDs	int[]	Levee ID
measureIDs	int[]	Measure ID
name	String
sortIndex	int
specialOptions	Type[]
upgradeIDs	int[]	Upgrade Type ID
version	int

Api Model ActionType

API Enumeration description of ActionType

Name	Description
CONSTRUCTION_PLAN
CONSTRUCTION_PLAN_CANCEL

Api Model Addition

API Model description of Addition

Name	Type	Description
amount	int
animMultiplier	double
name	String
randomScale	double
show	Show

Api Model Address

API Model description of Address

Name	Type	Description
addition	String
attributes	Map<String,double[]>
id	int
letter	String
maquetteOverride	Map<String,double[]>
name	String
number	int
point	Point
sourceIDs	int[]	Source ID
street	String
surfaceSize	double
type	String
version	int
zipCode	String

Api Model AddressAttribute

API Enumeration description of AddressAttribute

Name	Description
ENERGY_LABEL
CADASTRAL_PURPOSE
RESIDENCE_TYPE
INHABITANTS
FLOOR_SPACE_M2

Api Model AeriusOverlay

API Model description of AeriusOverlay

Name	Type	Description
attributes	Map<String,double[]>
colorMultiplier	double
colorOffset	int
customLegend	boolean
id	int
imageName	String
imageVersion	int
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
name	String
parentID	int	Overlay ID
sortIndex	int
type	OverlayType
version	int
visible	boolean

Api Model Alignment

API Enumeration description of Alignment

Name	Description
ROAD
SPACED

Api Model Answer

API Model description of Answer

Name	Type	Description
clientEvents	CodedEvent[]
contents	String
events	CodedEvent[]
id	int
selected	boolean

Api Model Area

API Model description of Area

Name	Type	Description
attributes	Map<String,double[]>
center	Point
id	int
maquetteOverride	Map<String,double[]>
name	String
polygons	MultiPolygon
relations	Map<Relation,int>
sourceIDs	int[]	Source ID
version	int

Api Model AreaAttribute

API Enumeration description of AreaAttribute

Name	Description
ACTIVE
NATURE_RESERVE
INTEREST_AREA

Api Model AreaOverlay

API Model description of AreaOverlay

Name	Type	Description
areaIDs	int[]	Area ID
attributes	Map<String,double[]>
colorMultiplier	double
colorOffset	int
customLegend	boolean
id	int
imageName	String
imageVersion	int
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
name	String
parentID	int	Overlay ID
remainderColor	TColor
sortIndex	int
type	OverlayType
version	int
visible	boolean

Api Model AssetValue

API Enumeration description of AssetValue

Name	Description
NAME
DESCRIPTION
ID
IMAGELOCATION
ROOF_COLOR
BASEMENT_COLOR
GROUND_COLOR
EXTRA_COLOR
TOP_COLOR

Api Model AttributeItem

API Model description of AttributeItem

Name	Type	Description
attributes	Map<String,double[]>
id	int
maquetteOverride	Map<String,double[]>
name	String
version	int

Api Model AttributeKey

API Enumeration description of AttributeKey

Name	Description
A
B
C
D
E
F
G
H
I
J

Api Model AttributeOverlay

API Model description of AttributeOverlay

Name	Type	Description
attribute	String
attributeColor	TColor
attributes	Map<String,double[]>
colorAttribute	String
colorMultiplier	double
colorOffset	int
customLegend	boolean
id	int
imageName	String
imageVersion	int
legend	LegendEntry[]
mapLink	MapLink
maquetteOverride	Map<String,double[]>
name	String
parentID	int	Overlay ID
restColor	TColor
sortIndex	int
type	OverlayType
version	int
visible	boolean

Api Model AttributeOverlayPredicate

API Model description of AttributeOverlayPredicate

Name	Type	Description
attribute	String
mapLink	MapLink

Api Model AvgModelAttribute

API Enumeration description of AvgModelAttribute

Name	Description
DISTANCE_M
ATTRIBUTE_TIMEFRAMES
DEFAULT_VALUE
SURFACE_ONLY

Api Model AvgOverlay

API Model description of AvgOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
layerMapLink	MapLink
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
rasterization	Rasterization
resultType	String
showDifference	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model BGTFunctionLink

API Model description of BGTFunctionLink

Name	Type	Description
categories	Category[]
className	String
functionID	int	Function ID
id	int
layer	BGTLayer
priority	int
transmissionTowerFoundations	int
tree	boolean
typeName	String
version	int

Api Model BGTLayer

API Enumeration description of BGTLayer

Name	Description
BAK
BEGROEIDTERREINDEEL
BORD
BUURT
FUNCTIONEELGEBIED
GEBOUWINSTALLATIE
INSTALLATIE
KAST
KUNSTWERKDEEL
MAST
ONBEGROEIDTERREINDEEL
ONDERSTEUNENDWATERDEEL
ONDERSTEUNENDWEGDEEL
ONGECLASSIFICEERDOBJECT
OPENBARERUIMTE
OPENBARERUIMTELABEL
OVERBRUGGINGSDEEL
OVERIGBOUWWERK
OVERIGESCHEIDING
PAAL
PUBLIC
PAND
PLAATSBEPALINGSPUNT
PUT
SCHEIDING
SENSOR
SPOOR
STRAATMEUBILAIR
TUNNELDEEL
VEGETATIEOBJECT
WATERDEEL
WATERINRICHTINGSELEMENT
WEGDEEL
WEGINRICHTINGSELEMENT
WIJK

Api Model BGTTerrainLink

API Model description of BGTTerrainLink

Name	Type	Description
className	String
id	int
layer	BGTLayer
priority	int
terrainTypeID	int	Terrain Type ID
typeName	String
version	int

Api Model BaseAttribute

API Enumeration description of BaseAttribute

Name	Description
COLOR

Api Model BaseFunction

API Model description of BaseFunction

Name	Type	Description
attributes	Map<String,double[]>
categories	Category[]
constructionPeriods	ConstructionPeriod[]
decals	Map<FaceType,float[]>
defaults	Type[]
description	String
dimension	int
id	int
imageName	String
modelSetID	int	Model Set ID
name	String
placementType	PlacementType
regions	Region[]
textures	Map<FaceType,String>
version	int

Api Model BridgeElevation

API Enumeration description of BridgeElevation

Name	Description
LOWEST
TERRAIN
BRIDGE

Api Model Building

API Model description of Building

Name	Type	Description
addressIDs	int[]	Address ID
attributes	Map<String,double[]>
center	Point
customGeometries	CGLink[]
demolisherID	int	Stakeholder ID
functionID	int	Function ID
id	int
maquetteOverride	Map<String,double[]>
measureID	int	Measure ID
modelVersion	int
name	String
overrideCategories	Category[]
overrideDecals	Map<FaceType,float[]>
ownerID	int	Stakeholder ID
permitReceived	Map<int,Boolean>
predecessorID	int	Building ID
sections	Section[]
sourceIDs	int[]	Source ID
state	TimeState
upgradeID	int	Upgrade Type ID
upgradeOwnerID	int	Stakeholder ID
version	int

Api Model BuildingAttribute

API Enumeration description of BuildingAttribute

Name	Description
CONSTRUCTION_FINISH_DATE
POWER_LINE_BUILDING_ID
MODEL_ANGLE
POPULATION_DENSITY_M2
GEOMETRY_COLOR
VACANT
PRIVATE_YARD

Api Model CGLink

API Model description of CGLink

Name	Type	Description
geometryID	int	Custom Geometry ID
primary	boolean

Api Model Category

API Enumeration description of Category

Name	Description
SOCIAL
NORMAL
LUXE
ROAD
PAVED_AREA
EDUCATION
HEALTHCARE
PARK
NATURE
INDUSTRY
OFFICES
OTHER
SENIOR
UNDERGROUND
SHOPPING
AGRICULTURE
LEISURE
STUDENT
GARDEN
INTERSECTION
BRIDGE

Api Model CategoryZone

API Model description of CategoryZone

Name	Type	Description
allowedCategories	Category[]
attributes	Map<String,double[]>
center	Point
excelID	int	Excel Sheet ID
excelUpdated	boolean
id	int
maquetteOverride	Map<String,double[]>
name	String
outline	Outline
parentZoneID	int	Zone ID
permitterID	int	Stakeholder ID
polygons	MultiPolygon
sourceIDs	int[]	Source ID
version	int

Api Model ClimateModel

API Model description of ClimateModel

Name	Type	Description
endTemp	double
endYear	int
oxidation	double
soilTempFactor	double
startTemp	double
startYear	int

Api Model CodedEvent

API Model description of CodedEvent

Name	Type	Description
id	int
parameters	Object[]

Api Model ComboModelAttribute

API Enumeration description of ComboModelAttribute

Name	Description
ATTRIBUTE_DEFAULT_VALUE
ATTRIBUTE_SURFACE_ONLY

Api Model ComboOverlay

API Model description of ComboOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
formula	String
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
layerMapLink	MapLink
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
rasterization	Rasterization
resultType	String
showDifference	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model ConstructionPeriod

API Enumeration description of ConstructionPeriod

Name	Description
ANCIENT
CLASSIC
PRE_WAR
POST_WAR
CONTEMPORARY
FUTURISTIC

Api Model CoreStakeholder

API Model description of CoreStakeholder

Name	Type	Description
active	boolean
client	ClientData
color	TColor
id	int
lastSelected	long
name	String
version	int
webToken	String

Api Model CostType

API Enumeration description of CostType

Name	Description
CONSTRUCTION

Api Model CustomColorArea

API Model description of CustomColorArea

Name	Type	Description
color	TColor
name	String
polygons	MultiPolygon
zoneID	int

Api Model CustomGeometry

API Model description of CustomGeometry

Name	Type	Description
absoluteHeight	boolean
backFaceCulling	boolean
color	TColor
data	float[]
id	int
texture	String
version	int

Api Model DataType

API Enumeration description of DataType

Name	Description
FLOAT
DOUBLE
INT8
INT16
INT32
INT64
BOOL
STRING
UINT8
FLOAT16
BFLOAT16
UNKNOWN

Api Model DefaultAttribute

API Enumeration description of DefaultAttribute

Name	Description
ATTRIBUTE

Api Model DefaultNeuralNetwork

API Model description of DefaultNeuralNetwork

Name	Type	Description
attributes	Map<String,double[]>
description	String
id	int
legendEntries	LegendEntry[]
name	String
override	boolean
producer	String
tensors	Tensor[]
uploadDate	long
uploaderName	String
version	int
warnings	String

Api Model DefaultOverlay

API Model description of DefaultOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showDifference	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model DefaultRasterizationOverlay

API Model description of DefaultRasterizationOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
layerMapLink	MapLink
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
rasterization	Rasterization
resultType	String
showDifference	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model DefaultResult

API Enumeration description of DefaultResult

Name	Description
DEFAULT

Api Model DefaultSource

API Model description of DefaultSource

Name	Type	Description
color	TColor
date	long
description	String
id	int
infoUrl	String
name	String
uploaderName	String
version	int

Api Model DesignAttribute

API Enumeration description of DesignAttribute

Name	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 Detail

API Enumeration description of Detail

Name	Description
CONSTRUCTION_COST
DEMOLISH_COST
BUYOUT_COST
SELL_PRICE
SELLABLE_FLOORSPACE_M2
NUMBER_OF_HOUSES

Api Model DischargeMethod

API Enumeration description of DischargeMethod

Name	Description
HEIGHT_MINIMA
WATER_TERRAINS
AREAS

Api Model DistanceOverlay

API Model description of DistanceOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
layerMapLink	MapLink
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
rasterization	Rasterization
resultType	String
showDifference	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model DistanceResult

API Enumeration description of DistanceResult

Name	Description
ZONE
SIGHT

Api Model EmptyMultiPolygon

API Model description of EmptyMultiPolygon

Name	Type	Description

Api Model EnergyLabel

API Enumeration description of EnergyLabel

Name	Description
UNKNOWN
G
F
E
D
C
B
A0
A1
A2
A3
A4
A5

Api Model EventBundle

API Model description of EventBundle

Name	Type	Description
clientEvents	CodedEvent[]
compoundEventBundleIDs	int[]	Event Bundle ID
description	String
id	int
imageName	String
imageVersion	int
name	String
serverEvents	CodedEvent[]
version	int

Api Model Example

API Enumeration description of Example

Name	Description
CITY_NEIGHBORHOOD
URBAN_NEIGHBORHOOD
SUBURBAN_NEIGHBORHOOD
WINDMILL_AREA

Api Model ExcelPanel

API Model description of ExcelPanel

Name	Type	Description
answers	Answer[]
attributes	Map<String,double[]>
calcTimeMS	long
contentID	int
contentMapLink	MapLink
excelID	int	Excel Sheet ID
height	double
id	int
layoutX	double
layoutY	double
maquetteOverride	Map<String,double[]>
name	String
overlayID	int	Overlay ID
overrideDefaultAnswerID	int
parentID	int
point	Point
polygons	MultiPolygon
stakeholderID	int	Stakeholder ID
text	String
type	PanelType
updateTiming	Timing
version	int
warnings	String
width	double

Api Model FaceType

API Enumeration description of FaceType

Name	Description
BASEMENT
GROUND
EXTRA
TOP
ROOF

Api Model FloodingOverlay

API Model description of FloodingOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcInfo	String
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
mode	Mode
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showAreas	boolean
showDifference	boolean
showSystem	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String
weatherID	int	Weather ID

Api Model FunctionChangeGeoLink

API Model description of FunctionChangeGeoLink

Name	Type	Description
add	boolean
category	Category
featureAttributes	Map<String,java.util.List<java.lang.String>>
functionID	int	Function ID
id	int
priority	int
tree	boolean
update	boolean
version	int

Api Model FunctionOverlay

API Model description of FunctionOverlay

Name	Type	Description
attributes	Map<String,double[]>
colorMultiplier	double
colorOffset	int
customLegend	boolean
functionIDs	int[]	Function ID
functionsColor	TColor
id	int
imageName	String
imageVersion	int
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
name	String
parentID	int	Overlay ID
remainderColor	TColor
sortIndex	int
type	OverlayType
version	int
visible	boolean

Api Model FunctionOverride

API Model description of FunctionOverride

Name	Type	Description
attributes	Map<String,double[]>
categories	Category[]
description	String
id	int
imageName	String
imageVersion	int
maquetteOverride	Map<String,double[]>
name	String
version	int

Api Model FunctionType

API Enumeration description of FunctionType

Name	Description
ROAD
WATER
PARKING
SIDEWALK
BUILDING
GARDEN
PUBLIC_GREEN
REMAINDER

Api Model GasType

API Enumeration description of GasType

Name	Description
NOX
NO2

Api Model GeoFormat

API Enumeration description of GeoFormat

Name	Description
GEOJSON
GEOPACKAGE
WFS_JSON
WFS_GML
WMS_IMAGE
WCS_TIFF
OSM
BGT_GML
ESRI_JSON
ESRI_IMAGE
CYCLO_IMAGE
I3S
GEOTIFF
DXF

Api Model GeoTiffAttribute

API Enumeration description of GeoTiffAttribute

Name	Description
BAND

Api Model GeoTiffFeature

API Model description of GeoTiffFeature

Name	Type	Description
id	int
version	int

Api Model GeoTiffOverlay

API Model description of GeoTiffOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
geoTiffIDs	int[]	GeoTIFF ID
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showDifference	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model GeoTiffResult

API Enumeration description of GeoTiffResult

Name	Description
NEAREST
INTERPOLATED

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 Global

API Model description of Global

Name	Type	Description
actualValue	double[]
bookValueStakeholderID	int	Stakeholder ID
calcTimeMS	long
id	int
name	String
point	Point
previousValue	double[]
query	String
queryTiming	Timing
startValue	double[]
version	int
visualisationName	String

Api Model GlobalPanel

API Model description of GlobalPanel

Name	Type	Description
answers	Answer[]
attributes	Map<String,double[]>
globalIDs	int[]	Global ID
height	double
id	int
layoutX	double
layoutY	double
maquetteOverride	Map<String,double[]>
name	String
overlayID	int	Overlay ID
overrideDefaultAnswerID	int
point	Point
stakeholderID	int	Stakeholder ID
type	PanelType
version	int
width	double

Api Model GridFeature

API Model description of GridFeature

Name	Type	Description
id	int
version	int

Api Model GridModelAttribute

API Enumeration description of GridModelAttribute

Name	Description
ITERATION_ACTIVE
SKIP_NO_DATA
GPU_CLUSTER_INDEX

Api Model GridOverlay

API Model description of GridOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showDifference	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String

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 GroundwaterOverlay

API Model description of GroundwaterOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcInfo	String
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
mode	Mode
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showAreas	boolean
showDifference	boolean
showSystem	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String
weatherID	int	Weather ID

Api Model Group (SpecialOption)

API Enumeration description of Group

Name	Description
LAND
SCULPTING
FINANCE
DEMOLISH

Api Model HeatDpraAttribute

API Enumeration description of HeatDpraAttribute

Name	Description
DATES
DAILY_AVG_RADIATION
DAILY_TEMPERATURE_MAX
DAILY_TEMPERATURE_MIN
EXCLUDE_BUILDINGS
EXCLUDE_WATER
EXCLUDE_FOLIAGE_HEIGHT_M
FOLIAGE_AREAS
HOURLY_RADIATION
HOURLY_TEMPERATURE
HOURLY_HUMIDITY
SUN_ALTITUDE
SUN_AZIMUTH
SUN_DAILY_MOTION
WIND_DIRECTION
WIND_SPEED
DAILY_AVG_WIND_SPEED
MAX_SHADOW_DISTANCE
MAX_TRUNK_DISTANCE
WIND_DECLINE_ANGLE

Api Model HeatKey

API Enumeration description of HeatKey

Name	Description
FOLIAGE_HEIGHT

Api Model HeatModel

API Enumeration description of HeatModel

Name	Description
UNESCO
DPRA

Api Model HeatOverlay

API Model description of HeatOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcInfo	String
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
model	HeatModel
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showDifference	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model HeatPrequel

API Enumeration description of HeatPrequel

Name	Description
FOLIAGE_HEIGHT
BUILDING_ELEVATION
TERRAIN_ELEVATION

Api Model HeatResult

API Enumeration description of HeatResult

Name	Description
BOWEN_RATIO
FOLIAGE
PET
PET_RELATIVE
SHADE
SKY_VIEW
SKY_VIEW_AVG
TEMPERATURE_ATMOSPHERE
UHI
VEGETATION
VEGETATION_AVG
WIND_SPEED

Api Model HeightAttribute

API Enumeration description of HeightAttribute

Name	Description
ZONING_PERMIT_REQUIRED

Api Model HeightOperator

API Enumeration description of HeightOperator

Name	Description
AVG
MIN
MAX
VOLUME
STDEV
AREA

Api Model HeightOverlay

API Model description of HeightOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showDifference	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model HeightResult

API Enumeration description of HeightResult

Name	Description
DSM
DTM
FLOORS

Api Model HeightSector

API Model description of HeightSector

Name	Type	Description
changed	Boolean
envelope	Envelope
id	int
name	String
pointAreaM2	double
pointWidth	int[]
sourceIDs	int[]	Source ID
square	MultiPolygon
version	int

Api Model HeightSquare

API Model description of HeightSquare

Name	Type	Description
x	double
xMax	double
xMin	double
y	double
yMax	double
yMin	double

Api Model ImageAttribute

API Enumeration description of ImageAttribute

Name	Description
ALPHA

Api Model ImageOverlay

API Model description of ImageOverlay

Name	Type	Description
attributes	Map<String,double[]>
colorMultiplier	double
colorOffset	int
customLegend	boolean
id	int
imageName	String
imageNames	String[]
imageVersion	int
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
name	String
parentID	int	Overlay ID
sortIndex	int
type	OverlayType
version	int
visible	boolean

Api Model Indicator

API Model description of Indicator

Name	Type	Description
absolute	boolean
attributes	Map<String,double[]>
calcTimeMS	long
currentExplanation	String
description	String
exactNumberValues	Map<MapType,double>
exactTextValues	Map<MapType,String>
excelID	int	Excel Sheet ID
excelUpdated	boolean
id	int
imageName	String
imageVersion	int
isActive	boolean
mapTypeValues	Map<MapType,double>
maquetteExplanation	String
maquetteOverride	Map<String,double[]>
name	String
parentID	int	Indicator ID
shortName	String
sortIndex	int
stakeholderID	int	Stakeholder ID
targetDescriptions	String[]
targets	Map<int,double[]>
updateTiming	Timing
version	int
warnings	String

Api Model IndicatorAttribute

API Enumeration description of IndicatorAttribute

Name	Description
FINANCE

Api Model InferenceAttribute

API Enumeration description of InferenceAttribute

Name	Description
MASK_THRESHOLD
SCORE_THRESHOLD
INFERENCE_MODE
STRIDE_FRACTION
BOX_OVERLAP
PRIORITIZE_LABELS
GPU_MEMORY_MB

Api Model InferenceMode

API Enumeration description of InferenceMode

Name	Description
CLASSIFICATION
BBOX_DETECTION

Api Model InferenceOverlay

API Model description of InferenceOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
neuralNetworkID	int	Neural Network ID
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showDifference	boolean
sortIndex	int
tensorLinks	TensorLink[]
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model InferencePrequel

API Enumeration description of InferencePrequel

Name	Description
A
B
C

Api Model InferenceResult

API Enumeration description of InferenceResult

Name	Description
LABELS
SCORES
BOXES
MASKS
DEBUG_GT_INSTANCES
CENTER_POINTS

Api Model Input

API Enumeration description of Input

Name	Description
A
B
C
D
E
F
G
H
I
J

Api Model InstanceColor

API Enumeration description of InstanceColor

Name	Description
GRAY
WHITE
VEGIE_GREEN
GRAIN_YELLOW
FLOWERS

Api Model Item

API Model description of Item

Name	Type	Description
id	int
version	int

Api Model ItemMeasurement

API Model description of ItemMeasurement

Name	Type	Description
id	int
itemID	int
key	String
mapLink	MapLink
maqMax	double
maqMin	double
max	double
min	double
name	String
overlayIDs	int[]	Overlay ID
overlayMaqValues	Map<int,float[]>
overlayValues	Map<int,float[]>
point	Point
save	boolean
sourceIDs	int[]	Source ID
sum	boolean
version	int

Api Model IterationAttribute

API Enumeration description of IterationAttribute

Name	Description
MODULUS
TIMEFRAME_TIMES

Api Model IterationOverlay

API Model description of IterationOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showDifference	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model IterationPrequel

API Enumeration description of IterationPrequel

Name	Description
ITERATION

Api Model Layer

API Enumeration description of Layer

Name	Description
BRIDGE
SURFACE
UNDERGROUND

Api Model LegendEntry

API Model description of LegendEntry

Name	Type	Description
color	TColor
entryName	String
id	int
value	float

Api Model LeveeFeature

API Model description of LeveeFeature

Name	Type	Description
id	int
version	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 LimitType

API Enumeration description of LimitType

Name	Description
DEFAULT
NEIGHBORHOODS
MEASURE_NEIGHBORHOODS

Api Model LineMeasurement

API Model description of LineMeasurement

Name	Type	Description
distances	double[]
id	int
lineSegment	LineSegment
lineString	LineString
maqMax	double
maqMin	double
maqValues	Map<int,java.util.ArrayList<float[]>>
max	double
min	double
name	String
overlayIDs	int[]	Overlay ID
save	boolean
sourceIDs	int[]	Source ID
sum	boolean
values	Map<int,java.util.ArrayList<float[]>>
version	int

Api Model LineString

API Model description of LineString

Name	Type	Description

Api Model LoadAttribute

API Enumeration description of LoadAttribute

Name	Description
CONNECTION_COST
FLOW
POWER
CONNECTION_COUNT
FLOOR_SPACE_M2
TYPE
ROOT_LOAD
LOAD_COUNT
ADDRESS_COUNT
CONNECTION_FRACTION
PRESSURE_M_H2O_SUPPLY
PRESSURE_M_H2O_RETURN
TEMPERATURE_SUPPLY_DEGREES_CELSIUS

Api Model LoadCostSegment

API Model description of LoadCostSegment

Name	Type	Description
baseCost	double
incrCost	double
minValue	int

Api Model LoadParameterType

API Enumeration description of LoadParameterType

Name	Description
FLOW
POWER
CONNECTION_COST
CONNECTION
FLOOR_SPACE_M2

Api Model LoadType

API Enumeration description of LoadType

Name	Description
UNKNOWN
COLLECTIVE
COLLECTIVE_TAP
COLLECTIVE_RADIATOR
COLLECTIVE_RADIATOR_TAP
INDIVIDUAL
LARGE_SCALE_CONSUMER

Api Model LogicPanel

API Model description of LogicPanel

Name	Type	Description
answers	Answer[]
attributes	Map<String,double[]>
calcTimeMS	long
contentID	int
contentMapLink	MapLink
height	double
id	int
layoutX	double
layoutY	double
maquetteOverride	Map<String,double[]>
name	String
overlayID	int	Overlay ID
overrideDefaultAnswerID	int
parentID	int
point	Point
stakeholderID	int	Stakeholder ID
text	String
type	PanelType
updateTiming	Timing
version	int
warnings	String
width	double

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 MapType

API Enumeration description of MapType

Name	Description
CURRENT
MAQUETTE

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 Method

API Enumeration description of Method

Name	Description
GET
POST

Api Model MinMax

API Enumeration description of MinMax

Name	Description
NEVER
LARGE_CELL
ALWAYS

Api Model Mode

API Enumeration description of Mode

Name	Description
SPEED
AVERAGE
ACCURACY

Api Model ModelData

API Model description of ModelData

Name	Type	Description
additions	Addition[]
animMultiplier	double
buffer	int
dimension	int
frequency	int
id	int
instanceColor	InstanceColor
isAlpha	boolean
isShowCloseby	boolean
modelHeight	double
modelWidth	double
name	String
particleEmitters	ParticleEmitterCoordinatePair[]
placement	Placement
randomScale	double
roots	boolean
rotation	Rotation
show	Show
variation	int
version	int

Api Model ModelStyle

API Enumeration description of ModelStyle

Name	Description
WIREFRAME
PLAIN
COLORED
TEXTURED
DISCO

Api Model MultiLineString

API Model description of MultiLineString

Name	Type	Description

Api Model MultiPolygon

API Model description of MultiPolygon

Name	Type	Description

Api Model NO2Overlay

API Model description of NO2Overlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showDifference	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model NO2Result

API Enumeration description of NO2Result

Name	Description
CONCENTRATION
EMISSION_NO2
EMISSION_NOX
TREEFACTOR
TREES

Api Model NeighborPredicate

API Model description of NeighborPredicate

Name	Type	Description
me	Building

Api Model Neighborhood

API Model description of Neighborhood

Name	Type	Description
attributes	Map<String,double[]>
center	Point
id	int
maquetteOverride	Map<String,double[]>
municipalityID	int	Stakeholder ID
name	String
polygons	MultiPolygon
sourceIDs	int[]	Source ID
version	int

Api Model NeighborhoodAttribute

API Enumeration description of NeighborhoodAttribute

Name	Description
URBANIZATION
INHABITANTS
ACTIVE

Api Model NetFunction

API Model description of NetFunction

Name	Type	Description
attributes	Map<String,double[]>
diameterM	double
groupName	String
id	int
maquetteOverride	Map<String,double[]>
name	String
netType	NetType
priceM	double
sourceIDs	int[]	Source ID
version	int

Api Model NetLine

API Model description of NetLine

Name	Type	Description
attributes	Map<String,double[]>
endNodeID	int	Net Node ID
functionID	int	Net Function ID
id	int
maquetteOverride	Map<String,double[]>
name	String
sourceIDs	int[]	Source ID
startNodeID	int	Net Node ID
version	int

Api Model NetLineAttribute

API Enumeration description of NetLineAttribute

Name	Description
FLOW
DIAMETER_M
ALWAYS_ACTIVE

Api Model NetLineFunctionAttribute

API Enumeration description of NetLineFunctionAttribute

Name	Description
PRICE_M
VISUALIZATION_DIAMETER_M
DIAMETER_M
COLOR

Api Model NetLoad

API Model description of NetLoad

Name	Type	Description
addressIDs	int[]	Address ID
attributes	Map<String,double[]>
buildingID	int	Building ID
clusterID	int	Net Cluster ID
connectionState	TimeState
id	int
maquetteOverride	Map<String,double[]>
name	String
netType	NetType
nodeID	int	Net Node ID
point	Point
sourceIDs	int[]	Source ID
version	int

Api Model NetNode

API Model description of NetNode

Name	Type	Description
connectedLineIDs	int[]
id	int
loadIDs	int[]
name	String
point	Point
sourceIDs	int[]	Source ID
version	int

Api Model NetOverlay

API Model description of NetOverlay

Name	Type	Description
attributes	Map<String,double[]>
colorMultiplier	double
colorOffset	int
customLegend	boolean
id	int
imageName	String
imageVersion	int
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
name	String
netType	NetType
parentID	int	Overlay ID
showActive	boolean
showNetwork	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean

Api Model NetType

API Enumeration description of NetType

Name	Description
ELECTRICITY
GAS
HEAT
INTERNET
SEWER

Api Model NeuralNetwork

API Model description of NeuralNetwork

Name	Type	Description
attributes	Map<String,double[]>
description	String
id	int
legendEntries	LegendEntry[]
name	String
producer	String
tensors	Tensor[]
uploadDate	long
uploaderName	String
version	int
warnings	String

Api Model NeuralNetworkAttribute

API Enumeration description of NeuralNetworkAttribute

Name	Description
MIN_CELL_SIZE_M
MAX_CELL_SIZE_M
MAX_GT_INSTANCES
VERSION

Api Model NoPrequel

API Enumeration description of NoPrequel

Name	Description

Api Model NoiseOverlay

API Model description of NoiseOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showDifference	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model NoiseResult

API Enumeration description of NoiseResult

Name	Description
NOISE_DB
EMISSION

Api Model Operator (AvgOverlay)

API Enumeration description of Operator

Name	Description
AVG
AVG_INTERPOLATED
MAX
MIN

Api Model Operator (ComboOverlay)

API Enumeration description of Operator

Name	Description
SIN
COS
TAN
ASIN
ACOS
ATAN
SQRT
ROUND
FLOOR
CEIL
ABS
EXP
LN
LOG
RANDOM
ERF
GTE
GT
LTE
LT
NEQ
EQ
IF
AND
OR
SWITCH
ADD
MUL
DIV
SUB
MAX
MIN
AVG
POW
PERCENTILE
AVG_GTE_PERCENTILE
AVG_LTE_PERCENTILE
COLOR
RED
GREEN
BLUE
ALPHA

Api Model Outline

API Enumeration description of Outline

Name	Description
NONE
SIMPLE
DASHED

Api Model Overlay

API Model description of Overlay

Name	Type	Description
attributes	Map<String,double[]>
colorMultiplier	double
colorOffset	int
customLegend	boolean
id	int
imageName	String
imageVersion	int
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
name	String
parentID	int	Overlay ID
sortIndex	int
type	OverlayType
version	int
visible	boolean

Api Model OverlayCategory

API Enumeration description of OverlayCategory

Name	Description
ADMINISTRATIVE
ENVIRONMENTAL
WATER
GRID_CALCULATION
GEO_DATA
TOPOGRAPHY
NETWORKS

Api Model OverlayType

API Enumeration description of OverlayType

Name	Description
OWNERSHIP
OWNERSHIP_GRID
ZIP_CODES
ZONING
NEIGHBORHOODS
MUNICIPALITIES
SCENARIO
VACANCY
HEAT_STRESS
SHADOW
TRAFFIC_DENSITY
TRAFFIC_NO2
TRAFFIC_NOISE
LIVABILITY
AERIUS
RAINFALL
FLOODING
GROUNDWATER
WATERSHED
SUBSIDENCE
WATERWIJZER
AVG
COMBO
DISTANCE
SIGHT_DISTANCE
TRAVEL_DISTANCE
INFERENCE
ITERATION
GEO_TIFF
WMS
WCS
IMAGE
AREA
ATTRIBUTE
FUNCTION
SATELLITE
HEIGHTMAP
UNDERGROUND
SOURCE
NETWORK_OWNERSHIP
NETWORK_OVERVIEW
NETWORK_DISTANCE
RESULT_CHILD
TEST
DISTURBANCE_DISTANCE
SAFETY_DISTANCE
DEPRECATED

Api Model PDResult

API Model description of PDResult

Name	Type	Description
areaExisting	Map<FunctionType,double>
bandMPs	Map<FunctionType,java.util.Map<java.lang.Integer, java.util.List<org.locationtech.jts.geom.MultiPolygon>>>
detailMPs	Map<FunctionType,java.util.Map<java.lang.Integer, java.util.List<org.locationtech.jts.geom.MultiPolygon>>>

Api Model Panel

API Model description of Panel

Name	Type	Description
answers	Answer[]
attributes	Map<String,double[]>
height	double
id	int
layoutX	double
layoutY	double
maquetteOverride	Map<String,double[]>
name	String
overlayID	int	Overlay ID
overrideDefaultAnswerID	int
point	Point
stakeholderID	int	Stakeholder ID
type	PanelType
version	int
width	double

Api Model PanelAttribute

API Enumeration description of PanelAttribute

Name	Description
VISIBLE
REFRESH
VISIBLE_TIMEFRAME
ATTENTION
SCALE
POPUP_TYPE

Api Model PanelTemplate

API Enumeration description of PanelTemplate

Name	Description
TRAFFIC_NOISE
DANGEROUS_OBJECTS
NETWORK_INTERACTION
WATER_AREAS
WEIRS

Api Model PanelType

API Enumeration description of PanelType

Name	Description
GLOBAL_PANEL
EXCEL_PANEL
WEB_PANEL
TEXT_PANEL
TEMPLATE_EXCEL_PANEL
TEMPLATE_TEXT_PANEL

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 ParticleEmitterCoordinatePair

API Model description of ParticleEmitterCoordinatePair

Name	Type	Description
id	int
offsetCoordinate	double[]
particleEmitterID	int	Particle Emitter ID

Api Model Placement

API Enumeration description of Placement

Name	Description
POINT
EDGE

Api Model PlacementType

API Enumeration description of PlacementType

Name	Description
WATER
LAND
HYBRID

Api Model Plot

API Model description of Plot

Name	Type	Description
center	Point
id	int
name	String
ownerID	int	Stakeholder ID
polygons	MultiPolygon
sourceIDs	int[]	Source ID
version	int

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 PlotDesignAttribute

API Enumeration description of PlotDesignAttribute

Name	Description
AREA_M2
WIDTH_M
SIDE_DISTANCE_M
ROAD_DISTANCE_M
UNITS
FLOORS
FLOOR_HEIGHT_M
FIT_FRACTION
FRACTION

Api Model Point

API Model description of Point

Name	Type	Description

Api Model PointMeasurement

API Model description of PointMeasurement

Name	Type	Description
id	int
maqMax	double
maqMin	double
max	double
min	double
name	String
overlayIDs	int[]	Overlay ID
overlayMaqValues	Map<int,float[]>
overlayValues	Map<int,float[]>
point	Point
save	boolean
sourceIDs	int[]	Source ID
sum	boolean
version	int

Api Model PolygonAttributeItem

API Model description of PolygonAttributeItem

Name	Type	Description
attributes	Map<String,double[]>
center	Point
id	int
maquetteOverride	Map<String,double[]>
name	String
polygons	MultiPolygon
sourceIDs	int[]	Source ID
version	int

Api Model PopupData

API Model description of PopupData

Name	Type	Description
answers	Answer[]
calendar	long
color	TColor
id	int
imageType	PopupImageType
linkID	int
linkType	MapLink
modelDataID	int	Model Data ID
modelType	PopupModelType
name	String
opensAutomatically	boolean
overrideAttention	Boolean
point	Point
polygons	MultiPolygon
scale	double
text	String
title	String
type	Type
version	int
visibleForStakeholderIDs	int[]	Stakeholder ID
visibleTimeframe	int

Api Model PopupImageType

API Enumeration description of PopupImageType

Name	Description
PICK_DATE
REQUEST_PERMIT
RECEIVE_REQUEST
WAITING
DECLINE
APPROVE
WAIT_BUILD
WAIT_DEMOLISH
BUILD_PROGRESS
DEMOLISH_PROGRESS
BUY_LAND
SELL_LAND

Api Model PopupModelType

API Enumeration description of PopupModelType

Name	Description
APPROVED
ARROW
BUY
CONNECT_ON
CONNECT_OFF
CONSTRUCTING
ELEVATION
DECLINED
DEMOLISHING
WAITING
QUESTION_MARK
TRAFFIC_NOISE
WATER_CRANE
WATER_ARROW
WATER_WEIR
LIGHT_BULB
LIGHTNING
BAR_CHART
EXCLAMATION

Api Model RainOverlay

API Model description of RainOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcInfo	String
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
mode	Mode
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showAreas	boolean
showDifference	boolean
showSystem	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String
weatherID	int	Weather ID

Api Model Rasterization

API Enumeration description of Rasterization

Name	Description
FIRST
MIN
MAX
SINGLE_LAYER
GRID

Api Model RasterizationMethod

API Enumeration description of RasterizationMethod

Name	Description
COMBINED
OUTLINE
CENTER

Api Model RasterizationOverlay

API Model description of RasterizationOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
layerMapLink	MapLink
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
rasterization	Rasterization
resultType	String
showDifference	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model RasterizationPrequel

API Enumeration description of RasterizationPrequel

Name	Description
INPUT

Api Model Region

API Enumeration description of Region

Name	Description
NORTH_AMERICA
NORTHWESTERN_EUROPE
ASIA
AFRICA
OTHER

Api Model Relation

API Enumeration description of Relation

Name	Description
OWNER
CONSTRUCTOR
DEMOLISHER
PERMITTER
SENDER
RECEIVER
NETOWNER
BORDER_A
BORDER_B
BUILDING
WEATHER
PARENT
RESULT_PARENT

Api Model ResidenceType (Address)

API Enumeration description of ResidenceType

Name	Description
UNKNOWN
DETACHED
SEMI_DETACHED
PORCH
TERRACED_BETWEEN
TERRACED_CORNER
TINY
GALLERY_HOUSE
FLAT
APARTMENT
CARAVAN
HOUSE_BOAT_BERTH
HOUSE_BOAT_NEW_BERTH
SHARED_HOUSE
ACCOMMODATION

Api Model ResultChildOverlay

API Model description of ResultChildOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showDifference	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model ResultParentOverlay

API Model description of ResultParentOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showDifference	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model Rotation

API Enumeration description of Rotation

Name	Description
FIXED
QUARTER
FREE

Api Model SWRC

API Enumeration description of SWRC

Name	Description
NONE
VAN_GENUCHTEN

Api Model SatelliteOverlay

API Model description of SatelliteOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showDifference	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model Scenario

API Model description of Scenario

Name	Type	Description
attributes	Map<String,double[]>
description	String
events	CodedEvent[]
id	int
limitNeighborhoodIDs	int[]	Neighborhood ID
limitType	LimitType
maquetteOverride	Map<String,double[]>
name	String
restartTestrun	boolean
version	int

Api Model ScenarioAttribute

API Enumeration description of ScenarioAttribute

Name	Description
LIMIT_MARGIN
INDICATORS

Api Model Scope

API Enumeration description of Scope

Name	Description
MAP
WATER_AREAS
LIMIT_AREAS
OVERRIDE_RAIN_AREAS

Api Model Section

API Model description of Section

Name	Type	Description
floors	int
id	int
outerLines	MultiLineString
polygons	MultiPolygon
roofHeightM	double
roofPolygons	GeometryCollection
roofShape	float[]
skeletonEnd	Point
skeletonLines	MultiLineString
skeletonStart	Point
slantingRoofHeightM	double

Api Model ServiceOverlay

API Model description of ServiceOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
crs	String
customLegend	boolean
diffLegend	LegendEntry[]
forceXY	boolean
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
layerName	String
layerNames	String[]
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showDifference	boolean
sortIndex	int
sourceID	int	Source ID
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model ServiceSource

API Model description of ServiceSource

Name	Type	Description
color	TColor
date	long
description	String
format	GeoFormat
id	int
infoUrl	String
name	String
uploaderName	String
url	String
version	int

Api Model ShadowAttribute

API Enumeration description of ShadowAttribute

Name	Description
DATES
SUN_ALTITUDE
SUN_AZIMUTH
MAX_SHADOW_DISTANCE
MAX_FOLIAGE_RADIUS

Api Model ShadowOverlay

API Model description of ShadowOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcInfo	String
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showDifference	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model ShadowPrequel

API Enumeration description of ShadowPrequel

Name	Description
FOLIAGE_HEIGHT
BUILDING_ELEVATION
TERRAIN_ELEVATION

Api Model ShadowResult

API Enumeration description of ShadowResult

Name	Description
SHADE
FOLIAGE

Api Model Shoreline

API Enumeration description of Shoreline

Name	Description
NONE
ONE_CELL
TWO_CELLS

Api Model Show

API Enumeration description of Show

Name	Description
FAR
MIDDLE
CLOSE

Api Model SightDistanceAttribute

API Enumeration description of SightDistanceAttribute

Name	Description
SOURCE_HEIGHT_M
OBSERVER_HEIGHT_M
ATTRIBUTE_TIMEFRAMES

Api Model SourceOverlay

API Model description of SourceOverlay

Name	Type	Description
attributes	Map<String,double[]>
colorMultiplier	double
colorOffset	int
customLegend	boolean
id	int
imageName	String
imageVersion	int
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
name	String
parentID	int	Overlay ID
restColor	TColor
sortIndex	int
sources	Map<int,int>
type	OverlayType
version	int
visible	boolean

Api Model SpecialEffect

API Model description of SpecialEffect

Name	Type	Description
active	boolean
id	int
name	String
particleEmitters	ParticleEmitterCoordinatePair[]
point	Point
version	int

Api Model SpecialOption

API Model description of SpecialOption

Name	Type	Description
defaults	Type[]
description	String
id	int
imageName	String
name	String
version	int

Api Model Stakeholder

API Model description of Stakeholder

Name	Type	Description
active	boolean
client	ClientData
color	TColor
id	int
imageName	String
imageVersion	int
lastSelected	long
name	String
shortName	String
startBudget	double
startBudgets	Map<int,double>
startCinematics	Map<int,int>
startPoint	Point
type	Type
version	int
webToken	String

Api Model Style

API Enumeration description of Style

Name	Description
INTERPOLATED
NEAREST
ARROW
COLOR
FLOAT32
DIFFERENCE

Api Model SubsidenceAttribute

API Enumeration description of SubsidenceAttribute

Name	Description
YEARS
YEARS_PER_TIMEFRAME
START_YEAR
A
B
C
ACTIVE_DRAINAGE_FACTOR
PASSIVE_DRAINAGE_FACTOR
CLIMATE_START_TEMP
CLIMATE_FINAL_TEMP
CLIMATE_START_YEAR
CLIMATE_FINAL_YEAR
CLIMATE_OXIDATION
CLIMATE_SOIL_TEMP_FACTOR
LOW_PASSIVE_DRAINAGE
HI_PASSIVE_DRAINAGE
DEFAULT_PEAT_FRACTION
DEFAULT_TOP_LAYER_THICKNESS
DEFAULT_CLAY_THICKNESS
INUNDATE_LAND_BELOW_WATER_LEVEL

Api Model SubsidenceKey

API Enumeration description of SubsidenceKey

Name	Description
WATER_LEVEL
WATER_LEVEL_OUTPUT
CLAY_THICKNESS
INDEXATION
PEAT_FRACTION
TOPLAYER_THICKNESS
SUBSIDENCE
DRAINAGE
HI_GROUND_WATER_LEVEL
LOW_GROUND_WATER_LEVEL

Api Model SubsidenceOverlay

API Model description of SubsidenceOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showDifference	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model SubsidencePrequel

API Enumeration description of SubsidencePrequel

Name	Description
LOW_GROUND_WATER
HIGH_GROUND_WATER
CLAY_THICKNESS

Api Model SubsidenceResult

API Enumeration description of SubsidenceResult

Name	Description
SUBSIDENCE
OXIDATION
SETTLEMENT
LOW_GROUND_WATER
HI_GROUND_WATER

Api Model SurfaceMode

API Enumeration description of SurfaceMode

Name	Description
NONE
SHALLOW
AVG_WATERWAY
HYBRID
AVG_TERRAIN

Api Model TColor

API Model description of TColor

Name	Type	Description

Api Model TemplateExcelPanel

API Model description of TemplateExcelPanel

Name	Type	Description
answers	Answer[]
attribute	String
attributes	Map<String,double[]>
autoApplied	boolean
calcTimeMS	long
contentID	int
contentMapLink	MapLink
excelID	int	Excel Sheet ID
height	double
id	int
layoutX	double
layoutY	double
mapLink	MapLink
maquetteOverride	Map<String,double[]>
name	String
overlayID	int	Overlay ID
overrideDefaultAnswerID	int
parentID	int
point	Point
polygons	MultiPolygon
relation	Relation
stakeholderID	int	Stakeholder ID
text	String
type	PanelType
updateTiming	Timing
useOwner	boolean
version	int
warnings	String
width	double

Api Model TemplateTextPanel

API Model description of TemplateTextPanel

Name	Type	Description
answers	Answer[]
attribute	String
attributes	Map<String,double[]>
autoApplied	boolean
calcTimeMS	long
contentID	int
contentMapLink	MapLink
height	double
id	int
layoutX	double
layoutY	double
mapLink	MapLink
maquetteOverride	Map<String,double[]>
name	String
overlayID	int	Overlay ID
overrideDefaultAnswerID	int
parentID	int
point	Point
relation	Relation
stakeholderID	int	Stakeholder ID
text	String
type	PanelType
updateTiming	Timing
useOwner	boolean
version	int
warnings	String
width	double

Api Model Tensor

API Model description of Tensor

Name	Type	Description
dimensions	int[]
input	boolean
name	String
normalize	boolean
type	DataType

Api Model TensorLink

API Model description of TensorLink

Name	Type	Description
coordinate	int[]
id	int
normalized	boolean
prequel	String
result	String
tensorName	String
valueType	ValueType

Api Model Terrain

API Model description of Terrain

Name	Type	Description
current	MultiPolygon
heightValuesCurrent	double[]
heightValuesMaquette	double[]
id	int
maquette	MultiPolygon
name	String
showSatellite	boolean
sourceIDs	int[]	Source ID
typeID	int	Terrain Type ID
version	int

Api Model TerrainAttribute

API Enumeration description of TerrainAttribute

Name	Description
ANGLE_OF_REPOSE
WATER_DEPTH_M
BOWEN_RATIO
BUILDABLE
SUBSIDENCE
COLOR
HEAT_EFFECT
LIVABILITY_EFFECT
TERRAIN_MIX
TEXTURE_TYPE
WATER
GROUND_INFILTRATION_MD
HYDRAULIC_CONDUCTIVITY_MD
HYDRAULIC_CONDUCTIVITY_WITH_THICKNESS_MD
VAN_GENUCHTEN_M
ROOT_DEPTH_M
VEGETATION_FRACTION
WATER_STORAGE_PERCENTAGE
WATER_MANNING
WATER_MICRORELIEF_M
WATER_TRANSPIRATION_FACTOR

Api Model TerrainFeature

API Model description of TerrainFeature

Name	Type	Description
id	int
this$0	TerrainSpatial
version	int

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 TerrainType

API Model description of TerrainType

Name	Type	Description
attributes	Map<String,double[]>
code	String
groundLayerType	Layer
id	int
imageName	String
maquetteOverride	Map<String,double[]>
name	String
parentID	int	Terrain Type ID
version	int

Api Model TextPanel

API Model description of TextPanel

Name	Type	Description
answers	Answer[]
attributes	Map<String,double[]>
calcTimeMS	long
contentID	int
contentMapLink	MapLink
height	double
id	int
layoutX	double
layoutY	double
maquetteOverride	Map<String,double[]>
name	String
overlayID	int	Overlay ID
overrideDefaultAnswerID	int
parentID	int
point	Point
stakeholderID	int	Stakeholder ID
text	String
type	PanelType
updateTiming	Timing
version	int
warnings	String
width	double

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 Timing

API Enumeration description of Timing

Name	Description
BEFORE
AFTER

Api Model TrafficAttribute

API Enumeration description of TrafficAttribute

Name	Description
HOURS
CARS_ACTIVE
VANS_ACTIVE
TRUCKS_ACTIVE
BUSES_ACTIVE

Api Model TrafficDensityOverlay

API Model description of TrafficDensityOverlay

Name	Type	Description
attributes	Map<String,double[]>
colorMultiplier	double
colorOffset	int
customLegend	boolean
id	int
imageName	String
imageVersion	int
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
name	String
parentID	int	Overlay ID
sortIndex	int
type	OverlayType
version	int
visible	boolean

Api Model TrafficNO2Attribute

API Enumeration description of TrafficNO2Attribute

Name	Description
BASE_O3
BASE_NO2
EMISSION_CAR_NOX
EMISSION_CAR_NO2
EMISSION_JAM_CAR_NOX
EMISSION_JAM_CAR_NO2
EMISSION_VAN_NOX
EMISSION_VAN_NO2
EMISSION_JAM_VAN_NOX
EMISSION_JAM_VAN_NO2
EMISSION_TRUCK_NOX
EMISSION_TRUCK_NO2
EMISSION_JAM_TRUCK_NOX
EMISSION_JAM_TRUCK_NO2
EMISSION_BUS_NOX
EMISSION_BUS_NO2
EMISSION_JAM_BUS_NOX
EMISSION_JAM_BUS_NO2
ROAD1_30M_A
ROAD1_30M_B
ROAD1_30M_C
ROAD1_60M_ALPHA
ROAD1_60M_POWER
MIN_TREE_HEIGHT_M

Api Model TrafficNoiseAttribute

API Enumeration description of TrafficNoiseAttribute

Name	Description
BACKGROUND_DB
V0_CAR
V0_VAN
V0_TRUCK
V0_BUS
EMISSION_START_CAR
EMISSION_START_VAN
EMISSION_START_TRUCK
EMISSION_START_BUS
EMISSION_MULT_CAR
EMISSION_MULT_VAN
EMISSION_MULT_TRUCK
EMISSION_MULT_BUS

Api Model TrafficOverlay

API Model description of TrafficOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showDifference	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model TrafficType

API Enumeration description of TrafficType

Name	Description
CAR
VAN
TRUCK
BUS
BICYCLE
PEDESTRIAN
SHIP
TRAM
TRAIN
AIR

Api Model TravelDistanceAttribute

API Enumeration description of TravelDistanceAttribute

Name	Description
MAX_TRAVEL_DISTANCE
ROAD_DISTANCE
ROUTE_PEDESTRIANS
ROUTE_BICYCLES
ROUTE_CARS
ROUTE_TRUCKS
ROUTE_TRAMS
ROUTE_TRAINS
ROUTE_SHIPS
DESTINATION_THRESHOLD
BLOCKING_THRESHOLD
TRAVERSABLE_THRESHOLD

Api Model TravelDistanceKey

API Enumeration description of TravelDistanceKey

Name	Description
DESTINATION_AREA
BLOCKED

Api Model TravelDistanceOverlay

API Model description of TravelDistanceOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showDifference	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model TravelDistancePrequel

API Enumeration description of TravelDistancePrequel

Name	Description
TRAVERSABLE
BLOCKING
DESTINATION

Api Model TravelDistanceResult

API Enumeration description of TravelDistanceResult

Name	Description
DESTINATIONS
BASE_TYPES

Api Model Trigger

API Model description of Trigger

Name	Type	Description
active	boolean
calcTimeMS	long
id	int
method	Method
name	String
timeoutMS	int
timing	Timing
type	Type
url	String
version	int
warnings	String

Api Model Type (PopupData)

API Enumeration description of Type

Name	Description
STAKEHOLDER_STANDARD
INTERACTION
INTERACTION_WITH_DATE
INFORMATION
LABEL

Api Model Type (SpecialOption)

API Enumeration description of Type

Name	Description
BUY_LAND
SELL_LAND
DEMOLISH
REVERT
DEMOLISH_UNDERGROUND
RAISE_LAND
SHOW_BUDGETPANEL
SHOW_MONEY_TRANSFER_PANEL
LOWER_LAND

Api Model Type (Stakeholder)

API Enumeration description of Type

Name	Description
CIVILIAN
COMPANY
EDUCATION
EXPERT
FARMER
HEALTHCARE
HOUSING_CORPORATION
MUNICIPALITY
MEDIA
PROJECT_DEVELOPER
UTILITY_CORPORATION
WATER_AUTHORITY
OTHER_AUTHORITY
OTHER

Api Model Type (Trigger)

API Enumeration description of Type

Name	Description
TQL
EVENT

Api Model UniqueNamedItem

API Model description of UniqueNamedItem

Name	Type	Description
id	int
name	String
version	int

Api Model UnitData

API Model description of UnitData

Name	Type	Description
active	boolean
colors	TColor[]
fileName	String
id	int
isAlpha	boolean
name	String
particleEmitters	ParticleEmitterCoordinatePair[]
proximityWarningM	double
regions	Region[]
type	TrafficType
version	int

Api Model UnitDataOverride

API Model description of UnitDataOverride

Name	Type	Description
active	Boolean
colors	TColor[]
id	int
name	String
version	int

Api Model UpgradeFeature

API Model description of UpgradeFeature

Name	Type	Description
id	int
version	int

Api Model UpgradeSpatial

API Model description of UpgradeSpatial

Name	Type	Description
id	int
multiPolygon	MultiPolygon
upgradeID	int	Upgrade Type ID

Api Model ValueType

API Enumeration description of ValueType

Name	Description
DEFAULT
R
G
B
A

Api Model WCSOverlay

API Model description of WCSOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
crs	String
customLegend	boolean
diffLegend	LegendEntry[]
forceXY	boolean
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
layerName	String
layerNames	String[]
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showDifference	boolean
sortIndex	int
sourceID	int	Source ID
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model WCSResult

API Enumeration description of WCSResult

Name	Description
NEAREST
INTERPOLATED

Api Model WMSOverlay

API Model description of WMSOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
crs	String
customLegend	boolean
diffLegend	LegendEntry[]
forceXY	boolean
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
layerName	String
layerNames	String[]
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showDifference	boolean
sortIndex	int
sourceID	int	Source ID
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model WMSResult

API Enumeration description of WMSResult

Name	Description
COLOR
FLOAT32
RED
GREEN
BLUE
ALPHA

Api Model WWOverlay

API Model description of WWOverlay

Name	Type	Description
attributes	Map<String,double[]>
colorMultiplier	double
colorOffset	int
customLegend	boolean
id	int
imageName	String
imageVersion	int
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
name	String
parentID	int	Overlay ID
sortIndex	int
type	OverlayType
version	int
visible	boolean

Api Model WaterKey

API Enumeration description of WaterKey

Name	Description
WATER_LEVEL
WATER_RELATIVE
INLET_Q
INLET_CAPACITY
INLET_AREA
LOWER_THRESHOLD
UPPER_THRESHOLD
UNDERGROUND
INUNDATION_LEVEL
AQUIFER_KD
AQUIFER_DATUM
SEWER_STORAGE
SEWER_PUMP_SPEED
WEIR_HEIGHT
WEIR_WIDTH
WEIR_COEFFICIENT
WEIR_N
WEIR_ANGLE
WEIR_TARGET_LEVEL
CULVERT_DIAMETER
CULVERT_N
CULVERT_THRESHOLD
CULVERT_RECTANGULAR_HEIGHT
PUMP_Q
PUMP_ANGLE
PUMP_AREA
DRAINAGE_Q
DRAINAGE_DATUM
DRAINAGE_OVERFLOW_THRESHOLD
DRAINAGE_ACTIVE
BREACH_SPEED
BREACH_HEIGHT
BREACH_WIDTH
BREACH_ANGLE
BREACH_COEFFICIENT
BREACH_INPUT_AREA
BREACH_LEVEL_AREA
EXTERNAL_SURFACE_LEVEL
EXTERNAL_WATER_LEVEL
EXTERNAL_AREA
SEWER_OVERFLOW
SEWER_OVERFLOW_SPEED
OBJECT_FLOW_OUTPUT
OBJECT_DATUM_OUTPUT_A
OBJECT_DATUM_OUTPUT_B
OBJECT_WIDTH_OUTPUT
OBJECT_HEIGHT_OUTPUT
OBJECT_WATER_AREA_OUTPUT
WEIR_DAM_OUTPUT
TRACER_A
TRACER_B
TRACER_C
TRACER_D
LIMIT_AREA
RAIN_M

Api Model WaterModelAttribute

API Enumeration description of WaterModelAttribute

Name	Description
ALLOWED_WATER_INCREASE_M
GROUND_WATERTABLE_WITH_SURFACE
DESIGN_FLOOD_ELEVATION_M
GROUND_BOTTOM_DISTANCE_M
GROUND_BOTTOM_PRESSURE_M
GROUND_WATER
GROUND_WATER_DEPTH_M
HYDRAULIC_CONDUCTIVITY_WITH_THICKNESS
SOIL_WATER_RETENTION_CURVE
UNSATURATED_FRACTION
IMPACT_FLOOD_THRESHOLD_M
IMPACT_RANGE_M
CULVERT_DEM_THRESHOLD_M
QCELL
INCREASED_RESOLUTION
SHORELINE
OBJECT_ENTRY_CORRECTION
SEWER_OVERFLOW_THRESHOLD
DURATION_MIN_LEVEL_M
RISE_RATE_DISTANCE_M
SURFACE_WATER_EVAPORATION_FACTOR
TIMEFRAMES
TIMEFRAME_TIMES
LIMIT_AREA
LIMIT_RAIN
MAX_WATER_BOTTOM_M
START_DATE_MS
AVG_SHORE_WIDTH_M
AVG_TERRAIN_WIDTH_M
AVG_TERRAIN_STORAGE_M
SURFACE_WATER
PREQUEL_SURFACE_LEVEL_RELATIVE
MICRORELIEF_STORAGE_FRACTION
MIN_MAX_ELEVATION
BRIDGE_ELEVATION
MAX_INFILTRATION_M
MIN_DRAIN_SURFACE_DISTANCE_M
INFILTRATION_FACTOR_S
WEIR_DAM_MULTIPLIER
WEIR_DAM_SURPLUS_HEIGHT_M
BREACH_MEASUREMENT_DISTANCE_M
STABILIZER_ANGLE
WEIR_MOVE_INTERVAL_S
WEIR_MOVE_STEP_M
WEIR_MOVE_RANGE_M
PARTIAL_START_SEC
PARTIAL_END_SEC
TRIM_MANNING
TRIM_EVAPOTRANSPIRATION
TRIM_ROOT_DEPTH
TRIM_GROUND_INFILTRATION
TRIM_GROUND_CONDUCTIVITY
TRIM_SHORELINE_CONDUCTIVITY
TRIM_GROUND_STORAGE_FRACTION

Api Model WaterOverlay

API Model description of WaterOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcInfo	String
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
minValue	float[]
mode	Mode
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showAreas	boolean
showDifference	boolean
showSystem	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String
weatherID	int	Weather ID

Api Model WaterPrequel

API Enumeration description of WaterPrequel

Name	Description
TERRAIN_ELEVATION
SURFACE_LEVEL
SURFACE_U
SURFACE_V
SURFACE_INFILTRATION
GROUND_WATER_DEPTH
GROUND_WATER_DATUM
GROUND_CONDUCTIVITY
GROUND_INFILTRATION
GROUND_STORAGE_FRACTION
UNSATURATED_FRACTION
BOTTOM_DISTANCE
BOTTOM_RESISTANCE
BOTTOM_PRESSURE
MAX_INFILTRATION
MANNING
MICRORELIEF
SEWER_LEVEL

Api Model WaterResult

API Enumeration description of WaterResult

Name	Description
WATER_STRESS
SURFACE_LAST_DIRECTION
SURFACE_AVG_DIRECTION
SURFACE_DURATION
SURFACE_ELEVATION
SURFACE_FLOW
SURFACE_LAST_FLOW
SURFACE_LAST_SPEED
SURFACE_LAST_VALUE
SURFACE_LAST_DATUM
SURFACE_MAX_SPEED
SURFACE_MAX_VALUE
SURFACE_EVAPORATION
SURFACE_LAST_EVAPORATION
BUILDING_LAST_STORAGE
FLOOD_ARRIVAL_TIME
FLOOD_RISE_RATE
LAST_RAIN
RAIN
GROUND_LAST_STORAGE
GROUND_LAST_VALUE
GROUND_LAST_DIRECTION
GROUND_FLOW
GROUND_MAX_STORAGE
GROUND_MAX_VALUE
GROUND_WATERTABLE
GROUND_BOTTOM_FLOW
GROUND_LAST_UNSATURATED_STORAGE
GROUND_LAST_UNSATURATED_FRACTION
GROUND_TRANSPIRATION
GROUND_LAST_TRANSPIRATION
SEWER_LAST_VALUE
SEWER_MAX_VALUE
LAST_EVAPORATED
LAST_EVAPOTRANSPIRATION
EVAPORATED
EVAPOTRANSPIRATION
IMPACTED_BUILDINGS
TRACER_A
TRACER_B
TRACER_C
TRACER_D
BASE_TYPES
SURFACE_DIFFERENCE
DEBUG_UV
GPU_OVERVIEW
DEBUG_AVG_AREAS
DEBUG_UV_DIRECTION
DEBUG_WATERWAYS
SURFACE_LAST_U
SURFACE_LAST_V

Api Model WaterSystem

API Enumeration description of WaterSystem

Name	Description
OBJECTS
AREAS

Api Model WaterType

API Enumeration description of WaterType

Name	Description
NONE
WATERWAY
WATERBODY
SEA

Api Model WatershedKey

API Enumeration description of WatershedKey

Name	Description
DISCHARGE_AREA

Api Model WatershedModelAttribute

API Enumeration description of WatershedModelAttribute

Name	Description
FILL_DISTANCE
DISCHARGE_REMAINING_WATER
CULVERT_FLOW_DIRECTION
MIN_AREA
LIMIT_ROAD

Api Model WatershedOverlay

API Model description of WatershedOverlay

Name	Type	Description
active	boolean
attributes	Map<String,double[]>
calcTimeMS	long
colorMultiplier	double
colorOffset	int
customLegend	boolean
diffLegend	LegendEntry[]
id	int
imageName	String
imageVersion	int
inActiveCellSize	double
inActiveTimeframes	int
keys	Map<String,String>
legend	LegendEntry[]
maquetteOverride	Map<String,double[]>
maxValue	float[]
method	DischargeMethod
minValue	float[]
name	String
parentID	int	Overlay ID
prequels	Map<String,PrequelLink>
resultType	String
showDifference	boolean
sortIndex	int
type	OverlayType
version	int
visible	boolean
warnings	String

Api Model WatershedPrequel

API Enumeration description of WatershedPrequel

Name	Description
DIRECTION

Api Model WatershedResult

API Enumeration description of WatershedResult

Name	Description
WATERSHEDS
DISCHARGE_AREAS
DIRECTION
BASE_TYPES

Api Model WebPanel

API Model description of WebPanel

Name	Type	Description
answers	Answer[]
attributes	Map<String,double[]>
height	double
id	int
layoutX	double
layoutY	double
maquetteOverride	Map<String,double[]>
name	String
overlayID	int	Overlay ID
overrideDefaultAnswerID	int
point	Point
stakeholderID	int	Stakeholder ID
type	PanelType
url	String
version	int
width	double

Api Model ZipCode

API Model description of ZipCode

Name	Type	Description
color	TColor
id	int
name	String
polygons	MultiPolygon
sourceIDs	int[]	Source ID
version	int

Api Model Zone

API Model description of Zone

Name	Type	Description
attributes	Map<String,double[]>
center	Point
excelID	int	Excel Sheet ID
excelUpdated	boolean
id	int
maquetteOverride	Map<String,double[]>
name	String
outline	Outline
parentZoneID	int	Zone ID
permitterID	int	Stakeholder ID
polygons	MultiPolygon
sourceIDs	int[]	Source ID
version	int

Api Model ZoneAttribute

API Enumeration description of ZoneAttribute

Name	Description
MAX_BUILDING_HEIGHT
MAX_ROOF_GUTTER_HEIGHT
MAX_FLOORS
MIN_FLOORS
AMOUNT_FLOORS
MAX_BUILDING_PCT
MONUMENTAL

Api Model ZoneDistanceAttribute

API Enumeration description of ZoneDistanceAttribute

Name	Description
ATTRIBUTE_TIMEFRAMES
HIT_COUNT