Api session event editor stakeholder: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 7: | Line 7: | ||
|- | |- | ||
| [[Api session event editor stakeholder add|add]] | | [[Api session event editor stakeholder add|add]] | ||
| Add new [[Stakeholder]] | | Add a new [[Stakeholder]] | ||
|- | |- | ||
| [[Api session event editor stakeholder duplicate|duplicate]] | | [[Api session event editor stakeholder duplicate|duplicate]] | ||
| Line 16: | Line 16: | ||
|- | |- | ||
| [[Api session event editor stakeholder set active|set_active]] | | [[Api session event editor stakeholder set active|set_active]] | ||
| Set [[Stakeholder]] active | | Set whether a [[Stakeholder]] is an active participant of a [[Session]]. | ||
|- | |- | ||
| [[Api session event editor stakeholder set color|set_color]] | | [[Api session event editor stakeholder set color|set_color]] | ||
| Set | | Set the Color of a [[Stakeholder]]. | ||
|- | |- | ||
| [[Api session event editor stakeholder set name|set_name]] | | [[Api session event editor stakeholder set name|set_name]] | ||
| Set | | Set the name of a [[Stakeholder]]. | ||
|} | |} | ||
| Line 31: | Line 31: | ||
|- | |- | ||
| [[Api session event editor stakeholder add land ownership|add_land_ownership]] | | [[Api session event editor stakeholder add land ownership|add_land_ownership]] | ||
| | | Assign land to a particular [[Stakeholder]] | ||
|- | |- | ||
| [[Api session event editor stakeholder add with type and active|add_with_type_and_active]] | | [[Api session event editor stakeholder add with type and active|add_with_type_and_active]] | ||
| Add | | Add a new (active) [[Stakeholder]]. | ||
|- | |- | ||
| [[Api session event editor stakeholder select stakeholder|select_stakeholder]] | | [[Api session event editor stakeholder select stakeholder|select_stakeholder]] | ||
| Line 40: | Line 40: | ||
|- | |- | ||
| [[Api session event editor stakeholder set image|set_image]] | | [[Api session event editor stakeholder set image|set_image]] | ||
| Set | | Set the image of a [[Stakeholder]]. | ||
|- | |- | ||
| [[Api session event editor stakeholder set short name|set_short_name]] | | [[Api session event editor stakeholder set short name|set_short_name]] | ||
| Set | | Set the short name of a [[Stakeholder]]. | ||
|- | |- | ||
| [[Api session event editor stakeholder set start budget|set_start_budget]] | | [[Api session event editor stakeholder set start budget|set_start_budget]] | ||
| Set | | Set the start budget of a [[Stakeholder]]. | ||
|- | |- | ||
| [[Api session event editor stakeholder set type|set_type]] | | [[Api session event editor stakeholder set type|set_type]] | ||
| Set | | Set the type of a [[Stakeholder]]. | ||
|- | |- | ||
| [[Api session event editor stakeholder transfer ownership|transfer_ownership]] | | [[Api session event editor stakeholder transfer ownership|transfer_ownership]] | ||
| Transfer | | Transfer the ownership of [[Building]]s and [[Plot]]s from one [[Stakeholder]] to an other [[Stakeholder]]. Optionally include [[Zone]]s. | ||
|- | |- | ||
| [[Web token|reset_web_token]] | | [[Web token|reset_web_token]] | ||
| Reset Web Token | | Reset the Web Token of a [[Stakeholder]] and generate a new one with a default length. | ||
|- | |- | ||
| [[Web token with length|reset_web_token_with_length]] | | [[Web token with length|reset_web_token_with_length]] | ||
| Reset Web Token | | Reset the Web Token of a [[Stakeholder]] and generate new one with a particular length. | ||
|} | |} | ||
{{article end|seealso=*[[Api Session Endpoints]] | {{article end|seealso=*[[Api Session Endpoints]] | ||
Revision as of 15:32, 10 November 2026
API Endpoint: api/session/event/editorstakeholder/
API Endpoints for Stakeholder editing.
| Name | Description |
|---|---|
| add | Add a new Stakeholder |
| duplicate | Duplicate existing Stakeholder |
| remove | Remove existing Stakeholder |
| set_active | Set whether a Stakeholder is an active participant of a Session. |
| set_color | Set the Color of a Stakeholder. |
| set_name | Set the name of a Stakeholder. |
Additional API Endpoints:
| Name | Description |
|---|---|
| add_land_ownership | Assign land to a particular Stakeholder |
| add_with_type_and_active | Add a new (active) Stakeholder. |
| select_stakeholder | Select Stakeholder using the preferred ID; if unavailable, fall back to the next best option. |
| set_image | Set the image of a Stakeholder. |
| set_short_name | Set the short name of a Stakeholder. |
| set_start_budget | Set the start budget of a Stakeholder. |
| set_type | Set the type of a Stakeholder. |
| transfer_ownership | Transfer the ownership of Buildings and Plots from one Stakeholder to an other Stakeholder. Optionally include Zones. |
| reset_web_token | Reset the Web Token of a Stakeholder and generate a new one with a default length. |
| reset_web_token_with_length | Reset the Web Token of a Stakeholder and generate new one with a particular length. |