Api session event editor specialeffect add: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Event to Add new [[Special Effect]]
API Endpoint: api/session/event/editorspecialeffect/add/
 
Description: Add new [[Special Effect]]
 
{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 7: Line 10:
!Values
!Values
|-
|-
|0
| 0
|OPTIONAL
| OPTIONAL
|(Point with crs: EPSG:3857)
| (Point with crs: EPSG:3857)
|Location (optional)
| Location (optional)
|
|  
|-
|-
|1
| 1
|OPTIONAL
| OPTIONAL
|(PARTICLE_EMITTER Integer ID)
| (PARTICLE_EMITTER Integer ID)
|[[Particle Emitter]] (optional)
| [[Particle Emitter]] (optional)
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 24: Line 27:
!Description
!Description
|-
|-
|200
| 200
|Integer (Special Effect ID)
| Integer (Special Effect ID)
|-
|-
|300-600
| 300-600
|Codes Overview
| Codes Overview
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editorspecialeffect/add/?crs=3857&f=JSON&token=API_TOKEN
Curl example POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorspecialeffect/add/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d ''
with content:
</syntaxhighlight>
<pre>[ "", "" ]
JavaScript example POST
</pre>
<syntaxhighlight lang="text" copy>var options = {
{{article end|seealso=*[[api session event editor specialeffect]]}}
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: ''
};
fetch("https://engine.tygron.com/api/session/event/editorspecialeffect/add/?crs=3857", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));
</syntaxhighlight>
{{article end|seealso=*[[Api session event editor specialeffect]]
*[[Api session items specialeffects]]
}}


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

Latest revision as of 12:06, 15 June 2026

API Endpoint: api/session/event/editorspecialeffect/add/

Description: Add new Special Effect

Index Importance Type Description Values
0 OPTIONAL (Point with crs: EPSG:3857) Location (optional)
1 OPTIONAL (PARTICLE_EMITTER Integer ID) Particle Emitter (optional)

Response Codes

Response Code: Description
200 Integer (Special Effect ID)
300-600 Codes Overview

Example POST

Curl example POST

curl 'https://engine.tygron.com/api/session/event/editorspecialeffect/add/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d ''

JavaScript example POST

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: ''
};
fetch("https://engine.tygron.com/api/session/event/editorspecialeffect/add/?crs=3857", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));