Api session event editor overlay remove prequel: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Created page with "API Event to Remove a Grid Overlay's prequel Overlay. {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(OVERLAY Integer ID) |Grid Overlay ID | |- |1 |REQUIRED |(String) |Prequel Type Name | |} ===Response Codes=== {|class=wikitable !Response Code: !Description |- |204 |No Content |- |300-600 |Codes Overview |} ===Example POST=== Example POST: https://engine.tygron.com/api/session/event/editoroverlay/remove_prequel/?f=HTML&token=API_..."
 
No edit summary
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
API Event to Remove a Grid [[Overlay]]'s prequel Overlay.
API Endpoint: api/session/event/editoroverlay/remove_prequel/
 
Description: Remove a [[Grid Overlay]]'s prequel [[Overlay]].
 
{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 7: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(OVERLAY Integer ID)
| (OVERLAY Integer ID)
|Grid [[Overlay]] ID
| [[Grid Overlay]] ID
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(String)
| (String)
|Prequel Type Name
| Prequel Type Name
|
|  
|}
|}
===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/editoroverlay/remove_prequel/?f=HTML&token=API_TOKEN
Curl example POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoroverlay/remove_prequel/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Prequel Type Name" ]'
with content:  
</syntaxhighlight>
<pre>[ 18, "Prequel Type Name" ]
JavaScript example POST
</pre>
<syntaxhighlight lang="text" copy>var options = {
{{article end|seealso=*[[api session event editor overlay]]}}
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, "Prequel Type Name" ]'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/remove_prequel/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));
</syntaxhighlight>
{{article end|seealso=*[[Api session event editor overlay]]
*[[Api session items overlays]]
}}


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

Latest revision as of 12:05, 15 June 2026

API Endpoint: api/session/event/editoroverlay/remove_prequel/

Description: Remove a Grid Overlay's prequel Overlay.

Index Importance Type Description Values
0 REQUIRED (OVERLAY Integer ID) Grid Overlay ID
1 REQUIRED (String) Prequel Type Name

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/editoroverlay/remove_prequel/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Prequel Type Name" ]'

JavaScript example POST

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