Api session items stakeholders: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 15: | Line 15: | ||
"imageName" : "municipality.png", | "imageName" : "municipality.png", | ||
"imageVersion" : 0, | "imageVersion" : 0, | ||
"lastSelected" : | "lastSelected" : 1780682162842, | ||
"name" : "Municipality Arnhem", | "name" : "Municipality Arnhem", | ||
"shortName" : "Arnhem", | "shortName" : "Arnhem", | ||
| Line 84: | Line 84: | ||
!Description | !Description | ||
|- | |- | ||
|type | | type | ||
|String | | String | ||
|[[#Api Model Point|Point]] | | [[#Api Model Point|Point]] | ||
|- | |- | ||
|coordinates | | coordinates | ||
|double[] | | double[] | ||
|x, y, (optional) z | | x, y, (optional) z | ||
|} | |} | ||
| Line 101: | Line 101: | ||
!Description | !Description | ||
|- | |- | ||
|active | | active | ||
|boolean | | boolean | ||
| | | | ||
|- | |- | ||
|client | | client | ||
|ClientData | | ClientData | ||
| | | | ||
|- | |- | ||
|color | | color | ||
|TColor | | TColor | ||
| | | | ||
|- | |- | ||
|id | | id | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|imageName | | imageName | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|imageVersion | | imageVersion | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|lastSelected | | lastSelected | ||
|long | | long | ||
| | | | ||
|- | |- | ||
|name | | name | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|shortName | | shortName | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|startBudget | | startBudget | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|startBudgets | | startBudgets | ||
|Map<int,double> | | Map<int,double> | ||
| | | | ||
|- | |- | ||
|startCinematics | | startCinematics | ||
|Map<int,int> | | Map<int,int> | ||
| | | | ||
|- | |- | ||
|startPoint | | startPoint | ||
|Point | | Point | ||
| | | | ||
|- | |- | ||
|type | | type | ||
|Type | | Type | ||
| | | | ||
|- | |- | ||
|version | | version | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|webToken | | webToken | ||
|String | | String | ||
| | | | ||
|} | |} | ||
| Line 182: | Line 182: | ||
!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 | ||
| | | | ||
|} | |} | ||
Revision as of 11:45, 8 June 2026
API Endpoint: /api/session/items/stakeholders/
Edit items with events described at Api session event editor stakeholder.
Default Query:
https://engine.tygron.com/api/session/items/stakeholders/?f=JSON&token=API_TOKENExample Response:
[ {
"active" : true,
"client" : null,
"color" : {
"argb" : -3355444
},
"id" : 0,
"imageName" : "municipality.png",
"imageVersion" : 0,
"lastSelected" : 1780682162842,
"name" : "Municipality Arnhem",
"shortName" : "Arnhem",
"startBudget" : 0.0,
"startBudgets" : {
"0" : 1000000.0
},
"startCinematics" : {
"0" : 0
},
"startPoint" : null,
"type" : "MUNICIPALITY",
"version" : 13,
"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" : 14,
"webToken" : "NZPc6qRkfTYYjmDPjywXADjj"
} ]Limit Queries
version=100:
https://engine.tygron.com/api/session/items/stakeholders/?version=100&token=API_TOKENShow Queries
max version:
https://engine.tygron.com/api/session/items/stakeholders/version/?token=API_TOKENsize:
https://engine.tygron.com/api/session/items/stakeholders/size/?token=API_TOKENFormats
HTML:
https://engine.tygron.com/api/session/items/stakeholders/?f=HTML&token=API_TOKENJSON:
https://engine.tygron.com/api/session/items/stakeholders/?f=JSON&token=API_TOKENCSV:
https://engine.tygron.com/api/session/items/stakeholders/?f=CSV&token=API_TOKENSSV:
https://engine.tygron.com/api/session/items/stakeholders/?f=SSV&token=API_TOKENSMILE:
https://engine.tygron.com/api/session/items/stakeholders/?f=SMILE&token=API_TOKENZIPJSON:
https://engine.tygron.com/api/session/items/stakeholders/?f=ZIPJSON&token=API_TOKENZIPSMILE:
https://engine.tygron.com/api/session/items/stakeholders/?f=ZIPSMILE&token=API_TOKENApi Model Point
API Model description of Point
| Name | Type | Description |
|---|---|---|
| type | String | Point |
| coordinates | double[] | x, y, (optional) z |
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 |