Api session items specialoptions: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 10: Line 10:
   "imageName" : "buy_land.png",
   "imageName" : "buy_land.png",
   "name" : "Buy land",
   "name" : "Buy land",
   "version" : 8
   "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" : 4
   "version" : 2
} ]</syntaxhighlight>
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
Line 50: Line 50:
!Description
!Description
|-
|-
|defaults
| defaults
|Type<nowiki>[]</nowiki>
| Type<nowiki>[]</nowiki>
|
|  
|-
|-
|description
| description
|String
| String
|
|  
|-
|-
|id
| id
|int
| int
|
|  
|-
|-
|imageName
| imageName
|String
| String
|
|  
|-
|-
|name
| name
|String
| String
|
|  
|-
|-
|version
| version
|int
| int
|
|  
|}
|}


Line 82: Line 82:
!Description
!Description
|-
|-
|CIVILIAN
| CIVILIAN
|
|  
|-
|-
|COMPANY
| COMPANY
|
|  
|-
|-
|EDUCATION
| EDUCATION
|
|  
|-
|-
|EXPERT
| EXPERT
|
|  
|-
|-
|FARMER
| FARMER
|
|  
|-
|-
|HEALTHCARE
| HEALTHCARE
|
|  
|-
|-
|HOUSING_CORPORATION
| HOUSING_CORPORATION
|
|  
|-
|-
|MUNICIPALITY
| MUNICIPALITY
|
|  
|-
|-
|MEDIA
| MEDIA
|
|  
|-
|-
|PROJECT_DEVELOPER
| PROJECT_DEVELOPER
|
|  
|-
|-
|UTILITY_CORPORATION
| UTILITY_CORPORATION
|
|  
|-
|-
|WATER_AUTHORITY
| WATER_AUTHORITY
|
|  
|-
|-
|OTHER_AUTHORITY
| OTHER_AUTHORITY
|
|  
|-
|-
|OTHER
| OTHER
|
|  
|}
|}



Latest revision as of 15:28, 17 June 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

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 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