Api session event editor building: 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 1: Line 1:
Api session event editor building Events.
Api session event editor building Endpoints.


[[Building]] editing.
API Endpoints for [[Building]] editing.
{|class=wikitable
{|class=wikitable
!Name
!Name
!Description
!Description
|-
|-
|[[Api session event editor building add|ADD]]
|[[Api session event editor building add|add]]
|Add new [[Building]]
|Add new [[Building]]
|-
|-
|[[Api session event editor building add polygons|ADD_POLYGONS]]
|[[Api session event editor building add polygons|add_polygons]]
|Add polygons for [[Building]] [[Section]]. In case the [[Building]] is empty, optionally set ownership to largest [[Plot]] Owner of provided MultiPolygon
|Add polygons for [[Building]] [[Section]]. In case the [[Building]] is empty, optionally set ownership to largest [[Plot]] Owner of provided MultiPolygon
|-
|-
|[[Api session event editor building append attribute|APPEND_ATTRIBUTE]]
|[[Api session event editor building append attribute|append_attribute]]
|Appended to existing [[Building]] attribute value
|Appended to existing [[Building]] attribute value
|-
|-
|[[Api session event editor building duplicate|DUPLICATE]]
|[[Api session event editor building duplicate|duplicate]]
|Duplicate existing [[Building]]
|Duplicate existing [[Building]]
|-
|-
|[[Api session event editor building import|IMPORT]]
|[[Api session event editor building import|import]]
|Import [[Building]] Collection
|Import [[Building]] Collection
|-
|-
|[[Api session event editor building remove|REMOVE]]
|[[Api session event editor building remove|remove]]
|Remove existing [[Building]]
|Remove existing [[Building]]
|-
|-
|[[Api session event editor building remove attribute|REMOVE_ATTRIBUTE]]
|[[Api session event editor building remove attribute|remove_attribute]]
|Remove attribute from [[Building]]
|Remove attribute from [[Building]]
|-
|-
|[[Api session event editor building remove polygons|REMOVE_POLYGONS]]
|[[Api session event editor building remove polygons|remove_polygons]]
|Delete polygons for [[Building]] [[Section]]
|Delete polygons for [[Building]] [[Section]]
|-
|-
|[[Api session event editor building set attribute|SET_ATTRIBUTE]]
|[[Api session event editor building set attribute|set_attribute]]
|Set [[Building]] attribute value
|Set [[Building]] attribute value
|-
|-
|[[Api session event editor building set attributes|SET_ATTRIBUTES]]
|[[Api session event editor building set attributes|set_attributes]]
|Set multiple [[Building]] attribute values
|Set multiple [[Building]] attribute values
|-
|-
|[[Api session event editor building set name|SET_NAME]]
|[[Api session event editor building set name|set_name]]
|Set new name of existing [[Building]]
|Set new name of existing [[Building]]
|}
|}


