Api session items specialoptions: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (8 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
Api session items [[Special Option]]s Endpoints. | Api session items [[Special Option]]s Endpoints. | ||
Default Query: | Default Query: | ||
| Line 12: | Line 10: | ||
"imageName" : "buy_land.png", | "imageName" : "buy_land.png", | ||
"name" : "Buy land", | "name" : "Buy land", | ||
"version" : | "version" : 7 | ||
}, { | }, { | ||
"defaults" : [ "MUNICIPALITY", "HOUSING_CORPORATION", "PROJECT_DEVELOPER", "FARMER", "EDUCATION", "HEALTHCARE", "CIVILIAN", "COMPANY" ], | "defaults" : [ "MUNICIPALITY", "HOUSING_CORPORATION", "PROJECT_DEVELOPER", "FARMER", "EDUCATION", "HEALTHCARE", "CIVILIAN", "COMPANY" ], | ||
| Line 19: | Line 17: | ||
"imageName" : "sell_land.png", | "imageName" : "sell_land.png", | ||
"name" : "Sell land", | "name" : "Sell land", | ||
"version" : | "version" : 5 | ||
} ]</syntaxhighlight> | } ]</syntaxhighlight> | ||
==Limit Queries== | ==Limit Queries== | ||
| Line 44: | Line 42: | ||
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 SpecialOption== | |||
API Model description of SpecialOption | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
|defaults | |||
|Type<nowiki>[]</nowiki> | |||
| | |||
|- | |||
|description | |||
|String | |||
| | |||
|- | |||
|id | |||
|int | |||
| | |||
|- | |||
|imageName | |||
|String | |||
| | |||
|- | |||
|name | |||
|String | |||
| | |||
|- | |||
|version | |||
|int | |||
| | |||
|} | |||
==Api Model Type (Stakeholder)== | |||
API Enumeration description of Type | |||
{|class=wikitable | |||
!Name | |||
!Description | |||
|- | |||
|CIVILIAN | |||
| | |||
|- | |||
|COMPANY | |||
| | |||
|- | |||
|EDUCATION | |||
| | |||
|- | |||
|EXPERT | |||
| | |||
|- | |||
|FARMER | |||
| | |||
|- | |||
|HEALTHCARE | |||
| | |||
|- | |||
|HOUSING_CORPORATION | |||
| | |||
|- | |||
|MUNICIPALITY | |||
| | |||
|- | |||
|MEDIA | |||
| | |||
|- | |||
|PROJECT_DEVELOPER | |||
| | |||
|- | |||
|UTILITY_CORPORATION | |||
| | |||
|- | |||
|WATER_AUTHORITY | |||
| | |||
|- | |||
|OTHER_AUTHORITY | |||
| | |||
|- | |||
|OTHER | |||
| | |||
|} | |||
{{article end|seealso=*[[Api Content Items]] | {{article end|seealso=*[[Api Content Items]] | ||
*[[Api session event editor ]] | *[[Api session event editor]] | ||
}} | }} | ||
[[Category:API]] | [[Category:API]] | ||
[[Category:Items]] | |||
Latest revision as of 14:14, 24 April 2026
Api session items Special Options Endpoints.
Default Query:
https://engine.tygron.com/api/session/items/specialoptions/?f=JSON&token=API_TOKENExample 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" : 7
}, {
"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" : 5
} ]Limit Queries
version=100:
https://engine.tygron.com/api/session/items/specialoptions/?version=100&token=API_TOKENShow Queries
max version:
https://engine.tygron.com/api/session/items/specialoptions/version/?token=API_TOKENsize:
https://engine.tygron.com/api/session/items/specialoptions/size/?token=API_TOKENFormats
HTML:
https://engine.tygron.com/api/session/items/specialoptions/?f=HTML&token=API_TOKENJSON:
https://engine.tygron.com/api/session/items/specialoptions/?f=JSON&token=API_TOKENCSV:
https://engine.tygron.com/api/session/items/specialoptions/?f=CSV&token=API_TOKENSSV:
https://engine.tygron.com/api/session/items/specialoptions/?f=SSV&token=API_TOKENSMILE:
https://engine.tygron.com/api/session/items/specialoptions/?f=SMILE&token=API_TOKENZIPJSON:
https://engine.tygron.com/api/session/items/specialoptions/?f=ZIPJSON&token=API_TOKENZIPSMILE:
https://engine.tygron.com/api/session/items/specialoptions/?f=ZIPSMILE&token=API_TOKENApi 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 |