Api session event participant building plan demolish: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Created page with "API Endpoint: api/session/event/participant/building_plan_demolish/ Description: Plan the demolition of a Building in the MAQUETTE map. {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(STAKEHOLDER Integer ID) |Stakeholder ID (also owner) | |- |1 |REQUIRED |(BUILDING Integer ID) |Building ID | |} ===Response Codes=== {|class=wikitable !Response Code: !Description |- |200 |Integer (Action Log ID) |- |300-600 |Codes Overview |}..."
 
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
|(STAKEHOLDER Integer ID)
| (STAKEHOLDER Integer ID)
|[[Stakeholder]] ID (also owner)
| [[Stakeholder]] ID (also owner)
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(BUILDING Integer ID)
| (BUILDING Integer ID)
|[[Building]] ID
| [[Building]] ID
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 27: Line 27:
!Description
!Description
|-
|-
|200
| 200
|Integer (Action Log ID)
| Integer (Action Log ID)
|-
|-
|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/participant/building_plan_demolish/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1 ]'
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/participant/building_plan_demolish/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1 ]'
</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:08, 15 June 2026

API Endpoint: api/session/event/participant/building_plan_demolish/

Description: Plan the demolition of a Building in the MAQUETTE map.

Index Importance Type Description Values
0 REQUIRED (STAKEHOLDER Integer ID) Stakeholder ID (also owner)
1 REQUIRED (BUILDING Integer ID) Building ID

Response Codes

Response Code: Description
200 Integer (Action Log ID)
300-600 Codes Overview

Example POST

Curl example POST

curl 'https://engine.tygron.com/api/session/event/participant/building_plan_demolish/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1 ]'

JavaScript example POST

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