Specific Events:
Additional API Endpoints:
{|class=wikitable
{|class=wikitable
!Name
!Name
!Description
!Description
|-
|-
|[[Api session event editor building add geometry|ADD_GEOMETRY]]
|[[Api session event editor building add geometry|add_geometry]]
|Add a custom [[Building]] geometry
|Add a custom [[Building]] geometry
|-
|-
|[[Api session event editor building add road|ADD_ROAD]]
|[[Api session event editor building add road|add_road]]
|Add Road
|Add Road
|-
|-
|[[Api session event editor building add section|ADD_SECTION]]
|[[Api session event editor building add section|add_section]]
|Add [[Section]]
|Add [[Section]]
|-
|-
|[[Api session event editor building add standard|ADD_STANDARD]]
|[[Api session event editor building add standard|add_standard]]
|Add Standard
|Add Standard
|-
|-
|[[Api session event editor building add underground|ADD_UNDERGROUND]]
|[[Api session event editor building add underground|add_underground]]
|Add Underground
|Add Underground
|-
|-
|[[Api session event editor building duplicate section|DUPLICATE_SECTION]]
|[[Api session event editor building duplicate section|duplicate_section]]
|Duplicate a [[Building]] [[Section]].
|Duplicate a [[Building]] [[Section]].
|-
|-
|[[Api session event editor building generate rotation angles|GENERATE_ROTATION_ANGLES]]
|[[Api session event editor building generate rotation angles|generate_rotation_angles]]
|Calculation a rotation angle for [[Building]] having the identifying attribute polygons, optionally only for specified [[Building]].
|Calculation a rotation angle for [[Building]] having the identifying attribute polygons, optionally only for specified [[Building]].
|-
|-
|[[Api session event editor building generate water connection|GENERATE_WATER_CONNECTION]]
|[[Api session event editor building generate water connection|generate_water_connection]]
|Generate Water Connection.
|Generate Water Connection.
|-
|-
|[[Api session event editor building multi select|MULTI_SELECT]]
|[[Api session event editor building multi select|multi_select]]
|Multi Select
|Multi Select
|-
|-
|[[Api session event editor building query|QUERY]]
|[[Api session event editor building query|query]]
|Executes a single TQL query. Note: you can also use the session/query endpoint to execute multiple statements and get additional information on API usage.
|Executes a single TQL query. Note: you can also use the session/query endpoint to execute multiple statements and get additional information on API usage.
|-
|-
|[[Api session event editor building remove geometries|REMOVE_GEOMETRIES]]
|[[Api session event editor building remove geometries|remove_geometries]]
|Remove all custom [[Building]] geometries
|Remove all custom [[Building]] geometries
|-
|-
|[[Api session event editor building remove sections|REMOVE_SECTIONS]]
|[[Api session event editor building remove sections|remove_sections]]
|Remove [[Section]]s
|Remove [[Section]]s
|-
|-
|[[Api session event editor building reset category values|RESET_CATEGORY_VALUES]]
|[[Api session event editor building reset category values|reset_category_values]]
|Reset [[Category]] Values
|Reset [[Category]] Values
|-
|-
|[[Api session event editor building reset function values|RESET_FUNCTION_VALUES]]
|[[Api session event editor building reset function values|reset_function_values]]
|Reset [[Function]] Values
|Reset [[Function]] Values
|-
|-
|[[Api session event editor building reset slanting roof height|RESET_SLANTING_ROOF_HEIGHT]]
|[[Api session event editor building reset slanting roof height|reset_slanting_roof_height]]
|Reset [[Slanting roof height (Function Value)|Height of the Slanting Roof]] of a [[Building]] section
|Reset [[Slanting roof height (Function Value)|Height of the Slanting Roof]] of a [[Building]] section
|-
|-
|[[Api session event editor building set category value|SET_CATEGORY_VALUE]]
|[[Api session event editor building set category value|set_category_value]]
|Set [[Category]] Value
|Set [[Category]] Value
|-
|-
|[[Api session event editor building set decals|SET_DECALS]]
|[[Api session event editor building set decals|set_decals]]
|Set Decals
|Set Decals
|-
|-
|[[Api session event editor building set floors|SET_FLOORS]]
|[[Api session event editor building set floors|set_floors]]
|Change amount of floors
|Change amount of floors
|-
|-
|[[Api session event editor building set function|SET_FUNCTION]]
|[[Api session event editor building set function|set_function]]
|Set [[Function]]
|Set [[Function]]
|-
|-
|[[Api session event editor building set function value|SET_FUNCTION_VALUE]]
|[[Api session event editor building set function value|set_function_value]]
|Set [[Function]] Value
|Set [[Function]] Value
|-
|-
|[[Api session event editor building set owner|SET_OWNER]]
|[[Api session event editor building set owner|set_owner]]
|Set Owner
|Set Owner
|-
|-
|[[Api session event editor building set slanting roof height|SET_SLANTING_ROOF_HEIGHT]]
|[[Api session event editor building set slanting roof height|set_slanting_roof_height]]
|Change [[Slanting roof height (Function Value)|Height of the Slanting Roof]] of a [[Building]] section
|Change [[Slanting roof height (Function Value)|Height of the Slanting Roof]] of a [[Building]] section
|}
|}


Deprecated Events:
Deprecated API Endpoints:
{|class=wikitable
{|class=wikitable
!Name
!Name
!Description
!Description
|-
|-
|[[Api session event editor building duplicate sections|DUPLICATE_SECTIONS]]
|[[Api session event editor building duplicate sections|duplicate_sections]]
|Use DUPLICATE_SECTION instead for identical result.
|Use DUPLICATE_SECTION instead for identical result.
|}
|}

Latest revision as of 13:32, 14 April 2026

Api session event editor building Endpoints.

API Endpoints for Building editing.

Name Description
add Add new Building
add_polygons Add polygons for Building Section. In case the Building is empty, optionally set ownership to largest Plot Owner of provided MultiPolygon
append_attribute Appended to existing Building attribute value
duplicate Duplicate existing Building
import Import Building Collection
remove Remove existing Building
remove_attribute Remove attribute from Building
remove_polygons Delete polygons for Building Section
set_attribute Set Building attribute value
set_attributes Set multiple Building attribute values
set_name Set new name of existing Building

Additional API Endpoints:

Name Description
add_geometry Add a custom Building geometry
add_road Add Road
add_section Add Section
add_standard Add Standard
add_underground Add Underground
duplicate_section Duplicate a Building Section.
generate_rotation_angles Calculation a rotation angle for Building having the identifying attribute polygons, optionally only for specified Building.
generate_water_connection Generate Water Connection.
multi_select Multi Select
query Executes a single TQL query. Note: you can also use the session/query endpoint to execute multiple statements and get additional information on API usage.
remove_geometries Remove all custom Building geometries
remove_sections Remove Sections
reset_category_values Reset Category Values
reset_function_values Reset Function Values
reset_slanting_roof_height Reset Height of the Slanting Roof of a Building section
set_category_value Set Category Value
set_decals Set Decals
set_floors Change amount of floors
set_function Set Function
set_function_value Set Function Value
set_owner Set Owner
set_slanting_roof_height Change Height of the Slanting Roof of a Building section

Deprecated API Endpoints:

Name Description
duplicate_sections Use DUPLICATE_SECTION instead for identical result.