Api session event participant: 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
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session event participant Endpoints.
<noinclude lang="text" copy>API Endpoint: api/session/event/participant/
 
</noinclude><noinclude lang="text" copy>
API Endpoints for Endpoints for user actions (e.g. build [[Building]]) in a testrun/impact [[Session]].
API Endpoints for Endpoints for user [[Action]]s (e.g., [[Building]] construction) in a test run/impact [[Session]]
{|class=wikitable
</noinclude>{|class=wikitable
!Name
!Name
!Description
!Description
|-
|-
|[[Api session event participant action menu set active|action_menu_set_active]]
| [[Api session event participant action menu set active|action_menu_set_active]]
|Set a category active for a [[Stakeholder]].
| Set an [[Action Menu]] active for a [[Stakeholder]]
|-
|-
|[[Api session event participant attribute action plan|attribute_action_plan]]
| [[Api session event participant attribute action plan|attribute_action_plan]]
|Apply an [[Attribute Action]].
| [[Stakeholder]] applies an [[Attribute Action]] within a [[MultiPolygon]]
|-
|-
|[[Api session event participant building plan construction|building_plan_construction]]
| [[Api session event participant building plan construction|building_plan_construction]]
|Plan a new [[Building]] in the MAQUETTE map.
| [[Stakeholder]] plans a new [[Building]] of a [[Function]] with an amount of floors and a [[MultiPolygon]]
|-
|-
|[[Api session event participant building plan demolish|building_plan_demolish]]
| [[Api session event participant building plan demolish|building_plan_demolish]]
|Plan the demolition of a [[Building]] in the MAQUETTE map.
| [[Stakeholder]] plan the demolition of an owned [[Building]]
|-
|-
|[[Api session event participant building plan demolish polygon|building_plan_demolish_polygon]]
| [[Api session event participant building plan demolish polygon|building_plan_demolish_polygon]]
|Plan the demolition of a [[Building]] in the given polygon in the MAQUETTE map.
| [[Stakeholder]] plans the demolition of [[Building]] parts intersecting a [[MultiPolygon]] in a particular [[Layer]]
|-
|-
|[[Api session event participant building plan upgrade|building_plan_upgrade]]
| [[Api session event participant building plan upgrade|building_plan_upgrade]]
|Plan the upgrade of [[Building]] in the given polygon in the MAQUETTE map.
| [[Stakeholder]] plans the upgrade of [[Building]]s within a [[MultiPolygon]]
|-
|-
|[[Api session event participant building revert polygon|building_revert_polygon]]
| [[Api session event participant building revert polygon|building_revert_polygon]]
|Revert polygon to orginal CURRENT map situation.
| [[Stakeholder]] reverts demolished, changed and planned [[Building]]s within a [[MultiPolygon]] back to their original state
|-
|-
|[[Api session event participant event bundle apply server events|event_bundle_apply_server_events]]
| [[Api session event participant event bundle apply server events|event_bundle_apply_server_events]]
|Apply a bundle of events on the serverside for a particular [[Stakeholder]].
| [[Stakeholder]] applies server side events of an [[Event Bundle]]
|-
|-
|[[Api session event participant map buy land|map_buy_land]]
| [[Api session event participant map buy land|map_buy_land]]
|Buy the land definied by the polygon for given price.
| [[Stakeholder]] plans a land purchase with in the [[MultiPolygon]] for a given price
|-
|-
|[[Api session event participant map levee|map_levee]]
| [[Api session event participant map levee|map_levee]]
|Create a [[Levee]] with a given height and [[Area]].
| [[Stakeholder]] plans a [[Levee]] for a [[MultiPolygon]], an absolute or relative height and an angle
|-
|-
|[[Api session event participant map lower land|map_lower_land]]
| [[Api session event participant map lower land|map_lower_land]]
|Lower land to create open water.
| [[Stakeholder]] lowers land and adds a waterway
|-
|-
|[[Api session event participant map raise land|map_raise_land]]
| [[Api session event participant map raise land|map_raise_land]]
|Raise land by one length unit.
| [[Stakeholder]] raises land within the [[MultiPolygon]] by one meter and removes water
|-
|-
|[[Api session event participant map sell land|map_sell_land]]
| [[Api session event participant map sell land|map_sell_land]]
|Buy the land definied by the polygon for given price.
| [[Stakeholder]] plans to sell owned land within the [[MultiPolygon]] to another [[Stakeholder]] for a given price
|-
|-
|[[Api session event participant measure cancel construction|measure_cancel_construction]]
| [[Api session event participant measure cancel construction|measure_cancel_construction]]
|Cancel a [[Measure]] planned by an [[Stakeholder]] while in pre-construction phase.
| [[Stakeholder]] cancels a planned [[Measure]]
|-
|-
|[[Api session event participant measure plan construction|measure_plan_construction]]
| [[Api session event participant measure plan construction|measure_plan_construction]]
|Plan construction of a [[Measure]] by an [[Stakeholder]] that is not yet planned.
| [[Stakeholder]] plans a [[Measure]]
|-
|-
|[[Api session event participant money transfer give|money_transfer_give]]
| [[Api session event participant money transfer give|money_transfer_give]]
|Give money from one [[Stakeholder]] to another.
| [[Stakeholder]] transfers money to another [[Stakeholder]]
|-
|-
|[[Api session event participant net cluster set load attribute|net_cluster_set_load_attribute]]
| [[Api session event participant net cluster set load attribute|net_cluster_set_load_attribute]]
|For each [[Net Load]] of a [[Net Cluster]], set the value of the attribute.
| [[Stakeholder]] sets an [[Attribute]] to a value, for each [[Net Load]] of a [[Net Cluster]]
|-
|-
|[[Api session event participant net cluster set load attributes|net_cluster_set_load_attributes]]
| [[Api session event participant net cluster set load attributes|net_cluster_set_load_attributes]]
|For each [[Net Load]] of a [[Net Cluster]], set the value of the attribute.
| [[Stakeholder]] sets set the value of the [[Attribute]]s for each [[Net Load]] of a [[Net Cluster]]
|-
|-
|[[Api session event participant net cluster set state|net_cluster_set_state]]
| [[Api session event participant net cluster set state|net_cluster_set_state]]
|Set [[Timestate]] for all [[Net Load]] of [[Net Cluster]].
| [[Stakeholder]] sets the [[Net state]] for all [[Net Load]]s of a [[Net Cluster]]
|-
|-
|[[Api session event participant net cluster set state for net type|net_cluster_set_state_for_net_type]]
| [[Api session event participant net cluster set state for net type|net_cluster_set_state_for_net_type]]
|Set [[Timestate]] for [[Net Load]] of [[Net Cluster]], based on [[Net Type]].
| [[Stakeholder]] sets the [[Net state]] for [[Net Load]]s of a [[Net Cluster]] and [[Net Type]]
|-
|-
|[[Api session event participant net cluster set states|net_cluster_set_states]]
| [[Api session event participant net cluster set states|net_cluster_set_states]]
|Set [[Timestate]] for all [[Net Load]] of [[Net Cluster]].
| [[Stakeholder]] sets the [[Net state]] for all [[Net Load]]s of a [[Net Cluster]], per [[Net Type]]
|-
|-
|[[Api session event participant panel answer|panel_answer]]
| [[Api session event participant panel answer|panel_answer]]
|[[Stakeholder]] has selected an answer in a [[Panel]].
| [[Stakeholder]] selects an [[Answer (Panel)|Answer]] in a [[Panel]]
|-
|-
|[[Api session event participant parametric design plan|parametric_design_plan]]
| [[Api session event participant parametric design plan|parametric_design_plan]]
|[[Parametric Design]] Plan
| [[Stakeholder]] plans a generated [[Parametric Design]]
|-
|-
|[[Api session event participant popup answer|popup_answer]]
| [[Api session event participant popup answer|popup_answer]]
|[[Stakeholder]] answers a [[Popup]].
| [[Stakeholder]] answers a [[Popup]]
|-
|-
|[[Api session event participant popup answer with date|popup_answer_with_date]]
| [[Api session event participant popup answer with date|popup_answer_with_date]]
|[[Stakeholder]] answers a [[Popup]] with an additional date.
| [[Stakeholder]] answers a [[Popup]] with an additional date
|-
|-
|[[Api session event participant restore land|restore_land]]
| [[Api session event participant restore land|restore_land]]
|[[Stakeholder]] restores land back to orginal state.
| [[Stakeholder]] creates a [[Measure]] that removes water [[Terrain]]s and flatten its land using a [[MultiPolygon]]
|-
|-
|[[Api session event participant stakeholder set location|stakeholder_set_location]]
| [[Api session event participant stakeholder set location|stakeholder_set_location]]
|Set the location of a [[Stakeholder]] in the 3D world.
| [[Stakeholder]]'s view is moved to the location in the [[3D Visualization]]
|-
|-
|[[Api session event participant zone add function category|zone_add_function_category]]
| [[Api session event participant zone add function category|zone_add_function_category]]
|Add a [[Function]][[Category]] that is allowed to be built within a [[Zone]].
| [[Stakeholder]] adds an allowed [[Function]] [[Category]] to a [[Zone]]
|-
|-
|[[Api session event participant zone remove function category|zone_remove_function_category]]
| [[Api session event participant zone remove function category|zone_remove_function_category]]
|Remove a [[Function]][[Category]] so it cannot be build within the [[Zone]].
| [[Stakeholder]] removes an allowed [[Function]] [[Category]] from a [[Zone]]
|-
|-
|[[Api session event participant zones set categories|zones_set_categories]]
| [[Api session event participant zones set categories|zones_set_categories]]
|Sets the allowed [[Building]] categories for specified [[Zone]].
| [[Stakeholder]] sets the allowed [[Function]] Categories per specified [[Zone]]
|}
|}
{{article end|seealso=*[[Api Events]]
<noinclude lang="text" copy>{{article end|seealso=*[[Api Session Endpoints]]
}}
}}
 
