Api session items weathers: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 52: Line 52:
!Description
!Description
|-
|-
|attributes
| attributes
|Map<String,double[]>
| Map<String,double[]>
|
|  
|-
|-
|durationInSecs
| durationInSecs
|double
| double
|
|  
|-
|-
|effect
| effect
|WeatherTypeEffect
| WeatherTypeEffect
|
|  
|-
|-
|floodingM
| floodingM
|double
| double
|
|  
|-
|-
|floodOverlayID
| floodOverlayID
|int
| int
|[[Overlay]] ID  
| [[Overlay]] ID  
|-
|-
|id
| id
|int
| int
|
|  
|-
|-
|maquetteOverride
| maquetteOverride
|Map<String,double[]>
| Map<String,double[]>
|
|  
|-
|-
|name
| name
|String
| String
|
|  
|-
|-
|triggerSec
| triggerSec
|double
| double
|
|  
|-
|-
|version
| version
|int
| int
|
|  
|}
|}


Line 100: Line 100:
!Description
!Description
|-
|-
|NO_EFFECT
| NO_EFFECT
|
|  
|-
|-
|RAIN
| RAIN
|
|  
|-
|-
|SNOW
| SNOW
|
|  
|-
|-
|WIND
| WIND
|
|  
|-
|-
|DROUGHT
| DROUGHT
|
|  
|-
|-
|FLOODING
| FLOODING
|
|  
|}
|}



Revision as of 11:45, 8 June 2026

API Endpoint: /api/session/items/weathers/

Edit items with events described at Api session event editor weather.

Default Query:

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

Example Response:

[ {
  "attributes" : {
    "EVAPORATION_M" : [ 7200.0, 1.25E-4 ],
    "RAIN_M" : [ 3600.0, 0.03, 7200.0, 0.0 ]
  },
  "durationInSecs" : 10.0,
  "effect" : "RAIN",
  "floodOverlayID" : -1,
  "floodingM" : 5.0,
  "id" : 0,
  "maquetteOverride" : null,
  "name" : "Rain",
  "triggerSec" : -1.0,
  "version" : 1
} ]

Limit Queries

version=100:

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

Show Queries

max version:

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

size:

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

Formats

HTML:

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

JSON:

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

CSV:

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

SSV:

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

SMILE:

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

ZIPJSON:

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

ZIPSMILE:

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

Api Model Weather

API Model description of Weather

Name Type Description
attributes Map<String,double[]>
durationInSecs double
effect WeatherTypeEffect
floodingM double
floodOverlayID int Overlay ID
id int
maquetteOverride Map<String,double[]>
name String
triggerSec double
version int

Api Model WeatherTypeEffect

API Enumeration description of WeatherTypeEffect

Name Description
NO_EFFECT
RAIN
SNOW
WIND
DROUGHT
FLOODING