Api session items buildings: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 51: Line 51:
   "upgradeID" : -1,
   "upgradeID" : -1,
   "upgradeOwnerID" : -1,
   "upgradeOwnerID" : -1,
   "version" : 1283
   "version" : 1307
}, {
}, {
   "addressIDs" : [ ],
   "addressIDs" : [ ],
Line 98: Line 98:
   "upgradeID" : -1,
   "upgradeID" : -1,
   "upgradeOwnerID" : -1,
   "upgradeOwnerID" : -1,
   "version" : 1284
   "version" : 1308
} ]</syntaxhighlight>
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
Line 237: Line 237:
|version
|version
|int
|int
|
|}
==Api Model CGLink==
API Model description of CGLink
{|class=wikitable
!Name
!Type
!Description
|-
|geometryID
|int
|[[Custom Geometry]] ID
|-
|primary
|boolean
|
|}
==Api Model Category==
API Enumeration description of Category
{|class=wikitable
!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 EmptyMultiPolygon==
API Model description of EmptyMultiPolygon
{|class=wikitable
!Name
!Type
!Description
|}
==Api Model FaceType==
API Enumeration description of FaceType
{|class=wikitable
!Name
!Description
|-
|BASEMENT
|
|-
|GROUND
|
|-
|EXTRA
|
|-
|TOP
|
|-
|ROOF
|
|}
==Api Model GeometryCollection==
API Model description of GeometryCollection
{|class=wikitable
!Name
!Type
!Description
|}
==Api Model MultiLineString==
API Model description of MultiLineString
{|class=wikitable
!Name
!Type
!Description
|}
==Api Model MultiPolygon==
API Model description of MultiPolygon
{|class=wikitable
!Name
!Type
!Description
|}
==Api Model Point==
API Model description of Point
{|class=wikitable
!Name
!Type
!Description
|}
==Api Model Section==
API Model description of Section
{|class=wikitable
!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 TimeState==
API Enumeration description of TimeState
{|class=wikitable
!Name
!Description
|-
|NOTHING
|
|-
|WAITING_FOR_DATE
|
|-
|REQUEST_PLOT_OWNER_APPROVAL
|
|-
|REQUEST_ZONING_APPROVAL
|
|-
|REQUEST_CONSTRUCTION_APPROVAL
|
|-
|CONSTRUCTION_APPROVED
|
|-
|CONSTRUCTION_DENIED
|
|-
|PENDING_CONSTRUCTION
|
|-
|CONSTRUCTING
|
|-
|READY
|
|-
|PENDING_UPGRADE
|
|-
|WAITING_FOR_DEMOLISH_DATE
|
|-
|REQUEST_DEMOLISH_ZONING_APPROVAL
|
|-
|REQUEST_DEMOLISH_APPROVAL
|
|-
|DEMOLISH_APPROVED
|
|-
|DEMOLISH_DENIED
|
|-
|PENDING_DEMOLISHING
|
|-
|DEMOLISHING
|
|-
|DEMOLISH_FINISHED
|
|
|}
|}
Line 245: Line 519:


[[Category:API]]
[[Category:API]]
[[Category:Items]]

Latest revision as of 14:13, 24 April 2026

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" : 1307
}, {
  "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" : 1308
} ]

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

API Model description of EmptyMultiPolygon

Name Type Description

Api Model FaceType

API Enumeration description of FaceType

Name Description
BASEMENT
GROUND
EXTRA
TOP
ROOF

Api Model GeometryCollection

API Model description of GeometryCollection

Name Type Description

Api Model MultiLineString

API Model description of MultiLineString

Name Type Description

Api Model MultiPolygon

API Model description of MultiPolygon

Name Type Description

Api Model Point

API Model description of Point

Name Type Description

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