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
51,321 edits
No edit summary
No edit summary
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session event editor building Endpoints.
<noinclude lang="text" copy>API Endpoint: api/session/event/editorbuilding/
 
</noinclude><noinclude lang="text" copy>
API End[[#Api Model Point|Point]]s for [[Building]] editing.
API Endpoints for [[Building]] editing.
{|class=wikitable
</noinclude>{|class=wikitable
!Name
!Name
!Description
!Description
|-
|-
|[[Api session event editor building add|add]]
| [[Api session event editor building add|add]]
|Add new [[Building]]
| Add a new [[Building]], owned by a [[Stakeholder]], with a provided [[Function]] and name
|-
|-
|[[Api session event editor building add polygons|add_polygons]]
| [[Api session event editor building add polygons|add_polygons]]
|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]]
| Add [[Polygon]]s for [[Building]] [[Section]]. If the [[Building]] is empty, optionally set ownership to the largest [[Plot]] Owner of the 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]] numeric [[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 numeric [[Attribute]] from [[Building]]
|-
|-
|[[Api session event editor building remove polygons|remove_polygons]]
| [[Api session event editor building remove polygons|remove_polygons]]
|Delete [[#Api Model Polygon|Polygon]]s for [[Building]] [[Section]]
| Remove [[Polygon]]s from a [[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]] numeric [[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]] numeric [[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 the name of a [[Building]]
|}
|}
 
<noinclude lang="text" copy>
Additional API End[[#Api Model Point|Point]]s:
Additional API Endpoints:
{|class=wikitable
</noinclude>{|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 Geometry]] to a [[Building]]
|-
|-
|[[Api session event editor building add road|add_road]]
| [[Api session event editor building add road|add_road]]
|Add Road
| Add a new [[Building]], owned by a [[Stakeholder]], with a default road [[Function]]
|-
|-
|[[Api session event editor building add section|add_section]]
| [[Api session event editor building add section|add_section]]
|Add [[Section]]
| Add a new [[Section]] to a [[Building]]
|-
|-
|[[Api session event editor building add standard|add_standard]]
| [[Api session event editor building add standard|add_standard]]
|Add Standard
| Add a new [[Building]], owned by a [[Stakeholder]], with a default housing [[Function]]
|-
|-
|[[Api session event editor building add underground|add_underground]]
| [[Api session event editor building add underground|add_underground]]
|Add Underground
| Add a new [[Building]], owned by a [[Stakeholder]], with a default underground [[Function]]
|-
|-
|[[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]]s having the identifying [[Attribute]] [[#Api Model Polygon|Polygon]]s, optionally only for specified [[Building]]s.
| Calculate a rotation angle for [[Building]]s with [[Polygon]]s for the identifying [[Attribute]], 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]]
|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
|-
|-
|[[Api session event editor building multi select|multi_select]]
| [[Api session event editor building multi select|multi_select]]
|Multi Select
| Change the [[Function]] of multiple [[Building]]s. Optionally adjust the floors (>0). Optionally merge the [[Building]]s into one
|-
|-
|[[Api session event editor building query|query]]
| [[Api session event editor building query|query]]
|Executes a single [[Tygron Query Language|TQL Query]]. Note: you can also use the [[Session]]/query end[[#Api Model Point|Point]] to execute multiple statements and get additional in[[Format]]ion on API usage.
| 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]]
|Remove all custom [[Building]] geometries
| Remove all [[Custom Geometry|Custom Geometries]] from a [[Building]]
|-
|-
|[[Api session event editor building remove sections|remove_sections]]
| [[Api session event editor building remove sections|remove_sections]]
|Remove [[Section]]s
| Remove a [[Section]] from a [[Building]]
|-
|-
|[[Api session event editor building reset category values|reset_category_values]]
| [[Api session event editor building reset category values|reset_category_values]]
|Reset [[Category Value]]s
| Reset values of [[Category Value]]s of a [[Building]] for a [[Category]]
|-
|-
|[[Api session event editor building reset function values|reset_function_values]]
| [[Api session event editor building reset function values|reset_function_values]]
|Reset [[Function Value]]s
| Reset the values of [[Function Value]]s for a [[Building]]
|-
|-
|[[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 the values of a [[Category Value]] for a [[Building]] and a [[Category]]
|-
|-
|[[Api session event editor building set decals|set_decals]]
| [[Api session event editor building set decals|set_decals]]
|Set Decals
| Set the decal values (door, window etc) for a Face Type of a [[Building]]
|-
|-
|[[Api session event editor building set floors|set_floors]]
| [[Api session event editor building set floors|set_floors]]
|Change amount of floors
| Set the number of floors of a [[Building]]'s [[Section]]
|-
|-
|[[Api session event editor building set function|set_function]]
| [[Api session event editor building set function|set_function]]
|Set [[Function]]
| Set the [[Function]] of a [[Building]]
|-
|-
|[[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 the values of a [[Function Value]] for a [[Building]]
|-
|-
|[[Api session event editor building set owner|set_owner]]
| [[Api session event editor building set owner|set_owner]]
|Set Owner
| Set the owner of a [[Building]]
|-
|-
|[[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 [[Section]] of a [[Building]]
|}
|}
{{article end|seealso=*[[Api Events]]
<noinclude lang="text" copy>{{article end|seealso=*[[Api Session Endpoints]]
*[[Api session items buildings]]
*[[Api session items buildings]]
}}
}}
 
</noinclude>
[[Category:API]]
[[Category:API]]

Latest revision as of 10:26, 13 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

See also

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