</noinclude>
[[Category:API]]
[[Category:API]]

Latest revision as of 10:27, 13 November 2026

API Endpoint: api/session/event/participant/

API Endpoints for Endpoints for user Actions (e.g., Building construction) in a test run/impact Session

Name Description
action_menu_set_active Set an Action Menu active for a Stakeholder
attribute_action_plan Stakeholder applies an Attribute Action within a MultiPolygon
building_plan_construction Stakeholder plans a new Building of a Function with an amount of floors and a MultiPolygon
building_plan_demolish Stakeholder plan the demolition of an owned Building
building_plan_demolish_polygon Stakeholder plans the demolition of Building parts intersecting a MultiPolygon in a particular Layer
building_plan_upgrade Stakeholder plans the upgrade of Buildings within a MultiPolygon
building_revert_polygon Stakeholder reverts demolished, changed and planned Buildings within a MultiPolygon back to their original state
event_bundle_apply_server_events Stakeholder applies server side events of an Event Bundle
map_buy_land Stakeholder plans a land purchase with in the MultiPolygon for a given price
map_levee Stakeholder plans a Levee for a MultiPolygon, an absolute or relative height and an angle
map_lower_land Stakeholder lowers land and adds a waterway
map_raise_land Stakeholder raises land within the MultiPolygon by one meter and removes water
map_sell_land Stakeholder plans to sell owned land within the MultiPolygon to another Stakeholder for a given price
measure_cancel_construction Stakeholder cancels a planned Measure
measure_plan_construction Stakeholder plans a Measure
money_transfer_give Stakeholder transfers money to another Stakeholder
net_cluster_set_load_attribute Stakeholder sets an Attribute to a value, for each Net Load of a Net Cluster
net_cluster_set_load_attributes Stakeholder sets set the value of the Attributes for each Net Load of a Net Cluster
net_cluster_set_state Stakeholder sets the Net state for all Net Loads of a Net Cluster
net_cluster_set_state_for_net_type Stakeholder sets the Net state for Net Loads of a Net Cluster and Net Type
net_cluster_set_states Stakeholder sets the Net state for all Net Loads of a Net Cluster, per Net Type
panel_answer Stakeholder selects an Answer in a Panel
parametric_design_plan Stakeholder plans a generated Parametric Design
popup_answer Stakeholder answers a Popup
popup_answer_with_date Stakeholder answers a Popup with an additional date
restore_land Stakeholder creates a Measure that removes water Terrains and flatten its land using a MultiPolygon
stakeholder_set_location Stakeholder's view is moved to the location in the 3D Visualization
zone_add_function_category Stakeholder adds an allowed Function Category to a Zone
zone_remove_function_category Stakeholder removes an allowed Function Category from a Zone
zones_set_categories Stakeholder sets the allowed Function Categories per specified Zone

See also

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