Api session event editor zoning: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Endpoint: api/session/event/editorzoning/
<noinclude lang="text" copy>API Endpoint: api/session/event/editorzoning/
 
</noinclude><noinclude lang="text" copy>
API Endpoints for Zoning editing.
API Endpoints for Zoning editing.
{|class=wikitable
</noinclude>{|class=wikitable
!Name
!Name
!Description
!Description
Line 22: Line 22:
|-
|-
| [[Api session event editor zoning remove|remove]]
| [[Api session event editor zoning remove|remove]]
| Remove a [[Zone]], and optionally its child [[Zone]]s.
| Remove a [[Zone]], and optionally its child [[Zone]]s
|-
|-
| [[Api session event editor zoning remove attribute|remove_attribute]]
| [[Api session event editor zoning remove attribute|remove_attribute]]
Line 37: Line 37:
|-
|-
| [[Api session event editor zoning set color|set_color]]
| [[Api session event editor zoning set color|set_color]]
| Set the color of a [[Zone]].
| Set the color of a [[Zone]]
|-
|-
| [[Api session event editor zoning set name|set_name]]
| [[Api session event editor zoning set name|set_name]]
| Set the name of a [[Zone]].
| Set the name of a [[Zone]]
|-
|-
| [[Api session event editor zoning set polygons|set_polygons]]
| [[Api session event editor zoning set polygons|set_polygons]]
| Set [[Polygon]]s to existing Zoning
| Set [[Polygon]]s to existing Zoning
|}
|}
 
<noinclude lang="text" copy>
Additional API Endpoints:
Additional API Endpoints:
{|class=wikitable
</noinclude>{|class=wikitable
!Name
!Name
!Description
!Description
|-
|-
| [[Api session event editor zoning add function category|add_function_category]]
| [[Api session event editor zoning add function category|add_function_category]]
| Add a permitted [[Function]] [[Category]] to a [[Category]] [[Zone]].
| Add a permitted [[Function]] [[Category]] to a [[Category]] [[Zone]]
|-
|-
| [[Api session event editor zoning remove function category|remove_function_category]]
| [[Api session event editor zoning remove function category|remove_function_category]]
| Remove a permitted [[Function]] [[Category]] from a [[Category]] [[Zone]].
| Remove a permitted [[Function]] [[Category]] from a [[Category]] [[Zone]]
|-
|-
| [[Api session event editor zoning set excel|set_excel]]
| [[Api session event editor zoning set excel|set_excel]]
| Set the [[Excel Sheet]] used by a [[Zone]] for Zoning Permits.
| Set the [[Excel Sheet]] used by a [[Zone]] for Zoning Permits
|-
|-
| [[Api session event editor zoning set parent|set_parent]]
| [[Api session event editor zoning set parent|set_parent]]
| Set the parent [[Zone]] of a [[Zone]].
| Set the parent [[Zone]] of a [[Zone]]
|-
|-
| [[Api session event editor zoning set permitter|set_permitter]]
| [[Api session event editor zoning set permitter|set_permitter]]
| Set the permitting [[Stakeholder]] of a [[Zone]].
| Set the permitting [[Stakeholder]] of a [[Zone]]
|}
|}
{{article end|seealso=*[[Api Session Endpoints]]
<noinclude lang="text" copy>{{article end|seealso=*[[Api Session Endpoints]]
*[[Api session items zones]]
*[[Api session items zones]]
}}
}}
 
</noinclude>
[[Category:API]]
[[Category:API]]

Latest revision as of 10:27, 13 November 2026

API Endpoint: api/session/event/editorzoning/

API Endpoints for Zoning editing.

Name Description
add Add a new Zone, optionally as Category Zone
add_polygons Add Polygons to existing Zoning
append_attribute Appended to existing Zoning numeric Attribute value
duplicate Duplicate existing Zoning
import Import Zone Collection
remove Remove a Zone, and optionally its child Zones
remove_attribute Remove numeric Attribute from Zoning
remove_polygons Remove Polygons from existing Zoning
set_attribute Set Zoning numeric Attribute value
set_attributes Set multiple Zoning numeric Attribute values
set_color Set the color of a Zone
set_name Set the name of a Zone
set_polygons Set Polygons to existing Zoning

Additional API Endpoints:

Name Description
add_function_category Add a permitted Function Category to a Category Zone
remove_function_category Remove a permitted Function Category from a Category Zone
set_excel Set the Excel Sheet used by a Zone for Zoning Permits
set_parent Set the parent Zone of a Zone
set_permitter Set the permitting Stakeholder of a Zone