Api session event editor overlay set prequel: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (One intermediate revision 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) | | (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 [[Timeframe]] ID (optional) | | Prequel [[Timeframe]] ID (optional) | ||
| | | | ||
|- | |- | ||
|4 | | 4 | ||
|OPTIONAL | | OPTIONAL | ||
|(true, false) | | (true, false) | ||
|Previous [[Simulation Core|Iteration]] (optional) | | Previous [[Simulation Core|Iteration]] (optional) | ||
| | | | ||
|} | |} | ||
===Response Codes=== | ===Response Codes=== | ||
| Line 45: | Line 45: | ||
!Description | !Description | ||
|- | |- | ||
|204 | | 204 | ||
|No Content | | No Content | ||
|- | |- | ||
|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/set_prequel/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1, "Prequel Type Name" ]' | <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" ]' | ||
</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: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));