Api session items incomes: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 26: Line 26:
version=100:  
version=100:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/incomes/?version=100&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/incomes/?version=100&token=API_TOKEN</syntaxhighlight>
==Get Queries==
==Show Queries==
==Show Queries==
attributes:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/incomes/attributes/?token=API_TOKEN</syntaxhighlight>
max version:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/incomes/version/?token=API_TOKEN</syntaxhighlight>
count:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/incomes/count/?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  

Revision as of 14:59, 6 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

Show 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