Api session event participant building plan demolish polygon
Jump to navigation
Jump to search
API Endpoint: api/session/event/participant/building_plan_demolish_polygon/
Description: Plan the demolition of a Buildings in the given Polygon in the MAQUETTE map.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (STAKEHOLDER Integer ID) | Stakeholder ID | |
| 1 | REQUIRED | (MultiPolygon with crs: EPSG:3857) | MultiPolygon describing the demolition Area | |
| 2 | REQUIRED | (Enumeration) | Ground type: SURFACE or UNDERGROUND | BRIDGE, SURFACE or UNDERGROUND |
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_polygon/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ 1, {
"type" : "MultiPolygon",
"coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
}, "BRIDGE" ]
'JavaScript example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 1, { "type" : "MultiPolygon", "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]}, "BRIDGE" ]'
};
fetch("https://engine.tygron.com/api/session/event/participant/building_plan_demolish_polygon/?crs=3857", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));