Api session event editor building add geometry: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(2 intermediate revisions 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
|(BUILDING Integer ID or multiple values in array [1, 2, 3])
| (BUILDING Integer ID or multiple integer values in array [1, 2, 3])
|[[Building]] ID
| [[Building]] ID
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(CUSTOM_GEOMETRIE Integer ID or multiple values in array [1, 2, 3])
| (CUSTOM_GEOMETRIE Integer ID or multiple integer values in array [1, 2, 3])
|[[Custom Geometry]] ID
| [[Custom Geometry]] ID
|
|  
|-
|-
|2
| 2
|REQUIRED
| REQUIRED
|(boolean or multiple values in array [a, b, c])
| (boolean or multiple values in array [a, b, c])
|Primary [[Building]] for geometry
| Primary [[Building]] for geometry
|
|  
|-
|-
|3
| 3
|OPTIONAL
| OPTIONAL
|(SOURCE Integer ID)
| (SOURCE Integer ID)
|[[Source]] (optional)
| [[Source]] (optional)
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 39: Line 39:
!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/editorbuilding/add_geometry/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1, true ]'
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorbuilding/add_geometry/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1, true ]'
</syntaxhighlight>
</syntaxhighlight>
Curl example multi item POST:
Curl example multi item POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorbuilding/add_geometry/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ 1, 2, 3 ], [ true, false, true ] ]'
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorbuilding/add_geometry/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ 1, 2, 3 ], [ true, false, true ] ]'
</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:21, 17 June 2026

API Endpoint: api/session/event/editorbuilding/add_geometry/

Description: Add a custom Building geometry

Index Importance Type Description Values
0 REQUIRED (BUILDING Integer ID or multiple integer values in array [1, 2, 3]) Building ID
1 REQUIRED (CUSTOM_GEOMETRIE Integer ID or multiple integer values in array [1, 2, 3]) Custom Geometry ID
2 REQUIRED (boolean or multiple values in array [a, b, c]) Primary Building for geometry
3 OPTIONAL (SOURCE Integer ID) Source (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/editorbuilding/add_geometry/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1, true ]'

Curl example multi item POST

curl 'https://engine.tygron.com/api/session/event/editorbuilding/add_geometry/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ 1, 2, 3 ], [ true, false, true ] ]'

JavaScript example POST

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