Api session event editor weather set duration: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Created page with "API Event to Set how long the specified weather's visualization lasts when it is triggered. {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(WEATHER Integer ID) |Weather ID | |- |1 |REQUIRED |(Floating point number) |Duration of visualization in seconds | |} ===Response Codes=== {|class=wikitable !Response Code: !Description |- |204 |No Content |- |300-600 |Codes Overview |} ===Example POST=== Example POST: https://engine.tygron.com/ap..."
 
No edit summary
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Event to Set how long the specified weather's visualization lasts when it is triggered.
API Endpoint: api/session/event/editorweather/set_duration/
 
Description: Set the duration of the specified [[Weather]]'s visualization.
 
{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 7: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(WEATHER Integer ID)
| (WEATHER Integer ID)
|[[Weather]] ID
| [[Weather]] ID
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(Floating point number)
| (Floating point number)
|Duration of visualization in seconds
| Duration of visualization in seconds
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 24: Line 27:
!Description
!Description
|-
|-
|204
| 204
|No Content
| No Content
|-
|-
|300-600
| 300-600
|Codes Overview
| Codes Overview
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editorweather/set_duration/?f=HTML&token=API_TOKEN
Curl example POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorweather/set_duration/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 76 ]'
with content:  
</syntaxhighlight>
<pre>[ 63, 70 ]
Curl example multi item POST
</pre>
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorweather/set_duration/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 79 ]'
{{article end|seealso=*[[api session event editor weather]]}}
</syntaxhighlight>
JavaScript example POST
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, 76 ]'
};
fetch("https://engine.tygron.com/api/session/event/editorweather/set_duration/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));
</syntaxhighlight>
{{article end|seealso=*[[Api session event editor weather]]
*[[Api session items weathers]]
}}


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

Latest revision as of 10:00, 13 July 2026

API Endpoint: api/session/event/editorweather/set_duration/

Description: Set the duration of the specified Weather's visualization.

Index Importance Type Description Values
0 REQUIRED (WEATHER Integer ID) Weather ID
1 REQUIRED (Floating point number) Duration of visualization in seconds

Response Codes

Response Code: Description
204 No Content
300-600 Codes Overview

Example POST

Curl example POST

curl 'https://engine.tygron.com/api/session/event/editorweather/set_duration/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 76 ]'

Curl example multi item POST

curl 'https://engine.tygron.com/api/session/event/editorweather/set_duration/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 79 ]'

JavaScript example POST

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, 76 ]'
};
fetch("https://engine.tygron.com/api/session/event/editorweather/set_duration/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));