Api session event editor overlay remove: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 4: | Line 4: | ||
{|class=wikitable | {|class=wikitable | ||
! | !Index | ||
!Importance | !Importance | ||
!Type | !Type | ||
| Line 10: | Line 10: | ||
!Values | !Values | ||
|- | |- | ||
|0 | | 0 | ||
|REQUIRED | | REQUIRED | ||
|(OVERLAY Integer ID or multiple values in array [1, 2, 3]) | | (OVERLAY Integer ID or multiple integer values in array [1, 2, 3]) | ||
|[[Overlay]] IDs | | [[Overlay]] IDs | ||
| | | | ||
|} | |} | ||
===Response Codes=== | ===Response Codes=== | ||
| Line 21: | Line 21: | ||
!Description | !Description | ||
|- | |- | ||
|200 | | 200 | ||
|Boolean (True when at least one item was removed) | | Boolean (True when at least one item was removed) | ||
|- | |- | ||
|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/editoroverlay/remove/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '1' | <syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoroverlay/remove/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '1' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Curl example multi item POST | Curl example multi item POST | ||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoroverlay/remove/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 2, 3 ]' | <syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoroverlay/remove/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 2, 3 ]' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
JavaScript example POST | JavaScript example POST | ||
<syntaxhighlight lang="text" copy>var options = { | <syntaxhighlight lang="text" copy>var options = { | ||
method: "POST", | method: "POST", | ||
Latest revision as of 12:22, 17 June 2026
API Endpoint: api/session/event/editoroverlay/remove/
Description: Remove the specified Overlays.
| Index | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (OVERLAY Integer ID or multiple integer values in array [1, 2, 3]) | Overlay IDs |
Response Codes
| Response Code: | Description |
|---|---|
| 200 | Boolean (True when at least one item was removed) |
| 300-600 | Codes Overview |
Example POST
Curl example POST
curl 'https://engine.tygron.com/api/session/event/editoroverlay/remove/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '1'Curl example multi item POST
curl 'https://engine.tygron.com/api/session/event/editoroverlay/remove/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 2, 3 ]'JavaScript example POST
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '1'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/remove/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));