Api session event editor building: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 73: Line 73:
|-
|-
| [[Api session event editor building query|query]]
| [[Api session event editor building query|query]]
| Execute a single [[Tygron Query Language|TQL Query]]. Use the [[Api session query]] for multiple statements or detailed API usage information.
| Execute a single [[Tygron Query Language|TQL Query]]. Use the [[[[Api session query|Session/query Endpoint]]]] for multiple statements or detailed API usage information.
|-
|-
| [[Api session event editor building remove geometries|remove_geometries]]
| [[Api session event editor building remove geometries|remove_geometries]]

Revision as of 15:44, 10 November 2026

API Endpoint: api/session/event/editorbuilding/

API Endpoints for Building editing.

Name Description
add Add a new Building, owned by a Stakeholder, with a provided Function and name.
add_polygons Add Polygons for Building Section. If the Building is empty, optionally set ownership to the largest Plot Owner of the provided MultiPolygon
append_attribute Appended to existing Building numeric Attribute value
duplicate Duplicate existing Building
import Import Building Collection
remove Remove existing Building
remove_attribute Remove numeric Attribute from Building
remove_polygons Remove Polygons from a Building Section
set_attribute Set Building numeric Attribute value
set_attributes Set multiple Building numeric Attribute values
set_name Set the name of a Building.

Additional API Endpoints:

Name Description
add_geometry Add a Custom Geometry to a Building
add_road Add a new Building, owned by a Stakeholder, with a default road Function
add_section Add a new Section to a Building.
add_standard Add a new Building, owned by a Stakeholder, with a default housing Function
add_underground Add a new Building, owned by a Stakeholder, with a default underground Function
duplicate_section Duplicate a Building Section.
generate_rotation_angles Calculate a rotation angle for Buildings with Polygons for the identifying Attribute, optionally only for specified Buildings.
generate_water_connection Generate Water Connections, with a Function, within a provided MultiPolygon. Connections are only taken into account when within the provided parameter bounds.
multi_select Change the Function of multiple Buildings. Optionally adjust the floors (>0). Optionally merge the Buildings into one.
query Execute a single TQL Query. Use the [[Session/query Endpoint]] for multiple statements or detailed API usage information.
remove_geometries Remove all Custom Geometries from a Building
remove_sections Remove a Section from a Building.
reset_category_values Reset values of Category Values of a Building for a Category.
reset_function_values Reset the values of Function Values for a Building.
reset_slanting_roof_height Reset Height of the Slanting Roof of a Building Section
set_category_value Set the values of a Category Value for a Building and a Category.
set_decals Set the decal values (door, window etc) for a Face Type of a Building.
set_floors Set the number of floors of a Building's Section
set_function Set the Function of a Building.
set_function_value Set the values of a Function Value for a Building.
set_owner Set the owner of a Building.
set_slanting_roof_height Change Height of the Slanting Roof of a Section of a Building