Api session event editor overlay set prequel: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
46,429 edits
Created page with "API Event to Set prequel Overlay. {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(OVERLAY Integer ID) |Overlay ID | |- |1 |REQUIRED |(OVERLAY Integer ID) |Prequel Overlay ID | |- |2 |REQUIRED |(String) |Prequel Type Name | |- |3 |OPTIONAL |(Integer number) |Prequel Timeframe ID (optional) | |- |4 |OPTIONAL |(true, false) |Previous Iteration (optional) | |} ===Response Codes=== {|class=wikitable !Response Code: !Description..."
 
No edit summary
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
API Event to Set prequel [[Overlay]].
API Endpoint: api/session/event/editoroverlay/set_prequel/
 
Description: Set 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)
|[[Overlay]] ID
| [[Overlay]] ID
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(OVERLAY Integer ID)
| (OVERLAY Integer ID)
|Prequel [[Overlay]] ID
| Prequel [[Overlay]] ID
|
|  
|-
|-
|2
| 2
|REQUIRED
| REQUIRED
|(String)
| (String)
|Prequel Type Name
| Prequel Type Name
|
|  
|-
|-
|3
| 3
|OPTIONAL
| OPTIONAL
|(Integer number)
| (Integer number)
|Prequel [[Time]]frame ID (optional)
| Prequel [[Timeframe]] ID (optional)
|
|  
|-
|-
|4
| 4
|OPTIONAL
| OPTIONAL
|(true, false)
| (true, false)
|Previous Iteration (optional)
| Previous [[Simulation Core|Iteration]] (optional)
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 42: Line 45:
!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/set_prequel/?f=HTML&token=API_TOKEN
Curl example POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_prequel/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1, "Prequel Type Name" ]'
with content:  
</syntaxhighlight>
<pre>[ 97, 28, "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, 1, "Prequel Type Name" ]'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_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/set_prequel/

Description: Set prequel Overlay.

Index Importance Type Description Values
0 REQUIRED (OVERLAY Integer ID) Overlay ID
1 REQUIRED (OVERLAY Integer ID) Prequel Overlay ID
2 REQUIRED (String) Prequel Type Name
3 OPTIONAL (Integer number) Prequel Timeframe ID (optional)
4 OPTIONAL (true, false) Previous Iteration (optional)

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

JavaScript example POST 

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

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_event_editor_overlay_set_prequel&oldid=85939"