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
 
Line 1: Line 1:
API Endpoint: api/session/event/editorbuilding/add_geometry/
API Endpoint: api/session/event/editorbuilding/add_geometry/


Description: Add a custom [[Building]] geometry
Description: Add a [[Custom Geometry]] to a [[Building]]


{|class=wikitable
{|class=wikitable
Line 13: Line 13:
| REQUIRED
| REQUIRED
| (BUILDING Integer ID or multiple integer values in array [1, 2, 3])
| (BUILDING Integer ID or multiple integer values in array [1, 2, 3])
| [[Building]] ID
| [[Building]]s
|  
|  
|-
|-
Line 19: Line 19:
| REQUIRED
| REQUIRED
| (CUSTOM_GEOMETRIE Integer ID or multiple integer values in array [1, 2, 3])
| (CUSTOM_GEOMETRIE Integer ID or multiple integer values in array [1, 2, 3])
| [[Custom Geometry]] ID
| [[Custom Geometry|Custom Geometries]]
|  
|  
|-
|-
Line 25: Line 25:
| 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 the [[Custom Geometry]], per [[Building]]
|  
|  
|-
|-
Line 31: Line 31:
| OPTIONAL
| OPTIONAL
| (SOURCE Integer ID)
| (SOURCE Integer ID)
| [[Source]] (optional)
| [[Source]]
|  
|  
|}
|}

Latest revision as of 15:29, 10 November 2026

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

Description: Add a Custom Geometry to a Building

Index Importance Type Description Values
0 REQUIRED (BUILDING Integer ID or multiple integer values in array [1, 2, 3]) Buildings
1 REQUIRED (CUSTOM_GEOMETRIE Integer ID or multiple integer values in array [1, 2, 3]) Custom Geometries
2 REQUIRED (boolean or multiple values in array [a, b, c]) Primary Building for the Custom Geometry, per Building
3 OPTIONAL (SOURCE Integer ID) Source

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));