Api session event participant building plan construction: Difference between revisions
Jump to navigation
Jump to search
Created page with "API Endpoint: api/session/event/participant/building_plan_construction/ Description: Plan a new Building in the MAQUETTE map. {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(STAKEHOLDER Integer ID) |Stakeholder ID | |- |1 |REQUIRED |(FUNCTION Integer ID) |Function ID | |- |2 |REQUIRED |(Integer number) |Amount of floors | |- |3 |REQUIRED |(MultiPolygon with crs: EPSG:3857) |MultiPolygon describing..." |
No edit summary |
||
| Line 10: | Line 10: | ||
!Values | !Values | ||
|- | |- | ||
|0 | | 0 | ||
|REQUIRED | | REQUIRED | ||
|(STAKEHOLDER Integer ID) | | (STAKEHOLDER Integer ID) | ||
|[[Stakeholder]] ID | | [[Stakeholder]] ID | ||
| | | | ||
|- | |- | ||
|1 | | 1 | ||
|REQUIRED | | REQUIRED | ||
|(FUNCTION Integer ID) | | (FUNCTION Integer ID) | ||
|[[Function]] ID | | [[Function]] ID | ||
| | | | ||
|- | |- | ||
|2 | | 2 | ||
|REQUIRED | | REQUIRED | ||
|(Integer number) | | (Integer number) | ||
|Amount of floors | | Amount of floors | ||
| | | | ||
|- | |- | ||
|3 | | 3 | ||
|REQUIRED | | REQUIRED | ||
|(MultiPolygon with crs: EPSG:3857) | | (MultiPolygon with crs: EPSG:3857) | ||
|[[#Api Model MultiPolygon|MultiPolygon]] describing the build contour | | [[#Api Model MultiPolygon|MultiPolygon]] describing the build contour | ||
| | | | ||
|} | |} | ||
===Response Codes=== | ===Response Codes=== | ||
| Line 39: | Line 39: | ||
!Description | !Description | ||
|- | |- | ||
|200 | | 200 | ||
|Integer (Action Log ID) | | Integer (Action Log ID) | ||
|- | |- | ||
|300-600 | | 300-600 | ||
|Codes Overview | | Codes Overview | ||
|} | |} | ||
===Example POST=== | ===Example POST=== | ||
Revision as of 11:44, 8 June 2026
API Endpoint: api/session/event/participant/building_plan_construction/
Description: Plan a new Building in the MAQUETTE map.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (STAKEHOLDER Integer ID) | Stakeholder ID | |
| 1 | REQUIRED | (FUNCTION Integer ID) | Function ID | |
| 2 | REQUIRED | (Integer number) | Amount of floors | |
| 3 | REQUIRED | (MultiPolygon with crs: EPSG:3857) | MultiPolygon describing the build contour |
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_construction/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ 1, 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, 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_construction/?crs=3857", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));