Api session items specialoptions

From Tygron Support wiki
Revision as of 12:43, 20 April 2026 by Frank@tygron.nl (talk | contribs) (Replaced content with "Api session items Special Options Endpoints. Default Query: <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/specialoptions/?f=JSON&token=API_TOKEN</syntaxhighlight> Example Response: <syntaxhighlight lang="text" copy>[ { "defaults" : [ "MUNICIPALITY", "HOUSING_CORPORATION", "PROJECT_DEVELOPER", "FARMER", "EDUCATION", "HEALTHCARE", "CIVILIAN", "COMPANY" ], "description" : "Select the land you wish to buy.", "id" : 0, "imageNa...")
Jump to navigation Jump to search

Api session items Special Options Endpoints.

Default Query:

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

Example Response:

[ {
  "defaults" : [ "MUNICIPALITY", "HOUSING_CORPORATION", "PROJECT_DEVELOPER", "FARMER", "EDUCATION", "HEALTHCARE", "CIVILIAN", "COMPANY" ],
  "description" : "Select the land you wish to buy.",
  "id" : 0,
  "imageName" : "buy_land.png",
  "name" : "Buy land",
  "version" : 6
}, {
  "defaults" : [ "MUNICIPALITY", "HOUSING_CORPORATION", "PROJECT_DEVELOPER", "FARMER", "EDUCATION", "HEALTHCARE", "CIVILIAN", "COMPANY" ],
  "description" : "Select the land you would like to sell to another stakeholder.",
  "id" : 1,
  "imageName" : "sell_land.png",
  "name" : "Sell land",
  "version" : 7
} ]

Limit Queries

version=100:

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

Show Queries

max version:

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

size:

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

Formats

HTML:

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

JSON:

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

CSV:

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

SSV:

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

SMILE:

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

ZIPJSON:

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

ZIPSMILE:

https://engine.tygron.com/api/session/items/specialoptions/?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 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 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