Api session event editor area set relation: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Event to Set [[Relation]]
API Endpoint: editorarea/set_relation.
 
Description: Set [[Relation]]
 
{|class=wikitable
{|class=wikitable
!Name
!Name
Line 37: Line 40:
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editorarea/set_relation/?f=JSON&token=API_TOKEN
Curl example POST:
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorarea/set_relation/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "OWNER", 1 ]'
</syntaxhighlight>
JavaScript example POST:


with content:  
<syntaxhighlight lang="text" copy>var options = {
<pre>[ 14, "RESULT_PARENT", 50 ]
 method: "POST",
</pre>
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, "OWNER", 1 ]'
};
fetch("https://engine.tygron.com/api/session/event/editorarea/set_relation/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));
</syntaxhighlight>
{{article end|seealso=*[[Api session event editor area]]
{{article end|seealso=*[[Api session event editor area]]
*[[Api session items areas]]
*[[Api session items areas]]

Latest revision as of 13:31, 14 April 2026

API Endpoint: editorarea/set_relation.

Description: Set Relation

Name Importance Type Description Values
0 REQUIRED (AREA Integer ID) Area
1 REQUIRED (Enumeration) Relation BORDER_A, BORDER_B, BUILDING, CONSTRUCTOR, DEMOLISHER, NETOWNER, OWNER, PARENT, PERMITTER, RECEIVER, RESULT_PARENT, SENDER or WEATHER
2 REQUIRED (Integer number) Integer

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

JavaScript example POST:

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