Api session items weathers: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
46,429 edits
No edit summary
No edit summary
 
(23 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session items [[Weather]] Endpoints.
API Endpoint: /api/session/items/weathers/


Manipulate items with event: [[Api session event editor weather|editorweather]].
Edit items with events described at [[Api session event editor weather]].


Default Query:
Default Query:
<pre>https://engine.tygron.com/api/session/items/weathers/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/weathers/?f=JSON&token=API_TOKEN</syntaxhighlight>
Example Response:
Example Response:
<pre>[ {
<syntaxhighlight lang="text" copy>[ {
   "attributes" : {
   "attributes" : {
     "EVAPORATION_M" : [ 7200.0, 1.25E-4 ],
     "EVAPORATION_M" : [ 7200.0, 1.25E-4 ],
Line 20: Line 20:
   "triggerSec" : -1.0,
   "triggerSec" : -1.0,
   "version" : 1
   "version" : 1
} ]</pre>
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
version=100:  
version=100:  
<pre>https://engine.tygron.com/api/session/items/weathers/?version=100&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/weathers/?version=100&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Get Queries==
attributes:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/weathers/attributes/?token=API_TOKEN</syntaxhighlight>
max version:  
max version:  
<pre>https://engine.tygron.com/api/session/items/weathers/version/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/weathers/version/?token=API_TOKEN</syntaxhighlight>
size:  
count:  
<pre>https://engine.tygron.com/api/session/items/weathers/size/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/weathers/count/?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  
<pre>https://engine.tygron.com/api/session/items/weathers/?f=HTML&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/weathers/?f=HTML&token=API_TOKEN</syntaxhighlight>
JSON:  
JSON:  
<pre>https://engine.tygron.com/api/session/items/weathers/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/weathers/?f=JSON&token=API_TOKEN</syntaxhighlight>
CSV:  
CSV:  
<pre>https://engine.tygron.com/api/session/items/weathers/?f=CSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/weathers/?f=CSV&token=API_TOKEN</syntaxhighlight>
SSV:  
SSV:  
<pre>https://engine.tygron.com/api/session/items/weathers/?f=SSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/weathers/?f=SSV&token=API_TOKEN</syntaxhighlight>
SMILE:  
SMILE:  
<pre>https://engine.tygron.com/api/session/items/weathers/?f=SMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/weathers/?f=SMILE&token=API_TOKEN</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<pre>https://engine.tygron.com/api/session/items/weathers/?f=ZIPJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/weathers/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<pre>https://engine.tygron.com/api/session/items/weathers/?f=ZIPSMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/weathers/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
==Api Model Weather==
API Model description of Weather
 
{|class=wikitable
!Name
!Type
!Description
|-
| attributes
| Map&lt;String,double[]&gt;
|
|-
| durationInSecs
| double
|
|-
| effect
| WeatherTypeEffect
| [[Weather]]TypeEffect
|-
| floodingM
| double
|
|-
| floodOverlayID
| int
| [[Overlay]] ID
|-
| id
| int
|
|-
| maquetteOverride
| Map&lt;String,double[]&gt;
|
|-
| name
| String
|
|-
| triggerSec
| double
|
|-
| version
| int
|
|}
 
==Api Model WeatherTypeEffect==
API Enumeration description of WeatherTypeEffect
 
{|class=wikitable
!Name
!Description
|-
| NO_EFFECT
|
|-
| RAIN
|
|-
| SNOW
|
|-
| WIND
|
|-
| DROUGHT
|
|-
| FLOODING
|
|}
 
{{article end|seealso=*[[Api Content Items]]
{{article end|seealso=*[[Api Content Items]]
*[[Api session event editor weather]]
*[[Api session event editor weather]]
Line 49: Line 126:


[[Category:API]]
[[Category:API]]
[[Category:Items]]

Latest revision as of 07:14, 7 July 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

Get Queries

attributes: 

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

max version: 

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

count: 

https://engine.tygron.com/api/session/items/weathers/count/?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 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

See also

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