Api session event editor building: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
39,237 edits
No edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session event editor building Endpoints.
API Endpoint: api/session/event/editorbuilding/


API Endpoints for [[Building]] editing.
API endpoints for [[Building]] editing.
{|class=wikitable
{|class=wikitable
!Name
!Name
Line 10: Line 10:
|-
|-
|[[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 [[#Api Model MultiPolygon|MultiPolygon]]
|Add [[#Api Model Polygon|Polygon]]s for [[Building]] [[Section]]. In case the [[Building]] is empty, optionally set ownership to largest [[Plot]] Owner of provided [[#Api Model MultiPolygon|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]]
Line 25: Line 25:
|-
|-
|[[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 [[#Api Model Polygon|Polygon]]s 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]]
Line 40: Line 40:
|}
|}


Additional API Endpoints:
Additional API endpoints:
{|class=wikitable
{|class=wikitable
!Name
!Name
Line 64: Line 64:
|-
|-
|[[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]]s having the identifying [[Attribute]] [[#Api Model Polygon|Polygon]]s, optionally only for specified [[Building]]s.
|-
|-
|[[Api session event editor building generate water connection|generate_water_connection]]
|[[Api session event editor building generate water connection|generate_water_connection]]
Line 73: Line 73:
|-
|-
|[[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 [[Tygron Query Language|TQL Query]]. Note: you can also use the [[Session]]/query endpoint to execute multiple statements and get additional in[[Format]]ion on API usage.
|-
|-
|[[Api session event editor building remove geometries|remove_geometries]]
|[[Api session event editor building remove geometries|remove_geometries]]
Line 82: Line 82:
|-
|-
|[[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 Value]]s
|-
|-
|[[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 Value]]s
|-
|-
|[[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]]
Line 103: Line 103:
|-
|-
|[[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]]
Line 109: Line 109:
|-
|-
|[[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]]
|}
|}
{{article end|seealso=*[[Api Events]]
{{article end|seealso=*[[Api Session Endpoints]]
*[[Api session items buildings]]
*[[Api session items buildings]]
}}
}}


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

Latest revision as of 08:39, 3 June 2026

API Endpoint: api/session/event/editorbuilding/

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 Buildings having the identifying Attribute Polygons, optionally only for specified Buildings.
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

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_event_editor_building&oldid=83249"