Api session event editor building add polygons: 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
37,736 edits
Created page with "API Event to Add polygons for Building Section. In case the building is empty, optionally set ownership to largest Plot Owner of provided MultiPolygon {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(BUILDING Integer ID or multiple values in array [1, 2, 3]) |Building ID | |- |1 |REQUIRED |(Integer number or multiple values in array [1, 2, 3]) |Section ID | |- |2 |REQUIRED |(MultiPolygon with crs: EPSG:3857 or multiple values i..."
 
No edit summary
 
(19 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Event to Add polygons for [[Building]] Section. In case the building is empty, optionally set ownership to largest [[Plot]] Owner of provided MultiPolygon
API Endpoint: api/session/event/editorbuilding/add_polygons/
 
Description: Add polygons for [[Building]] [[Section]]. In case the [[Building]] is empty, optionally set ownership to largest [[Plot]] Owner of provided [[#Api Model MultiPolygon|MultiPolygon]]
 
{|class=wikitable
{|class=wikitable
!Name
!Name
Line 16: Line 19:
|REQUIRED
|REQUIRED
|(Integer number or multiple values in array [1, 2, 3])
|(Integer number or multiple values in array [1, 2, 3])
|Section ID
|[[Section]] ID
|
|
|-
|-
Line 22: Line 25:
|REQUIRED
|REQUIRED
|(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])
|MultiPolygon
|[[#Api Model MultiPolygon|MultiPolygon]]
|
|
|-
|-
Line 43: Line 46:
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editorbuilding/add_polygons/?crs=3857&f=HTML&token=API_TOKEN
Curl example POST:


with content:  
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorbuilding/add_polygons/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
<pre>[ [ 1, 2, 3 ], [ 1, 2, 3 ], [ {
[ 1, 1, {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799417.794785002 ], [ 658688.1592623573, 6799417.794785002 ], [ 658688.1592623573, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
  "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
}, false ]
'
</syntaxhighlight>
Curl example multi item POST:
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorbuilding/add_polygons/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ [ 1, 2, 3 ], [ 1, 2, 3 ], [ {
"type" : "MultiPolygon",
"coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
}, {
}, {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799300.374485122 ], [ 658673.9870508023, 6799300.374485122 ], [ 658673.9870508023, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
  "coordinates" : [ [ [ [ 658646.762, 6799451.896 ], [ 658646.762, 6799461.896 ], [ 658656.762, 6799461.896 ], [ 658656.762, 6799451.896 ], [ 658646.762, 6799451.896 ] ] ] ]
}, {
}, {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799325.640705583 ], [ 658714.8080873851, 6799325.640705583 ], [ 658714.8080873851, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
  "coordinates" : [ [ [ [ 658656.762, 6799451.896 ], [ 658656.762, 6799461.896 ], [ 658666.762, 6799461.896 ], [ 658666.762, 6799451.896 ], [ 658656.762, 6799451.896 ] ] ] ]
} ], false ]
} ], false ]
</pre>
'
{{article end|seealso=*[[api session event editor building]]}}
</syntaxhighlight>
JavaScript example POST:
 
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, 1, { "type" : "MultiPolygon", "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]}, false ]'
};
fetch("https://engine.tygron.com/api/session/event/editorbuilding/add_polygons/?crs=3857", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));
</syntaxhighlight>
{{article end|seealso=*[[Api session event editor building]]
*[[Api session items buildings]]
}}


[[Category:API]]
[[Category:API]]

Latest revision as of 08:19, 29 May 2026

API Endpoint: api/session/event/editorbuilding/add_polygons/

Description: Add polygons for Building Section. In case the Building is empty, optionally set ownership to largest Plot Owner of provided MultiPolygon

Name Importance Type Description Values
0 REQUIRED (BUILDING Integer ID or multiple values in array [1, 2, 3]) Building ID
1 REQUIRED (Integer number or multiple values in array [1, 2, 3]) Section ID
2 REQUIRED (MultiPolygon with crs: EPSG:3857 or multiple values in array [a, b, c]) MultiPolygon
3 REQUIRED (true, false) Use largest Owner 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/editorbuilding/add_polygons/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ 1, 1, {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
}, false ]
'

Curl example multi item POST: 

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

JavaScript example POST: 

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, 1, { "type" : "MultiPolygon", "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]}, false ]'
};
fetch("https://engine.tygron.com/api/session/event/editorbuilding/add_polygons/?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_building_add_polygons&oldid=81617"