Api session event participant map levee: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older editNewer edit →
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
43,025 edits
No edit summary
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
|(LEVEE Integer ID)
| (LEVEE Integer ID)
|[[Levee]] ID
| [[Levee]] ID
|
|  
|-
|-
|2
| 2
|REQUIRED
| REQUIRED
|(MultiPolygon with crs: EPSG:3857)
| (MultiPolygon with crs: EPSG:3857)
|[[#Api Model MultiPolygon|MultiPolygon]] describing the surface [[Area]]
| [[#Api Model MultiPolygon|MultiPolygon]] describing the surface [[Area]]
|
|  
|-
|-
|3
| 3
|REQUIRED
| REQUIRED
|(Floating point number)
| (Floating point number)
|Height in meters
| Height in meters
|
|  
|-
|-
|4
| 4
|REQUIRED
| REQUIRED
|(Floating point number)
| (Floating point number)
|Angle in degrees
| Angle in degrees
|
|  
|-
|-
|5
| 5
|REQUIRED
| REQUIRED
|(true, false)
| (true, false)
|Is height relative
| Is height relative
|true  or  false
| true  or  false
|}
|}
===Response Codes===
===Response Codes===
Line 51: Line 51:
!Description
!Description
|-
|-
|200
| 200
|Integer (Action Log ID)
| Integer (Action Log ID)
|-
|-
|300-600
| 300-600
|Codes Overview
| Codes Overview
|}
|}
===Example POST===
===Example POST===
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 ]
}, 4, 49, 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 ]
}, 57, 51, 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 ] ] ] ]}, 86, 56, true ]'
 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 ] ] ] ]}, 4, 49, 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 11:44, 8 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 ] ] ] ]
}, 4, 49, 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 ] ] ] ]
}, 57, 51, 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 ] ] ] ]}, 4, 49, 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));

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_event_participant_map_levee&oldid=84346"