Api session items stakeholders

From Tygron Support wiki
Revision as of 12:43, 20 April 2026 by Frank@tygron.nl (talk | contribs) (Replaced content with "Api session items Stakeholder Endpoints. Edit items with event: editorstakeholder. Default Query: <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/stakeholders/?f=JSON&token=API_TOKEN</syntaxhighlight> Example Response: <syntaxhighlight lang="text" copy>[ { "active" : true, "client" : null, "color" : { "argb" : -3355444 }, "id" : 0, "imageName" : "municipality.png", "imageVe...")
Jump to navigation Jump to search

Api session items Stakeholder Endpoints.

Edit items with event: editorstakeholder.

Default Query:

https://engine.tygron.com/api/session/items/stakeholders/?f=JSON&token=API_TOKEN

Example Response:

[ {
  "active" : true,
  "client" : null,
  "color" : {
    "argb" : -3355444
  },
  "id" : 0,
  "imageName" : "municipality.png",
  "imageVersion" : 0,
  "lastSelected" : 1774446787083,
  "name" : "Municipality Arnhem",
  "shortName" : "Arnhem",
  "startBudget" : 0.0,
  "startBudgets" : {
    "0" : 1000000.0
  },
  "startCinematics" : {
    "0" : 0
  },
  "startPoint" : null,
  "type" : "MUNICIPALITY",
  "version" : 6,
  "webToken" : "RHVXnEVpNcbfEBNQKWmwxAXQ"
}, {
  "active" : true,
  "client" : null,
  "color" : {
    "argb" : -360334
  },
  "id" : 1,
  "imageName" : "civilian.png",
  "imageVersion" : 0,
  "lastSelected" : 1741957674390,
  "name" : "Inhabitants",
  "shortName" : "Inhabitants",
  "startBudget" : 0.0,
  "startBudgets" : {
    "0" : 0.0
  },
  "startCinematics" : {
    "0" : 0
  },
  "startPoint" : null,
  "type" : "CIVILIAN",
  "version" : 5,
  "webToken" : "NZPc6qRkfTYYjmDPjywXADjj"
} ]

Limit Queries

version=100:

https://engine.tygron.com/api/session/items/stakeholders/?version=100&token=API_TOKEN

Show Queries

max version:

https://engine.tygron.com/api/session/items/stakeholders/version/?token=API_TOKEN

size:

https://engine.tygron.com/api/session/items/stakeholders/size/?token=API_TOKEN

Formats

HTML:

https://engine.tygron.com/api/session/items/stakeholders/?f=HTML&token=API_TOKEN

JSON:

https://engine.tygron.com/api/session/items/stakeholders/?f=JSON&token=API_TOKEN

CSV:

https://engine.tygron.com/api/session/items/stakeholders/?f=CSV&token=API_TOKEN

SSV:

https://engine.tygron.com/api/session/items/stakeholders/?f=SSV&token=API_TOKEN

SMILE:

https://engine.tygron.com/api/session/items/stakeholders/?f=SMILE&token=API_TOKEN

ZIPJSON:

https://engine.tygron.com/api/session/items/stakeholders/?f=ZIPJSON&token=API_TOKEN

ZIPSMILE:

https://engine.tygron.com/api/session/items/stakeholders/?f=ZIPSMILE&token=API_TOKEN

Api Model ActionMenu

API Model description of ActionMenu

Name Type Description
attributeActionIDs int[] Attribute Action ID
buildable Map<int,java.util.List<java.lang.Integer>>
color TColor
eventBundleIDs int[] Event Bundle ID
functionIDs int[] Function ID
id int
imageName String
imageVersion int
leveeIDs int[] Levee ID
measureIDs int[] Measure ID
name String
sortIndex int
specialOptions Type[]
upgradeIDs int[] Upgrade Type ID
version int

Api Model BaseFunction

API Model description of BaseFunction

Name Type Description
attributes Map<String,double[]>
categories Category[]
constructionPeriods ConstructionPeriod[]
decals Map<FaceType,float[]>
defaults Type[]
description String
dimension int
id int
imageName String
modelSetID int Model Set ID
name String
placementType PlacementType
regions Region[]
textures Map<FaceType,String>
version int

Api Model Group (SpecialOption)

API Enumeration description of Group

Name Description
LAND
SCULPTING
FINANCE
DEMOLISH

Api Model SpecialOption

API Model description of SpecialOption

Name Type Description
defaults Type[]
description String
id int
imageName String
name String
version int

Api Model Stakeholder

API Model description of Stakeholder

Name Type Description
active boolean
client ClientData
color TColor
id int
imageName String
imageVersion int
lastSelected long
name String
shortName String
startBudget double
startBudgets Map<int,double>
startCinematics Map<int,int>
startPoint Point
type Type
version int
webToken String

Api Model Type (SpecialOption)

API Enumeration description of Type

Name Description
BUY_LAND
SELL_LAND
DEMOLISH
REVERT
DEMOLISH_UNDERGROUND
RAISE_LAND
SHOW_BUDGETPANEL
SHOW_MONEY_TRANSFER_PANEL
LOWER_LAND

Api Model Type (Stakeholder)

API Enumeration description of Type

Name Description
CIVILIAN
COMPANY
EDUCATION
EXPERT
FARMER
HEALTHCARE
HOUSING_CORPORATION
MUNICIPALITY
MEDIA
PROJECT_DEVELOPER
UTILITY_CORPORATION
WATER_AUTHORITY
OTHER_AUTHORITY
OTHER