Api session items incomes: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
46,429 edits
No edit summary
No edit summary
 
(21 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session items [[Income]] Endpoints.
API Endpoint: /api/session/items/incomes/
 
Manipulate items with event: [[Api session event editor |Api session event editor ]].


Default Query:
Default Query:
Line 27: Line 25:
==Limit Queries==
==Limit Queries==
version=100:  
version=100:  
<pre>https://engine.tygron.com/api/session/items/incomes/?version=100&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/incomes/?version=100&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Get Queries==
attributes:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/incomes/attributes/?token=API_TOKEN</syntaxhighlight>
max version:  
max version:  
<pre>https://engine.tygron.com/api/session/items/incomes/version/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/incomes/version/?token=API_TOKEN</syntaxhighlight>
size:  
count:  
<pre>https://engine.tygron.com/api/session/items/incomes/size/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/incomes/count/?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  
<pre>https://engine.tygron.com/api/session/items/incomes/?f=HTML&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/incomes/?f=HTML&token=API_TOKEN</syntaxhighlight>
JSON:  
JSON:  
<pre>https://engine.tygron.com/api/session/items/incomes/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/incomes/?f=JSON&token=API_TOKEN</syntaxhighlight>
CSV:  
CSV:  
<pre>https://engine.tygron.com/api/session/items/incomes/?f=CSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/incomes/?f=CSV&token=API_TOKEN</syntaxhighlight>
SSV:  
SSV:  
<pre>https://engine.tygron.com/api/session/items/incomes/?f=SSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/incomes/?f=SSV&token=API_TOKEN</syntaxhighlight>
SMILE:  
SMILE:  
<pre>https://engine.tygron.com/api/session/items/incomes/?f=SMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/incomes/?f=SMILE&token=API_TOKEN</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<pre>https://engine.tygron.com/api/session/items/incomes/?f=ZIPJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/incomes/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<pre>https://engine.tygron.com/api/session/items/incomes/?f=ZIPSMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/incomes/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
==Api Model Income==
API Enumeration description of Income
 
{|class=wikitable
!Name
!Description
|-
| DEFAULT
|
|-
| START_BUDGET
|
|-
| BUILDING_SALE
|
|-
| CONTRIBUTION
|
|}
 
==Api Model IncomeBookValue==
API Model description of IncomeBookValue
 
{|class=wikitable
!Name
!Type
!Description
|-
| id
| int
|
|-
| incomeType
| Income
| [[Income]]
|-
| linkID
| int
|
|-
| mapLink
| MapLink
| [[Maplink]]
|-
| name
| String
|
|-
| stakeholderID
| int
| [[Stakeholder]] ID
|-
| value
| double
|
|-
| version
| int
|
|}
 
{{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 07:14, 7 July 2026

API Endpoint: /api/session/items/incomes/

Default Query: 

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

Example Response: 

[ {
  "id" : 0,
  "incomeType" : "START_BUDGET",
  "linkID" : 0,
  "mapLink" : "STAKEHOLDERS",
  "name" : "Start Budget",
  "stakeholderID" : 0,
  "value" : 0.0,
  "version" : 1
}, {
  "id" : 1,
  "incomeType" : "START_BUDGET",
  "linkID" : 1,
  "mapLink" : "STAKEHOLDERS",
  "name" : "Start Budget",
  "stakeholderID" : 1,
  "value" : 0.0,
  "version" : 2
} ]

Limit Queries

version=100: 

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

Get Queries

attributes: 

https://engine.tygron.com/api/session/items/incomes/attributes/?token=API_TOKEN

max version: 

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

count: 

https://engine.tygron.com/api/session/items/incomes/count/?token=API_TOKEN

Formats

HTML: 

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

JSON: 

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

CSV: 

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

SSV: 

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

SMILE: 

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

ZIPJSON: 

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

ZIPSMILE: 

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

Api Model Income

API Enumeration description of Income

Name Description
DEFAULT
START_BUDGET
BUILDING_SALE
CONTRIBUTION

Api Model IncomeBookValue

API Model description of IncomeBookValue

Name Type Description
id int
incomeType Income Income
linkID int
mapLink MapLink Maplink
name String
stakeholderID int Stakeholder ID
value double
version int

See also

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