Api session event participant building plan upgrade: Difference between revisions
Jump to navigation
Jump to search
Created page with "API Endpoint: api/session/event/participant/building_plan_upgrade/ Description: Plan the upgrade of Building in the given polygon in the MAQUETTE map. {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(STAKEHOLDER Integer ID) |Stakeholder ID | |- |1 |REQUIRED |(UPGRADE_TYPE Integer ID) |Upgrade Type ID | |- |2 |REQUIRED |(MultiPolygon with crs: EPSG:3857) |Multipolygon describing the upgrade Area | |} ===Response Codes=== {..." |
No edit summary |
||
| Line 1: | Line 1: | ||
API Endpoint: api/session/event/participant/building_plan_upgrade/ | API Endpoint: api/session/event/participant/building_plan_upgrade/ | ||
Description: Plan the upgrade of [[Building]] in the given | Description: Plan the upgrade of [[Building]]s in the given [[#Api Model Polygon|Polygon]] in the MAQUETTE map. | ||
{|class=wikitable | {|class=wikitable | ||
| Line 25: | Line 25: | ||
|REQUIRED | |REQUIRED | ||
|(MultiPolygon with crs: EPSG:3857) | |(MultiPolygon with crs: EPSG:3857) | ||
| | |[[#Api Model MultiPolygon|MultiPolygon]] describing the upgrade [[Area]] | ||
| | | | ||
|} | |} | ||
Latest revision as of 14:49, 2 June 2026
API Endpoint: api/session/event/participant/building_plan_upgrade/
Description: Plan the upgrade of Buildings in the given Polygon in the MAQUETTE map.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (STAKEHOLDER Integer ID) | Stakeholder ID | |
| 1 | REQUIRED | (UPGRADE_TYPE Integer ID) | Upgrade Type ID | |
| 2 | REQUIRED | (MultiPolygon with crs: EPSG:3857) | MultiPolygon describing the upgrade Area |
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_upgrade/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ 1, 1, {
"type" : "MultiPolygon",
"coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
} ]
'JavaScript example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 1, 1, { "type" : "MultiPolygon", "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]} ]'
};
fetch("https://engine.tygron.com/api/session/event/participant/building_plan_upgrade/?crs=3857", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));