Api session event participant building revert polygon: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Endpoint: api/session/event/participant/building_revert_polygon/
API Endpoint: api/session/event/participant/building_revert_polygon/


Description: Revert [[#Api Model Polygon|Polygon]] to orginal CURRENT map situation.
Description: Revert [[Polygon]] to orginal CURRENT map situation.


{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 10: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(STAKEHOLDER Integer ID)
| (STAKEHOLDER Integer ID)
|[[Stakeholder]] ID
| [[Stakeholder]] ID
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(MultiPolygon with crs: EPSG:3857)
| (MultiPolygon with crs: EPSG:3857)
|[[#Api Model MultiPolygon|MultiPolygon]] describing the to be reverted [[Area]]
| [[MultiPolygon]] describing the to be reverted [[Area]]
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 27: Line 27:
!Description
!Description
|-
|-
|200
| 200
|Integer (Action Log ID)
| Integer (Action Log ID)
|-
|-
|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/participant/building_revert_polygon/?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/participant/building_revert_polygon/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ 1, {
[ 1, {
Line 43: Line 42:
'
'
</syntaxhighlight>
</syntaxhighlight>
JavaScript example POST:
JavaScript example POST
 
<syntaxhighlight lang="text" copy>var options = {
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 method: "POST",

Latest revision as of 13:03, 19 June 2026

API Endpoint: api/session/event/participant/building_revert_polygon/

Description: Revert Polygon to orginal CURRENT map situation.

Index Importance Type Description Values
0 REQUIRED (STAKEHOLDER Integer ID) Stakeholder ID
1 REQUIRED (MultiPolygon with crs: EPSG:3857) MultiPolygon describing the to be reverted Area

Response Codes

Response Code: Description
200 Integer (Action Log ID)
300-600 Codes Overview

Example POST

Curl example POST

curl 'https://engine.tygron.com/api/session/event/participant/building_revert_polygon/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ 1, {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
} ]
'

JavaScript example POST

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, { "type" : "MultiPolygon", "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]} ]'
};
fetch("https://engine.tygron.com/api/session/event/participant/building_revert_polygon/?crs=3857", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));