Api session items stakeholders

From Tygron Support wiki
Jump to navigation Jump to search

Api session items Stakeholder Endpoints.

Edit items with event: editorstakeholder.

Default Query:

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

Example Response:

[ {
  "active" : true,
  "client" : null,
  "color" : {
    "argb" : -3355444
  },
  "id" : 0,
  "imageName" : "municipality.png",
  "imageVersion" : 0,
  "lastSelected" : 1774446787083,
  "name" : "Municipality Arnhem",
  "shortName" : "Arnhem",
  "startBudget" : 0.0,
  "startBudgets" : {
    "0" : 1000000.0
  },
  "startCinematics" : {
    "0" : 0
  },
  "startPoint" : null,
  "type" : "MUNICIPALITY",
  "version" : 6,
  "webToken" : "RHVXnEVpNcbfEBNQKWmwxAXQ"
}, {
  "active" : true,
  "client" : null,
  "color" : {
    "argb" : -360334
  },
  "id" : 1,
  "imageName" : "civilian.png",
  "imageVersion" : 0,
  "lastSelected" : 1741957674390,
  "name" : "Inhabitants",
  "shortName" : "Inhabitants",
  "startBudget" : 0.0,
  "startBudgets" : {
    "0" : 0.0
  },
  "startCinematics" : {
    "0" : 0
  },
  "startPoint" : null,
  "type" : "CIVILIAN",
  "version" : 5,
  "webToken" : "NZPc6qRkfTYYjmDPjywXADjj"
} ]

Limit Queries

version=100:

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

Show Queries

max version:

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

size:

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

Formats

HTML:

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

JSON:

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

CSV:

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

SSV:

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

SMILE:

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

ZIPJSON:

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

ZIPSMILE:

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

Api Model Point

API Model description of Point

Name Type Description

Api Model Stakeholder

API Model description of Stakeholder

Name Type Description
active boolean
client ClientData
color TColor
id int
imageName String
imageVersion int
lastSelected long
name String
shortName String
startBudget double
startBudgets Map<int,double>
startCinematics Map<int,int>
startPoint Point
type Type
version int
webToken String

Api Model TColor

API Model description of TColor

Name Type Description

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