Api session event editor start map creation: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 10: | Line 10: | ||
!Values | !Values | ||
|- | |- | ||
|0 | | 0 | ||
|REQUIRED | | REQUIRED | ||
|(Floating point number) | | (Floating point number) | ||
|Center [[#Api Model Point|Point]] (Longitude or X coordinate) | | Center [[#Api Model Point|Point]] (Longitude or X coordinate) | ||
| | | | ||
|- | |- | ||
|1 | | 1 | ||
|REQUIRED | | REQUIRED | ||
|(Floating point number) | | (Floating point number) | ||
|Center [[#Api Model Point|Point]] (Latitude or Y coordinate) | | Center [[#Api Model Point|Point]] (Latitude or Y coordinate) | ||
| | | | ||
|- | |- | ||
|2 | | 2 | ||
|OPTIONAL | | OPTIONAL | ||
|(MultiPolygon with crs: EPSG:3857) | | (MultiPolygon with crs: EPSG:3857) | ||
|Optional: Limit data loading to this [[#Api Model Polygon|Polygon]] | | Optional: Limit data loading to this [[#Api Model Polygon|Polygon]] | ||
| | | | ||
|- | |- | ||
|3 | | 3 | ||
|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 [[#Api Model Polygon|Polygon]]s | | Optional: [[Area]] of Interest [[#Api Model Polygon|Polygon]]s | ||
| | | | ||
|} | |} | ||
===Response Codes=== | ===Response Codes=== | ||
| Line 39: | Line 39: | ||
!Description | !Description | ||
|- | |- | ||
|204 | | 204 | ||
|No Content | | No Content | ||
|- | |- | ||
|300-600 | | 300-600 | ||
|Codes Overview | | Codes Overview | ||
|} | |} | ||
===Example POST=== | ===Example POST=== | ||
Curl 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 '[ | <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 '[ 3, 61 ]' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Curl example multi item POST: | 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 '[ | <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 '[ 95, 94 ]' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
JavaScript example POST: | JavaScript example POST: | ||
| Line 59: | Line 59: | ||
method: "POST", | method: "POST", | ||
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | ||
body: '[ | body: '[ 3, 61 ]' | ||
}; | }; | ||
fetch("https://engine.tygron.com/api/session/event/editor/start_map_creation/?crs=3857", options) | fetch("https://engine.tygron.com/api/session/event/editor/start_map_creation/?crs=3857", options) | ||
Revision as of 11:37, 8 June 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 '[ 3, 61 ]'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 '[ 95, 94 ]'JavaScript example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 3, 61 ]'
};
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));