Api session items watervalues: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
Api session items [[Water Value]]s Endpoints. | Api session items [[Water Value]]s Endpoints. | ||
Default Query: | Default Query: | ||
| Line 9: | Line 7: | ||
==Limit Queries== | ==Limit Queries== | ||
version=100: | version=100: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/?version=100&token=API_TOKEN</syntaxhighlight> | ||
==Show Queries== | ==Show Queries== | ||
max version: | max version: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/version/?token=API_TOKEN</syntaxhighlight> | ||
size: | size: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/size/?token=API_TOKEN</syntaxhighlight> | ||
==Formats== | ==Formats== | ||
HTML: | HTML: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/?f=HTML&token=API_TOKEN</syntaxhighlight> | ||
JSON: | JSON: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/?f=JSON&token=API_TOKEN</syntaxhighlight> | ||
CSV: | CSV: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/?f=CSV&token=API_TOKEN</syntaxhighlight> | ||
SSV: | SSV: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/?f=SSV&token=API_TOKEN</syntaxhighlight> | ||
SMILE: | SMILE: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/?f=SMILE&token=API_TOKEN</syntaxhighlight> | ||
ZIPJSON: | ZIPJSON: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight> | ||
ZIPSMILE: | ZIPSMILE: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight> | ||
==Api Model WaterBookValue== | |||
API Model description of WaterBookValue | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
|costType | |||
|WaterValue | |||
| | |||
|- | |||
|id | |||
|int | |||
| | |||
|- | |||
|in | |||
|boolean | |||
| | |||
|- | |||
|linkID | |||
|int | |||
| | |||
|- | |||
|mapLink | |||
|MapLink | |||
| | |||
|- | |||
|name | |||
|String | |||
| | |||
|- | |||
|overlayID | |||
|int | |||
|[[Overlay]] ID | |||
|- | |||
|value | |||
|double | |||
| | |||
|- | |||
|version | |||
|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 | |||
| | |||
|} | |||
{{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 14:14, 24 April 2026
Api session items Water Values Endpoints.
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_TOKENShow Queries
max version:
https://engine.tygron.com/api/session/items/watervalues/version/?token=API_TOKENsize:
https://engine.tygron.com/api/session/items/watervalues/size/?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 | |
| id | int | |
| in | boolean | |
| linkID | int | |
| 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 |