Api session event participant: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
API Endpoint: api/session/event/participant/ | <noinclude lang="text" copy>API Endpoint: api/session/event/participant/ | ||
</noinclude><noinclude lang="text" copy> | |||
API Endpoints for Endpoints for user [[Action]]s (e.g., [[Building]] construction) in a test run/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 an [[Action Menu]] 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]] | ||
| [[Stakeholder]] applies an [[Attribute Action]] within a [[MultiPolygon]] | | [[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]] | ||
| [[Stakeholder]] plans a new [[Building]] of a [[Function]] with an amount of floors and a [[MultiPolygon]] | | [[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]] | ||
| [[Stakeholder]] plan the demolition of an owned [[Building]] | | [[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]] | ||
| [[Stakeholder]] plans the demolition of [[Building]] parts intersecting a [[MultiPolygon]] in a particular [[Layer]] | | [[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]] | ||
| [[Stakeholder]] plans the upgrade of [[Building]]s within a [[MultiPolygon]] | | [[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]] | ||
| [[Stakeholder]] reverts demolished, changed and planned [[Building]]s within a [[MultiPolygon]] back to their original state | | [[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]] | ||
| [[Stakeholder]] applies server side events of an [[Event Bundle]] | | [[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]] | ||
| [[Stakeholder]] plans a land purchase with in the [[MultiPolygon]] for a 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]] | ||
| [[Stakeholder]] plans a [[Levee]] for a [[MultiPolygon]], an absolute or relative height and an angle | | [[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]] | ||
| [[Stakeholder]] lowers land and adds a waterway | | [[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]] | ||
| [[Stakeholder]] raises land within the [[MultiPolygon]] by one meter and removes water | | [[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]] | ||
| [[Stakeholder]] plans to sell owned land within the [[MultiPolygon]] to another [[Stakeholder]] for a 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]] | ||
| [[Stakeholder]] cancels a planned [[Measure]] | | [[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]] | ||
| [[Stakeholder]] plans a [[Measure]] | | [[Stakeholder]] plans a [[Measure]] | ||
|- | |- | ||
| [[Api session event participant money transfer give|money_transfer_give]] | | [[Api session event participant money transfer give|money_transfer_give]] | ||
| [[Stakeholder]] transfers money to another [[Stakeholder]] | | [[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]] | ||
| [[Stakeholder]] sets an [[Attribute]] to a value, for each [[Net Load]] of a [[Net Cluster]] | | [[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]] | ||
| [[Stakeholder]] sets set the value of the [[Attribute]]s for each [[Net Load]] of a [[Net Cluster]] | | [[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]] | ||
| [[Stakeholder]] sets the [[Net state]] for all [[Net Load]]s of a [[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]] | ||
| [[Stakeholder]] sets the [[Net state]] for [[Net Load]]s of a [[Net Cluster]] and [[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]] | ||
| [[Stakeholder]] sets the [[Net state]] for all [[Net Load]]s of a [[Net Cluster]], per [[Net Type]] | | [[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]] selects an [[Answer (Panel)]] 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]] | ||
| [[Stakeholder]] plans a generated [[Parametric Design]] | | [[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]] creates a [[Measure]] that removes water [[Terrain]]s and flatten its land using a [[MultiPolygon]] | | [[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]] | ||
| [[Stakeholder]]'s view is moved to the location in the [[3D Visualization]] | | [[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]] | ||
| [[Stakeholder]] adds an allowed [[Function]] [[Category]] to 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]] | ||
| [[Stakeholder]] removes an allowed [[Function]] [[Category]] from a [[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]] | ||
| [[Stakeholder]] sets the allowed [[Function]] Categories per specified [[Zone]] | | [[Stakeholder]] sets the allowed [[Function]] Categories per specified [[Zone]] | ||
|} | |} | ||
{{article end|seealso=*[[Api Session Endpoints]] | <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