Api session items specialoptions: 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
46,429 edits
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..."
Tag: Replaced
No edit summary
Tag: Manual revert
 
(21 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session items [[Special Option]]s Endpoints.
API Endpoint: /api/session/items/specialoptions/


Default Query:
Default Query:
Line 10: Line 10:
   "imageName" : "buy_land.png",
   "imageName" : "buy_land.png",
   "name" : "Buy land",
   "name" : "Buy land",
   "version" : 6
   "version" : 1
}, {
}, {
   "defaults" : [ "MUNICIPALITY", "HOUSING_CORPORATION", "PROJECT_DEVELOPER", "FARMER", "EDUCATION", "HEALTHCARE", "CIVILIAN", "COMPANY" ],
   "defaults" : [ "MUNICIPALITY", "HOUSING_CORPORATION", "PROJECT_DEVELOPER", "FARMER", "EDUCATION", "HEALTHCARE", "CIVILIAN", "COMPANY" ],
Line 17: Line 17:
   "imageName" : "sell_land.png",
   "imageName" : "sell_land.png",
   "name" : "Sell land",
   "name" : "Sell land",
   "version" : 7
   "version" : 2
} ]</syntaxhighlight>
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
version=100:  
version=100:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/specialoptions/?version=100&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/specialoptions/?version=100&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Get Queries==
attributes:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/specialoptions/attributes/?token=API_TOKEN</syntaxhighlight>
max version:  
max version:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/specialoptions/version/?token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/specialoptions/version/?token=API_TOKEN</syntaxhighlight>
size:  
count:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/specialoptions/size/?token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/specialoptions/count/?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  
Line 42: Line 44:
ZIPSMILE:  
ZIPSMILE:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/specialoptions/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/specialoptions/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
==Api Model ActionMenu==
==Api Model SpecialOption==
API Model description of ActionMenu
API Model description of SpecialOption


{|class=wikitable
{|class=wikitable
Line 50: Line 52:
!Description
!Description
|-
|-
|attributeActionIDs
| defaults
|int<nowiki>[]</nowiki>
| Type<nowiki>[]</nowiki>
|[[Attribute Action]] ID
|  
|-
|-
|buildable
| description
|Map&lt;int,java.util.List<java.lang.Integer>&gt;
| String
|
|  
|-
|-
|color
| id
|TColor
| int
|
|  
|-
|-
|eventBundleIDs
| imageName
|int<nowiki>[]</nowiki>
| String
|[[Event Bundle]] ID
|  
|-
|-
|functionIDs
| name
|int<nowiki>[]</nowiki>
| String
|[[Function]] ID
|  
|-
|-
|id
| version
|int
| int
|
|  
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|leveeIDs
|int<nowiki>[]</nowiki>
|[[Levee]] ID
|-
|measureIDs
|int<nowiki>[]</nowiki>
|[[Measure]] ID
|-
|name
|String
|
|-
|sortIndex
|int
|
|-
|specialOptions
|Type<nowiki>[]</nowiki>
|
|-
|upgradeIDs
|int<nowiki>[]</nowiki>
|[[Upgrade Type]] ID
|-
|version
|int
|
|}
|}


==Api Model Group (SpecialOption)==
==Api Model Type (Stakeholder)==
API Enumeration description of Group
API Enumeration description of Type


{|class=wikitable
{|class=wikitable
Line 118: Line 84:
!Description
!Description
|-
|-
|LAND
| CIVILIAN
|
|  
|-
|-
|SCULPTING
| COMPANY
|
|  
|-
|-
|FINANCE
| EDUCATION
|
|  
|-
|-
|DEMOLISH
| EXPERT
|
|  
|}
 
==Api Model SpecialOption==
API Model description of SpecialOption
 
{|class=wikitable
!Name
!Type
!Description
|-
|defaults
|Type<nowiki>[]</nowiki>
|
|-
|description
|String
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|name
|String
|
|-
|-
|version
| FARMER
|int
|  
|
|}
 
==Api Model Type (SpecialOption)==
API Enumeration description of Type
 
{|class=wikitable
!Name
!Description
|-
|-
|BUY_LAND
| HEALTHCARE
|
|  
|-
|-
|SELL_LAND
| HOUSING_CORPORATION
|
|  
|-
|-
|DEMOLISH
| MUNICIPALITY
|
|  
|-
|-
|REVERT
| MEDIA
|
|  
|-
|-
|DEMOLISH_UNDERGROUND
| PROJECT_DEVELOPER
|
|  
|-
|-
|RAISE_LAND
| UTILITY_CORPORATION
|
|  
|-
|-
|SHOW_BUDGETPANEL
| WATER_AUTHORITY
|
|  
|-
|-
|SHOW_MONEY_TRANSFER_PANEL
| OTHER_AUTHORITY
|
|  
|-
|-
|LOWER_LAND
| OTHER
|
|  
|}
|}


Line 204: Line 132:


[[Category:API]]
[[Category:API]]
[[Category:Items]]

Latest revision as of 07:06, 14 July 2026

API Endpoint: /api/session/items/specialoptions/

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" : 1
}, {
  "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" : 2
} ]

Limit Queries

version=100: 

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

Get Queries

attributes: 

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

max version: 

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

count: 

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

API Model description of SpecialOption

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

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

See also

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