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
Line 10: 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 27: 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===
Curl example POST:
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 '[ "", "" ]'
<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 ''
</syntaxhighlight>
</syntaxhighlight>
JavaScript example POST:
JavaScript example POST:
Line 43: Line 43:
 method: "POST",
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ "", "" ]'
 body: ''
};
};
fetch("https://engine.tygron.com/api/session/event/editorspecialeffect/add/?crs=3857", options)
fetch("https://engine.tygron.com/api/session/event/editorspecialeffect/add/?crs=3857", options)

Revision as of 11:42, 8 June 2026

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

Description: Add new Special Effect

Name 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));