Api session event editor area add relation: Difference between revisions

From Tygron Support wiki
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
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 10: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(AREA Integer ID)
| (AREA Integer ID)
|[[Area]]s
| [[Area]]s
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(Enumeration)
| (Enumeration)
|[[Relation]]
| [[Relation]]
|BORDER_A, BORDER_B, BUILDING, CONSTRUCTOR, DEMOLISHER, NETOWNER, OWNER, PARENT, PERMITTER, RECEIVER, RESULT_PARENT, SENDER  or  WEATHER
| BORDER_A, BORDER_B, BUILDING, CONSTRUCTOR, CONTENT, DEMOLISHER, NETOWNER, OWNER, PARENT, PERMITTER, RECEIVER, RESULT_PARENT, SENDER  or  WEATHER
|}
|}
===Response Codes===
===Response Codes===
Line 27: Line 27:
!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/editorarea/add_relation/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "OWNER" ]'
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorarea/add_relation/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "OWNER" ]'
</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:01, 15 June 2026

API Endpoint: api/session/event/editorarea/add_relation/

Description: Add Relation

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

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

JavaScript example POST

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