Api session event editor building: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
API Endpoint: api/session/event/editorbuilding/ | <noinclude lang="text" copy>API Endpoint: api/session/event/editorbuilding/ | ||
</noinclude><noinclude lang="text" copy> | |||
API Endpoints 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 a new [[Building]], owned by a [[Stakeholder]], with a provided [[Function]] and name | | 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]] | ||
| Line 37: | Line 37: | ||
|- | |- | ||
| [[Api session event editor building set name|set_name]] | | [[Api session event editor building set name|set_name]] | ||
| Set the name of a [[Building]] | | Set the name of a [[Building]] | ||
|} | |} | ||
<noinclude lang="text" copy> | |||
Additional API Endpoints: | Additional API Endpoints: | ||
{|class=wikitable | </noinclude>{|class=wikitable | ||
!Name | !Name | ||
!Description | !Description | ||
| Line 52: | Line 52: | ||
|- | |- | ||
| [[Api session event editor building add section|add_section]] | | [[Api session event editor building add section|add_section]] | ||
| Add a new [[Section]] to a [[Building]] | | 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]] | ||
| Line 61: | Line 61: | ||
|- | |- | ||
| [[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]] | ||
| Calculate a rotation angle for [[Building]]s with [[Polygon]]s for the identifying [[Attribute]], 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 Connections, with a [[Function]], within a provided [[MultiPolygon]]. Connections are only taken into account when within the provided parameter bounds | | 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]] | ||
| Change the [[Function]] of multiple [[Building]]s. Optionally adjust the floors (>0). Optionally merge the [[Building]]s into one | | 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]] | ||
| 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]] | ||
| Line 79: | Line 79: | ||
|- | |- | ||
| [[Api session event editor building remove sections|remove_sections]] | | [[Api session event editor building remove sections|remove_sections]] | ||
| Remove a [[Section]] from a [[Building]] | | 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 values of [[Category Value]]s of a [[Building]] for a [[Category]] | | 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 the values of [[Function Value]]s for a [[Building]] | | 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]] | ||
| Line 91: | Line 91: | ||
|- | |- | ||
| [[Api session event editor building set category value|set_category_value]] | | [[Api session event editor building set category value|set_category_value]] | ||
| Set the values of a [[Category Value]] for a [[Building]] and a [[Category]] | | 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 the decal values (door, window etc) for a Face Type of a [[Building]] | | 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]] | ||
| Line 100: | Line 100: | ||
|- | |- | ||
| [[Api session event editor building set function|set_function]] | | [[Api session event editor building set function|set_function]] | ||
| Set the [[Function]] of a [[Building]] | | 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 the values of a [[Function Value]] for a [[Building]] | | 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 the owner of a [[Building]] | | 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 [[Section]] of a [[Building]] | | Change [[Slanting roof height (Function Value)|Height of the Slanting Roof]] of a [[Section]] of a [[Building]] | ||
|} | |} | ||
{{article end|seealso=*[[Api Session Endpoints]] | <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 |