Api session items watervalues: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 38: Line 38:
| costType
| costType
| WaterValue
| WaterValue
|  
| [[Water Value]]
|-
|-
| id
| id
Line 54: Line 54:
| mapLink
| mapLink
| MapLink
| MapLink
|  
| [[Maplink]]
|-
|-
| name
| name
Line 62: Line 62:
| overlayID
| overlayID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| value
| value

Revision as of 12:57, 8 June 2026

API Endpoint: /api/session/items/watervalues/

Default Query:

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

Example Response:

[ ]

Limit Queries

version=100:

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

Show Queries

max version:

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

size:

https://engine.tygron.com/api/session/items/watervalues/size/?token=API_TOKEN

Formats

HTML:

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

JSON:

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

CSV:

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

SSV:

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

SMILE:

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

ZIPJSON:

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

ZIPSMILE:

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

Api 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