Api session event participant map levee: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
API Endpoint: api/session/event/participant/map_levee/ | API Endpoint: api/session/event/participant/map_levee/ | ||
Description: | Description: [[Stakeholder]] plans a [[Levee]] for a [[MultiPolygon]], an absolute or relative height and an angle. | ||
{|class=wikitable | {|class=wikitable | ||
| Line 13: | Line 13: | ||
| REQUIRED | | REQUIRED | ||
| (STAKEHOLDER Integer ID) | | (STAKEHOLDER Integer ID) | ||
| [[Stakeholder]] | | [[Stakeholder]] | ||
| | | | ||
|- | |- | ||
| Line 19: | Line 19: | ||
| REQUIRED | | REQUIRED | ||
| (LEVEE Integer ID) | | (LEVEE Integer ID) | ||
| [[Levee]] | | [[Levee]] | ||
| | | | ||
|- | |- | ||
| Line 25: | Line 25: | ||
| REQUIRED | | REQUIRED | ||
| (MultiPolygon with crs: EPSG:3857) | | (MultiPolygon with crs: EPSG:3857) | ||
| [[MultiPolygon]] | | [[MultiPolygon]] | ||
| | | | ||
|- | |- | ||
| Line 43: | Line 43: | ||
| REQUIRED | | REQUIRED | ||
| (true, false) | | (true, false) | ||
| | | Height is relative | ||
| true or false | | true or false | ||
|} | |} | ||
| Line 63: | Line 63: | ||
"type" : "MultiPolygon", | "type" : "MultiPolygon", | ||
"coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ] | "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ] | ||
}, | }, 91, 7, true ] | ||
' | ' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 71: | Line 71: | ||
"type" : "MultiPolygon", | "type" : "MultiPolygon", | ||
"coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ] | "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ] | ||
}, | }, 10, 7, true ] | ||
' | ' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 78: | Line 78: | ||
method: "POST", | method: "POST", | ||
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | 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 ] ] ] ]}, | 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 ] ] ] ]}, 91, 7, true ]' | ||
}; | }; | ||
fetch("https://engine.tygron.com/api/session/event/participant/map_levee/?crs=3857", options) | fetch("https://engine.tygron.com/api/session/event/participant/map_levee/?crs=3857", options) | ||
Revision as of 15:33, 10 November 2026
API Endpoint: api/session/event/participant/map_levee/
Description: Stakeholder plans a Levee for a MultiPolygon, an absolute or relative height and an angle.
| Index | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (STAKEHOLDER Integer ID) | Stakeholder | |
| 1 | REQUIRED | (LEVEE Integer ID) | Levee | |
| 2 | REQUIRED | (MultiPolygon with crs: EPSG:3857) | MultiPolygon | |
| 3 | REQUIRED | (Floating point number) | Height in meters | |
| 4 | REQUIRED | (Floating point number) | Angle in degrees | |
| 5 | REQUIRED | (true, false) | Height is relative | true or false |
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/map_levee/?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 ] ] ] ]
}, 91, 7, true ]
'Curl example multi item POST
curl 'https://engine.tygron.com/api/session/event/participant/map_levee/?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 ] ] ] ]
}, 10, 7, true ]
'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 ] ] ] ]}, 91, 7, true ]'
};
fetch("https://engine.tygron.com/api/session/event/participant/map_levee/?crs=3857", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));