Api session event editor clear map: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
46,429 edits
Created page with "API Event to Remove all geospatial data of the Project, such as buildings, areas, etc. {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(true, false) |Delete the map size and georeference too (false means deleting only the geodata) |true or false |} ===Response Codes=== {|class=wikitable !Response Code: !Description |- |204 |No Content |- |300-600 |Codes Overview |} ===Example POST=== Example POST: https://engine.tygron.com/api/session/ev..."
 
No edit summary
 
(33 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Event to Remove all geospatial data of the Project, such as buildings, areas, etc.
API Endpoint: api/session/event/editor/clear_map/
 
Description: Remove all geospatial data of the Project, such as [[Building]]s, [[Area]]s, etc.
 
{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 7: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(true, false)
| (true, false)
|Delete the map size and georeference too (false means deleting only the geodata)
| True to delete map size and georeference; false to delete only geospatial data.
|true  or  false
| true  or  false
|}
|}
===Response Codes===
===Response Codes===
Line 18: Line 21:
!Description
!Description
|-
|-
|204
| 204
|No Content
| No Content
|-
|-
|300-600
| 300-600
|Codes Overview
| Codes Overview
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editor/clear_map/?f=HTML&token=API_TOKEN
Curl example POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editor/clear_map/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d 'true'
with content:  
</syntaxhighlight>
<pre>[ false ]
JavaScript example POST
</pre>
<syntaxhighlight lang="text" copy>var options = {
{{article end|seealso=*[[api session event editor]]}}
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: 'true'
};
fetch("https://engine.tygron.com/api/session/event/editor/clear_map/", 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 09:57, 13 July 2026

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

Description: Remove all geospatial data of the Project, such as Buildings, Areas, etc.

Index Importance Type Description Values
0 REQUIRED (true, false) True to delete map size and georeference; false to delete only geospatial data. true or false

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/clear_map/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d 'true'

JavaScript example POST 

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: 'true'
};
fetch("https://engine.tygron.com/api/session/event/editor/clear_map/", 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_clear_map&oldid=90788"