Api session event participant map levee: Difference between revisions
Jump to navigation
Jump to search
Created page with "API Endpoint: api/session/event/participant/map_levee/ Description: Create a Levee with a given height and Area. {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(STAKEHOLDER Integer ID) |Stakeholder ID | |- |1 |REQUIRED |(LEVEE Integer ID) |Levee ID | |- |2 |REQUIRED |(MultiPolygon with crs: EPSG:3857) |Multipolygon describing the surface Area | |- |3 |REQUIRED |(Floating point number) |Height in meters | |- |4 |REQUI..." |
No edit summary |
||
| Line 25: | Line 25: | ||
|REQUIRED | |REQUIRED | ||
|(MultiPolygon with crs: EPSG:3857) | |(MultiPolygon with crs: EPSG:3857) | ||
| | |[[#Api Model MultiPolygon|MultiPolygon]] describing the surface [[Area]] | ||
| | | | ||
|- | |- | ||
| Line 64: | Line 64: | ||
"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 ] ] ] ] | ||
}, | }, 86, 56, true ] | ||
' | ' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 73: | Line 73: | ||
"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 ] ] ] ] | ||
}, | }, 54, 70, true ] | ||
' | ' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 81: | Line 81: | ||
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 ] ] ] ]}, 86, 56, 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) | ||
Latest revision as of 14:49, 2 June 2026
API Endpoint: api/session/event/participant/map_levee/
Description: Create a Levee with a given height and Area.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (STAKEHOLDER Integer ID) | Stakeholder ID | |
| 1 | REQUIRED | (LEVEE Integer ID) | Levee ID | |
| 2 | REQUIRED | (MultiPolygon with crs: EPSG:3857) | MultiPolygon describing the surface Area | |
| 3 | REQUIRED | (Floating point number) | Height in meters | |
| 4 | REQUIRED | (Floating point number) | Angle in degrees | |
| 5 | REQUIRED | (true, false) | Is height 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 ] ] ] ]
}, 86, 56, 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 ] ] ] ]
}, 54, 70, 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 ] ] ] ]}, 86, 56, 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));