Api session event editor start map creation: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
46,429 edits
No edit summary
No edit summary
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Endpoint: eventeditor/start_map_creation.
API Endpoint: api/session/event/editor/start_map_creation/


API Endpoint name is Api session event editor start map creation.
Description: Set the Project's georeference center [[Point]] to the provided coordinates and begin automatically loading available data.
 
API Endpoint to 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
!Index
!Importance
!Importance
!Type
!Type
Line 12: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(Floating point number)
| (Floating point number)
|Center point (Longitude or X coordinate)
| Center [[Point]] (Longitude or X coordinate)
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(Floating point number)
| (Floating point number)
|Center point (Latitude or Y coordinate)
| Center [[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 Polygon
| Optional: Limit data loading to this [[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 Polygons
| Optional: [[Area]] of Interest [[Polygon]]s
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 41: 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 '[ 94, 4 ]'
<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 '[ 10, 30, "", "" ]'
</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 '[ 18, 18 ]'
<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 '[ 37, 80, "", "" ]'
</syntaxhighlight>
</syntaxhighlight>
JavaScript example POST:
JavaScript example POST
 
<syntaxhighlight lang="text" copy>var options = {
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 10, 30, "", "" ]'
 body: '[ 94, 4 ]'
};
};
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 09:57, 13 July 2026

API Endpoint: api/session/event/editor/start_map_creation/

Description: Set the Project's georeference center Point to the provided coordinates and begin automatically loading 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 '[ 94, 4 ]'

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

JavaScript example POST 

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

See also

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