Api session items watervalues: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bots, Bureaucrats, Interface administrators, Administrators
47,297 edits
No edit summary
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 2: Line 2:


Default Query:
Default Query:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/?f=JSON&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/?token=API_TOKEN</syntaxhighlight>
Example Response:
Example Response:
<syntaxhighlight lang="text" copy>[ ]</syntaxhighlight>
<syntaxhighlight lang="text" copy>[ {
  "costType" : "RAIN",
  "id" : 4,
  "in" : true,
  "linkID" : 1,
  "mapLink" : "WEATHERS",
  "name" : "Rain (2)",
  "overlayID" : 10,
  "value" : 7261.91999999993,
  "version" : 1
}, {
  "costType" : "LAND_SURFACE",
  "id" : 5,
  "in" : false,
  "linkID" : -1,
  "mapLink" : null,
  "name" : "Land Surface",
  "overlayID" : 10,
  "value" : 5930.113700473226,
  "version" : 2
} ]</syntaxhighlight>
==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>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/?version=100&token=API_TOKEN</syntaxhighlight>
==Get Queries==
==Get Queries==
attributes:  
Attributes:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/attributes/?token=API_TOKEN</syntaxhighlight>
<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:  
Count:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/count/?token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/count/?token=API_TOKEN</syntaxhighlight>
Specific Item by ID:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/watervalues/{id}/?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  

Latest revision as of 15:24, 30 September 2026

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

Default Query: 

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

Example Response: 

[ {
  "costType" : "RAIN",
  "id" : 4,
  "in" : true,
  "linkID" : 1,
  "mapLink" : "WEATHERS",
  "name" : "Rain (2)",
  "overlayID" : 10,
  "value" : 7261.91999999993,
  "version" : 1
}, {
  "costType" : "LAND_SURFACE",
  "id" : 5,
  "in" : false,
  "linkID" : -1,
  "mapLink" : null,
  "name" : "Land Surface",
  "overlayID" : 10,
  "value" : 5930.113700473226,
  "version" : 2
} ]

Limit Queries

Version=100: 

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

Get Queries

Attributes: 

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

Max version: 

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

Count: 

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

Specific Item by ID: 

https://engine.tygron.com/api/session/items/watervalues/{id}/?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

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_items_watervalues&oldid=94040"