Api session items watervalues: 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/watervalues/ | |||
Default Query: | Default Query: | ||
| Line 8: | Line 8: | ||
version=100: | version=100: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/?version=100&token=API_TOKEN</syntaxhighlight> | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/?version=100&token=API_TOKEN</syntaxhighlight> | ||
== | ==Get Queries== | ||
attributes: | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/attributes/?token=API_TOKEN</syntaxhighlight> | |||
max version: | max version: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/version/?token=API_TOKEN</syntaxhighlight> | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/version/?token=API_TOKEN</syntaxhighlight> | ||
count: | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/ | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/count/?token=API_TOKEN</syntaxhighlight> | ||
==Formats== | ==Formats== | ||
HTML: | HTML: | ||
| Line 36: | Line 38: | ||
!Description | !Description | ||
|- | |- | ||
|costType | | costType | ||
|WaterValue | | WaterValue | ||
| | | [[Water Value]] | ||
|- | |- | ||
|id | | id | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|in | | in | ||
|boolean | | boolean | ||
| | | | ||
|- | |- | ||
|linkID | | linkID | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|mapLink | | mapLink | ||
|MapLink | | MapLink | ||
| | | [[Maplink]] | ||
|- | |- | ||
|name | | name | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|overlayID | | overlayID | ||
|int | | int | ||
|[[Overlay]] ID | | [[Overlay]] ID | ||
|- | |- | ||
|value | | value | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|version | | version | ||
|int | | int | ||
| | | | ||
|} | |||
==Api Model WaterValue== | |||
API Enumeration description of WaterValue | |||
{|class=wikitable | |||
!Name | |||
!Description | |||
|- | |||
| WATER_SURFACE | |||
| | |||
|- | |||
| LAND_SURFACE | |||
| | |||
|- | |||
| BUILDING_STORAGE | |||
| | |||
|- | |||
| SEWER_STORAGE | |||
| | |||
|- | |||
| SEWER_OUT_EXTERNAL | |||
| | |||
|- | |||
| UNDERGROUND_STORAGE | |||
| | |||
|- | |||
| UNSAT_STORAGE | |||
| | |||
|- | |||
| EVAPORATED | |||
| | |||
|- | |||
| OUTLET | |||
| | |||
|- | |||
| BREACH_OUT | |||
| | |||
|- | |||
| RAIN | |||
| | |||
|- | |||
| INLET | |||
| | |||
|- | |||
| INUNDATED | |||
| | |||
|- | |||
| BREACH | |||
| | |||
|- | |||
| BOTTOM_IN | |||
| | |||
|- | |||
| BOTTOM_OUT | |||
| | |||
|} | |} | ||
| Line 78: | Line 136: | ||
[[Category:API]] | [[Category:API]] | ||
[[Category:Items]] | |||
Latest revision as of 07:14, 7 July 2026
API Endpoint: /api/session/items/watervalues/
Default Query:
https://engine.tygron.com/api/session/items/watervalues/?f=JSON&token=API_TOKENExample Response:
[ ]Limit Queries
version=100:
https://engine.tygron.com/api/session/items/watervalues/?version=100&token=API_TOKENGet Queries
attributes:
https://engine.tygron.com/api/session/items/watervalues/attributes/?token=API_TOKENmax version:
https://engine.tygron.com/api/session/items/watervalues/version/?token=API_TOKENcount:
https://engine.tygron.com/api/session/items/watervalues/count/?token=API_TOKENFormats
HTML:
https://engine.tygron.com/api/session/items/watervalues/?f=HTML&token=API_TOKENJSON:
https://engine.tygron.com/api/session/items/watervalues/?f=JSON&token=API_TOKENCSV:
https://engine.tygron.com/api/session/items/watervalues/?f=CSV&token=API_TOKENSSV:
https://engine.tygron.com/api/session/items/watervalues/?f=SSV&token=API_TOKENSMILE:
https://engine.tygron.com/api/session/items/watervalues/?f=SMILE&token=API_TOKENZIPJSON:
https://engine.tygron.com/api/session/items/watervalues/?f=ZIPJSON&token=API_TOKENZIPSMILE:
https://engine.tygron.com/api/session/items/watervalues/?f=ZIPSMILE&token=API_TOKENApi Model WaterBookValue
API Model description of WaterBookValue
| Name | Type | Description |
|---|---|---|
| costType | WaterValue | Water Value |
| id | int | |
| in | boolean | |
| linkID | int | |
| mapLink | MapLink | Maplink |
| name | String | |
| overlayID | int | Overlay ID |
| value | double | |
| version | int |
Api Model WaterValue
API Enumeration description of WaterValue
| Name | Description |
|---|---|
| WATER_SURFACE | |
| LAND_SURFACE | |
| BUILDING_STORAGE | |
| SEWER_STORAGE | |
| SEWER_OUT_EXTERNAL | |
| UNDERGROUND_STORAGE | |
| UNSAT_STORAGE | |
| EVAPORATED | |
| OUTLET | |
| BREACH_OUT | |
| RAIN | |
| INLET | |
| INUNDATED | |
| BREACH | |
| BOTTOM_IN | |
| BOTTOM_OUT |