Api session items stakeholders: 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
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session items [[Stakeholder]] Endpoints.
Api session items [[Stakeholder]] Endpoints.


Manipulate items with event: [[Api session event editor stakeholder|editorstakeholder]].
Edit items with event: [[Api session event editor stakeholder|editorstakeholder]].


Default Query:
Default Query:
<pre>https://engine.tygron.com/api/session/items/stakeholders/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/stakeholders/?f=JSON&token=API_TOKEN</syntaxhighlight>
Example Response:
Example Response:
<pre>[ {
<syntaxhighlight lang="text" copy>[ {
   "active" : true,
   "active" : true,
   "client" : null,
   "client" : null,
Line 27: Line 27:
   "startPoint" : null,
   "startPoint" : null,
   "type" : "MUNICIPALITY",
   "type" : "MUNICIPALITY",
   "version" : 2,
   "version" : 6,
   "webToken" : "RHVXnEVpNcbfEBNQKWmwxAXQ"
   "webToken" : "RHVXnEVpNcbfEBNQKWmwxAXQ"
}, {
}, {
Line 50: Line 50:
   "startPoint" : null,
   "startPoint" : null,
   "type" : "CIVILIAN",
   "type" : "CIVILIAN",
   "version" : 1,
   "version" : 5,
   "webToken" : "NZPc6qRkfTYYjmDPjywXADjj"
   "webToken" : "NZPc6qRkfTYYjmDPjywXADjj"
} ]</pre>
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
version=100:  
version=100:  
<pre>https://engine.tygron.com/api/session/items/stakeholders/?version=100&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/stakeholders/?version=100&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Show Queries==
max version:  
max version:  
<pre>https://engine.tygron.com/api/session/items/stakeholders/version/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/stakeholders/version/?token=API_TOKEN</syntaxhighlight>
size:  
size:  
<pre>https://engine.tygron.com/api/session/items/stakeholders/size/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/stakeholders/size/?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  
<pre>https://engine.tygron.com/api/session/items/stakeholders/?f=HTML&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/stakeholders/?f=HTML&token=API_TOKEN</syntaxhighlight>
JSON:  
JSON:  
<pre>https://engine.tygron.com/api/session/items/stakeholders/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/stakeholders/?f=JSON&token=API_TOKEN</syntaxhighlight>
CSV:  
CSV:  
<pre>https://engine.tygron.com/api/session/items/stakeholders/?f=CSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/stakeholders/?f=CSV&token=API_TOKEN</syntaxhighlight>
SSV:  
SSV:  
<pre>https://engine.tygron.com/api/session/items/stakeholders/?f=SSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/stakeholders/?f=SSV&token=API_TOKEN</syntaxhighlight>
SMILE:  
SMILE:  
<pre>https://engine.tygron.com/api/session/items/stakeholders/?f=SMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/stakeholders/?f=SMILE&token=API_TOKEN</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<pre>https://engine.tygron.com/api/session/items/stakeholders/?f=ZIPJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/stakeholders/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<pre>https://engine.tygron.com/api/session/items/stakeholders/?f=ZIPSMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/stakeholders/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
==Api Model Point==
API Model description of Point
 
{|class=wikitable
!Name
!Type
!Description
|}
 
==Api Model Stakeholder==
API Model description of Stakeholder
 
{|class=wikitable
!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&lt;int,double&gt;
|
|-
|startCinematics
|Map&lt;int,int&gt;
|
|-
|startPoint
|Point
|
|-
|type
|Type
|
|-
|version
|int
|
|-
|webToken
|String
|
|}
 
==Api Model TColor==
API Model description of TColor
 
{|class=wikitable
!Name
!Type
!Description
|}
 
==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 stakeholder]]
*[[Api session event editor stakeholder]]
Line 81: Line 222:


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

Latest revision as of 14:14, 24 April 2026

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

See also

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