Api session items incomes: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (17 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
API Endpoint: /api/session/items/incomes/ | |||
Default Query: | Default Query: | ||
| 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== | ||
attributes: | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/incomes/attributes/?token=API_TOKEN</syntaxhighlight> | |||
max version: | max version: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/incomes/version/?token=API_TOKEN</syntaxhighlight> | <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/ | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/incomes/count/?token=API_TOKEN</syntaxhighlight> | ||
==Formats== | ==Formats== | ||
HTML: | HTML: | ||
| Line 46: | Line 48: | ||
ZIPSMILE: | ZIPSMILE: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/incomes/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight> | <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 IncomeBookValue== | ||
API Model description of IncomeBookValue | API Model description of IncomeBookValue | ||
| Line 54: | Line 76: | ||
!Description | !Description | ||
|- | |- | ||
|id | | id | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|incomeType | | incomeType | ||
|Income | | Income | ||
| | | [[Income]] | ||
|- | |- | ||
|linkID | | linkID | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|mapLink | | mapLink | ||
|MapLink | | MapLink | ||
| | | [[Maplink]] | ||
|- | |- | ||
|name | | name | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|stakeholderID | | stakeholderID | ||
|int | | int | ||
|[[Stakeholder]] ID | | [[Stakeholder]] ID | ||
|- | |- | ||
|value | | value | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|version | | version | ||
|int | | int | ||
| | | | ||
|} | |} | ||
| Line 92: | Line 114: | ||
[[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_TOKENExample 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_TOKENGet Queries
attributes:
https://engine.tygron.com/api/session/items/incomes/attributes/?token=API_TOKENmax version:
https://engine.tygron.com/api/session/items/incomes/version/?token=API_TOKENcount:
https://engine.tygron.com/api/session/items/incomes/count/?token=API_TOKENFormats
HTML:
https://engine.tygron.com/api/session/items/incomes/?f=HTML&token=API_TOKENJSON:
https://engine.tygron.com/api/session/items/incomes/?f=JSON&token=API_TOKENCSV:
https://engine.tygron.com/api/session/items/incomes/?f=CSV&token=API_TOKENSSV:
https://engine.tygron.com/api/session/items/incomes/?f=SSV&token=API_TOKENSMILE:
https://engine.tygron.com/api/session/items/incomes/?f=SMILE&token=API_TOKENZIPJSON:
https://engine.tygron.com/api/session/items/incomes/?f=ZIPJSON&token=API_TOKENZIPSMILE:
https://engine.tygron.com/api/session/items/incomes/?f=ZIPSMILE&token=API_TOKENApi 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 |