Api session items actionmenus: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Interface administrators, Administrators
34,718 edits
No edit summary
No edit summary
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session items [[Action Menu]]s Endpoints.
Api session items [[Action Menu]]s Endpoints.


Manipulate items with event: [[Api session event editor actionmenu|editoractionmenu]].
Edit items with event: [[Api session event editor actionmenu|editoractionmenu]].


Default Query:
Default Query:
<pre>https://engine.tygron.com/api/session/items/actionmenus/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/actionmenus/?f=JSON&token=API_TOKEN</syntaxhighlight>
Example Response:
Example Response:
<pre>[ {
<syntaxhighlight lang="text" copy>[ {
   "attributeActionIDs" : [ ],
   "attributeActionIDs" : [ ],
   "buildable" : {
   "buildable" : {
Line 42: Line 42:
   "upgradeIDs" : [ ],
   "upgradeIDs" : [ ],
   "version" : 17
   "version" : 17
} ]</pre>
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
version=100:  
version=100:  
<pre>https://engine.tygron.com/api/session/items/actionmenus/?version=100&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/actionmenus/?version=100&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Show Queries==
max version:  
max version:  
<pre>https://engine.tygron.com/api/session/items/actionmenus/version/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/actionmenus/version/?token=API_TOKEN</syntaxhighlight>
size:  
size:  
<pre>https://engine.tygron.com/api/session/items/actionmenus/size/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/actionmenus/size/?token=API_TOKEN</syntaxhighlight>
Action Menus (GeoJSON):  
Action Menus (GeoJSON):  
<pre>https://engine.tygron.com/web/actionmenus.geojson?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/actionmenus.geojson?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  
<pre>https://engine.tygron.com/api/session/items/actionmenus/?f=HTML&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/actionmenus/?f=HTML&token=API_TOKEN</syntaxhighlight>
JSON:  
JSON:  
<pre>https://engine.tygron.com/api/session/items/actionmenus/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/actionmenus/?f=JSON&token=API_TOKEN</syntaxhighlight>
CSV:  
CSV:  
<pre>https://engine.tygron.com/api/session/items/actionmenus/?f=CSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/actionmenus/?f=CSV&token=API_TOKEN</syntaxhighlight>
SSV:  
SSV:  
<pre>https://engine.tygron.com/api/session/items/actionmenus/?f=SSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/actionmenus/?f=SSV&token=API_TOKEN</syntaxhighlight>
SMILE:  
SMILE:  
<pre>https://engine.tygron.com/api/session/items/actionmenus/?f=SMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/actionmenus/?f=SMILE&token=API_TOKEN</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<pre>https://engine.tygron.com/api/session/items/actionmenus/?f=ZIPJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/actionmenus/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<pre>https://engine.tygron.com/api/session/items/actionmenus/?f=ZIPSMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/actionmenus/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
==Api Model ActionMenu==
API Model description of ActionMenu
 
{|class=wikitable
!Name
!Type
!Description
|-
|attributeActionIDs
|int<nowiki>[]</nowiki>
|[[Attribute Action]] ID
|-
|buildable
|Map&lt;int,java.util.List<java.lang.Integer>&gt;
|
|-
|color
|TColor
|
|-
|eventBundleIDs
|int<nowiki>[]</nowiki>
|[[Event Bundle]] ID
|-
|functionIDs
|int<nowiki>[]</nowiki>
|[[Function]] ID
|-
|id
|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 TColor==
API Model description of TColor
 
{|class=wikitable
!Name
!Type
!Description
|}
 
==Api Model Type (SpecialOption)==
API Enumeration description of Type
 
{|class=wikitable
!Name
!Description
|-
|BUY_LAND
|
|-
|SELL_LAND
|
|-
|DEMOLISH
|
|-
|REVERT
|
|-
|DEMOLISH_UNDERGROUND
|
|-
|RAISE_LAND
|
|-
|SHOW_BUDGETPANEL
|
|-
|SHOW_MONEY_TRANSFER_PANEL
|
|-
|LOWER_LAND
|
|}
 
{{article end|seealso=*[[Api Content Items]]
{{article end|seealso=*[[Api Content Items]]
*[[Api session event editor actionmenu]]
*[[Api session event editor actionmenu]]
Line 73: Line 186:


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

Latest revision as of 14:14, 24 April 2026

Api session items Action Menus Endpoints.

Edit items with event: editoractionmenu.

Default Query: 

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

Example Response: 

[ {
  "attributeActionIDs" : [ ],
  "buildable" : {
    "0" : [ 0 ]
  },
  "color" : null,
  "eventBundleIDs" : [ ],
  "functionIDs" : [ 436, 438 ],
  "id" : 0,
  "imageName" : "category_road.png",
  "imageVersion" : 0,
  "leveeIDs" : [ ],
  "measureIDs" : [ ],
  "name" : "Roads",
  "sortIndex" : 1,
  "specialOptions" : [ ],
  "upgradeIDs" : [ ],
  "version" : 16
}, {
  "attributeActionIDs" : [ ],
  "buildable" : {
    "0" : [ 0 ]
  },
  "color" : null,
  "eventBundleIDs" : [ ],
  "functionIDs" : [ 77 ],
  "id" : 1,
  "imageName" : "category_heart.png",
  "imageVersion" : 0,
  "leveeIDs" : [ ],
  "measureIDs" : [ ],
  "name" : "Leisure",
  "sortIndex" : 2,
  "specialOptions" : [ ],
  "upgradeIDs" : [ ],
  "version" : 17
} ]

Limit Queries

version=100: 

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

Show Queries

max version: 

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

size: 

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

Action Menus (GeoJSON): 

https://engine.tygron.com/web/actionmenus.geojson?token=API_TOKEN

Formats

HTML: 

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

JSON: 

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

CSV: 

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

SSV: 

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

SMILE: 

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

ZIPJSON: 

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

ZIPSMILE: 

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

API Model description of TColor

Name Type Description

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

See also

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