Api session items buildings

From Tygron Support wiki
Revision as of 12:42, 20 April 2026 by Frank@tygron.nl (talk | contribs) (Replaced content with "Api session items Building Endpoints. Edit items with event: editorbuilding. Default Query: <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/buildings/?f=JSON&token=API_TOKEN</syntaxhighlight> Example Response: <syntaxhighlight lang="text" copy>[ { "addressIDs" : [ ], "attributes" : { "NUM_CARS" : [ 67.38087166666666 ], "NUM_TRUCKS" : [ 0.9162670833333333 ], "NUM_VANS" : [ 2.1849...")
Jump to navigation Jump to search

Api session items Building Endpoints.

Edit items with event: editorbuilding.

Default Query:

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

Example Response:

[ {
  "addressIDs" : [ ],
  "attributes" : {
    "NUM_CARS" : [ 67.38087166666666 ],
    "NUM_TRUCKS" : [ 0.9162670833333333 ],
    "NUM_VANS" : [ 2.1849445833333334 ],
    "NWB_ID" : [ 3.83289109E8 ]
  },
  "center" : {
    "type" : "Point",
    "coordinates" : [ 659437.6623386738, 6798652.514593948, 46.724 ]
  },
  "customGeometries" : null,
  "demolisherID" : -1,
  "functionID" : 436,
  "id" : 0,
  "maquetteOverride" : null,
  "measureID" : -1,
  "modelVersion" : 0,
  "name" : "Leeuwerikstraat",
  "overrideCategories" : null,
  "overrideDecals" : null,
  "ownerID" : 0,
  "permitReceived" : null,
  "predecessorID" : -1,
  "sections" : [ {
    "floors" : 1,
    "id" : 1,
    "outerLines" : null,
    "polygons" : {
      "type" : "MultiPolygon",
      "coordinates" : [ [ [ [ 659436.7739362306, 6798649.869141218 ], [ 659436.8259085856, 6798650.018546752 ], [ 659437.111756538, 6798650.632408647 ], [ 659437.3602493604, 6798651.083873241 ], [ 659438.0277692949, 6798652.069625167 ], [ 659438.8187235727, 6798652.961186732 ], [ 659439.7184949687, 6798653.740694189 ], [ 659440.7124662581, 6798654.395155717 ], [ 659440.9447177196, 6798654.523449671 ], [ 659431.573452458, 6798649.869141218 ], [ 659436.7739362306, 6798649.869141218 ] ] ] ]
    },
    "roofPolygons" : null,
    "roofShape" : null,
    "skeletonLines" : {
      "type" : "MultiLineString",
      "coordinates" : [ [ [ 659438.6563099633, 6798653.128456033 ], [ 659436.6748639288, 6798651.507730316 ], [ 659436.106416296, 6798650.932843714 ] ] ]
    },
    "slantingRoofHeightM" : null
  } ],
  "sourceIDs" : [ 3, 21 ],
  "state" : "READY",
  "upgradeID" : -1,
  "upgradeOwnerID" : -1,
  "version" : 529
}, {
  "addressIDs" : [ ],
  "attributes" : {
    "NUM_CARS" : [ 35.873599999999996 ],
    "NUM_TRUCKS" : [ 0.5231566666666666 ],
    "NUM_VANS" : [ 0.9715766666666666 ],
    "NWB_ID" : [ 6.00382077E8 ],
    "TRAFFIC_LANES" : [ 1.0 ]
  },
  "center" : {
    "type" : "Point",
    "coordinates" : [ 659137.9540087318, 6798657.919180244, 51.186 ]
  },
  "customGeometries" : null,
  "demolisherID" : -1,
  "functionID" : 436,
  "id" : 1,
  "maquetteOverride" : null,
  "measureID" : -1,
  "modelVersion" : 0,
  "name" : "Duivenstraat",
  "overrideCategories" : null,
  "overrideDecals" : null,
  "ownerID" : 0,
  "permitReceived" : null,
  "predecessorID" : -1,
  "sections" : [ {
    "floors" : 1,
    "id" : 1,
    "outerLines" : null,
    "polygons" : {
      "type" : "MultiPolygon",
      "coordinates" : [ [ [ [ 659135.0240672185, 6798652.409035658 ], [ 659136.6904308507, 6798653.388291852 ], [ 659163.1524802279, 6798665.762982272 ], [ 659160.6172037853, 6798671.284503788 ], [ 659145.0108800596, 6798664.07891896 ], [ 659143.7505504508, 6798663.525143152 ], [ 659140.9813984107, 6798662.7423868 ], [ 659138.0205983117, 6798662.450071175 ], [ 659133.9537615327, 6798662.797601979 ], [ 659131.3356541493, 6798663.486167734 ], [ 659128.1848301273, 6798664.850307606 ], [ 659130.793192694, 6798651.405419985 ], [ 659135.0240672185, 6798652.409035658 ] ] ] ]
    },
    "roofPolygons" : null,
    "roofShape" : null,
    "skeletonLines" : {
      "type" : "MultiLineString",
      "coordinates" : [ [ [ 659161.858043761, 6798668.5822057305 ], [ 659149.1670443238, 6798662.7066593375 ], [ 659138.1521533353, 6798658.589881861 ], [ 659130.8906408596, 6798657.099073017 ], [ 659129.8040938128, 6798656.504698323 ] ] ]
    },
    "slantingRoofHeightM" : null
  } ],
  "sourceIDs" : [ 3, 21 ],
  "state" : "READY",
  "upgradeID" : -1,
  "upgradeOwnerID" : -1,
  "version" : 530
} ]

Limit Queries

version=100:

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

Pseudo-Mercator:

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

Degrees:

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

Amersfoort / RD New:

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

Local Coordinates:

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

bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785:

https://engine.tygron.com/api/session/items/buildings/?crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=API_TOKEN

ROAD:

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

ROAD+FOO:

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

Show Queries

max version:

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

size:

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

Formats

HTML:

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

JSON:

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

GEOJSON:

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

GPKG:

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

DXF:

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

CSV:

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

SSV:

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

SMILE:

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

ZIPJSON:

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

ZIPSMILE:

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

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 Detail

API Enumeration description of Detail

Name Description
CONSTRUCTION_COST
DEMOLISH_COST
BUYOUT_COST
SELL_PRICE
SELLABLE_FLOORSPACE_M2
NUMBER_OF_HOUSES

Api Model Layer

API Enumeration description of Layer

Name Description
BRIDGE
SURFACE
UNDERGROUND

Api Model ModelStyle

API Enumeration description of ModelStyle

Name Description
WIREFRAME
PLAIN
COLORED
TEXTURED
DISCO

Api Model NeighborPredicate

API Model description of NeighborPredicate

Name Type Description
me Building

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 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 WaterType

API Enumeration description of WaterType

Name Description
NONE
WATERWAY
WATERBODY
SEA