Api session event editor start map creation: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 1: Line 1:
API Endpoint: api/session/event/editor/start_map_creation/
API Endpoint: api/session/event/editor/start_map_creation/


Description: Set the Project's georeference center [[#Api Model Point|Point]] to the provided coordinates and begin the process of automatically load in available data.
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
Line 13: Line 13:
| REQUIRED
| REQUIRED
| (Floating point number)
| (Floating point number)
| Center [[#Api Model Point|Point]] (Longitude or X coordinate)
| Center [[Point]] (Longitude or X coordinate)
|  
|  
|-
|-
Line 19: Line 19:
| REQUIRED
| REQUIRED
| (Floating point number)
| (Floating point number)
| Center [[#Api Model Point|Point]] (Latitude or Y coordinate)
| Center [[Point]] (Latitude or Y coordinate)
|  
|  
|-
|-
Line 25: Line 25:
| 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 [[Polygon]]
|  
|  
|-
|-
Line 31: 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 [[#Api Model Polygon|Polygon]]s
| Optional: [[Area]] of Interest [[Polygon]]s
|  
|  
|}
|}
Line 47: Line 47:
===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 '[ 74, 48 ]'
<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 '[ 11, 94 ]'
</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 '[ 9, 71 ]'
<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 '[ 20, 75 ]'
</syntaxhighlight>
</syntaxhighlight>
JavaScript example POST
JavaScript example POST
Line 56: Line 56:
 method: "POST",
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 74, 48 ]'
 body: '[ 11, 94 ]'
};
};
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)

Latest revision as of 13:00, 19 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.

Index 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 '[ 11, 94 ]'

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 '[ 20, 75 ]'

JavaScript example POST

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 11, 94 ]'
};
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));