Api session event editor start map creation: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (24 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
API | API Endpoint: api/session/event/editor/start_map_creation/ | ||
Description: Set the Project's georeference center point to the provided coordinates and begin the process of automatically load in available data. | |||
{|class=wikitable | {|class=wikitable | ||
!Name | !Name | ||
| Line 22: | Line 25: | ||
|OPTIONAL | |OPTIONAL | ||
|(MultiPolygon with crs: EPSG:3857) | |(MultiPolygon with crs: EPSG:3857) | ||
|Optional: Limit data loading to this Polygon | |Optional: Limit data loading to this [[#Api Model Polygon|Polygon]] | ||
| | | | ||
|- | |- | ||
| Line 28: | Line 31: | ||
|OPTIONAL | |OPTIONAL | ||
|(MultiPolygon with crs: EPSG:3857 or multiple values in array [a, b, c]) | |(MultiPolygon with crs: EPSG:3857 or multiple values in array [a, b, c]) | ||
|Optional: [[Area]] of Interest | |Optional: [[Area]] of Interest [[#Api Model Polygon|Polygon]]s | ||
| | | | ||
|} | |} | ||
| Line 43: | Line 46: | ||
|} | |} | ||
===Example POST=== | ===Example POST=== | ||
Curl example POST: | |||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editor/start_map_creation/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 84, 26 ]' | |||
</syntaxhighlight> | |||
Curl example multi item POST: | |||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editor/start_map_creation/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 35, 17 ]' | |||
</syntaxhighlight> | |||
JavaScript example POST: | |||
<syntaxhighlight lang="text" copy>var options = { | |||
< | method: "POST", | ||
</ | headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | ||
{{article end|seealso=*[[ | body: '[ 84, 26 ]' | ||
}; | |||
fetch("https://engine.tygron.com/api/session/event/editor/start_map_creation/?crs=3857", options) | |||
.then(response => response.text()) | |||
.then(result => console.log(result)) | |||
.catch(error => console.log('error', error)); | |||
</syntaxhighlight> | |||
{{article end|seealso=*[[Api session event editor]] | |||
}} | |||
[[Category:API]] | [[Category:API]] | ||
Latest revision as of 08:19, 29 May 2026
API Endpoint: api/session/event/editor/start_map_creation/
Description: Set the Project's georeference center point to the provided coordinates and begin the process of automatically load in available data.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (Floating point number) | Center point (Longitude or X coordinate) | |
| 1 | REQUIRED | (Floating point number) | Center point (Latitude or Y coordinate) | |
| 2 | OPTIONAL | (MultiPolygon with crs: EPSG:3857) | Optional: Limit data loading to this Polygon | |
| 3 | OPTIONAL | (MultiPolygon with crs: EPSG:3857 or multiple values in array [a, b, c]) | Optional: Area of Interest Polygons |
Response Codes
| Response Code: | Description |
|---|---|
| 204 | No Content |
| 300-600 | Codes Overview |
Example POST
Curl example POST:
curl 'https://engine.tygron.com/api/session/event/editor/start_map_creation/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 84, 26 ]'Curl example multi item POST:
curl 'https://engine.tygron.com/api/session/event/editor/start_map_creation/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 35, 17 ]'JavaScript example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 84, 26 ]'
};
fetch("https://engine.tygron.com/api/session/event/editor/start_map_creation/?crs=3857", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));