Api session event editor parametric set 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 Set Polygons {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(PARAMETRIC_DESIGN Integer ID or multiple values in array [1, 2, 3]) |Parametric Designs | |- |1 |REQUIRED |(MultiPolygon with crs: EPSG:3857 or multiple values in array [a, b, c]) |MultiPolygon[] | |} ===Response Codes=== {|class=wikitable !Response Code: !Description |- |204 |No Content |- |300-600 |Codes Overview |} ===Example POST=== Example POST: https://eng..."
 
No edit summary
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Event to Set Polygons
API Endpoint: api/session/event/editorparametric/set_polygons/
 
Description: Set polygons to existing Parametric
 
{|class=wikitable
{|class=wikitable
!Name
!Name
Line 10: Line 13:
|REQUIRED
|REQUIRED
|(PARAMETRIC_DESIGN Integer ID or multiple values in array [1, 2, 3])
|(PARAMETRIC_DESIGN Integer ID or multiple values in array [1, 2, 3])
|[[Parametric Design]]s
|[[Parametric Design]]
|
|
|-
|-
Line 16: Line 19:
|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 31: Line 34:
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editorparametric/set_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/editorparametric/set_polygons/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
<pre>[ [ 1, 2, 3 ], [ {
[ 1, {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799382.926472285 ], [ 658645.8180343907, 6799382.926472285 ], [ 658645.8180343907, 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 ] ] ] ]
} ]
'
</syntaxhighlight>
Curl example multi item POST:
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorparametric/set_polygons/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ [ 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, 6799392.011806051 ], [ 658691.2434967995, 6799392.011806051 ], [ 658691.2434967995, 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, 6799430.333057039 ], [ 658731.8663887788, 6799430.333057039 ], [ 658731.8663887788, 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 ] ] ] ]
} ] ]
} ] ]
</pre>
'
{{article end|seealso=*[[api session event editor parametric]]}}
</syntaxhighlight>
JavaScript example POST:
 
<syntaxhighlight lang="text" copy>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/editorparametric/set_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 parametric]]
*[[Api session items parametricdesigns]]
}}


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

Latest revision as of 08:21, 29 May 2026

API Endpoint: api/session/event/editorparametric/set_polygons/

Description: Set polygons to existing Parametric

Name Importance Type Description Values
0 REQUIRED (PARAMETRIC_DESIGN Integer ID or multiple values in array [1, 2, 3]) Parametric Design
1 REQUIRED (MultiPolygon with crs: EPSG:3857 or multiple values in array [a, b, c]) MultiPolygon[]

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/editorparametric/set_polygons/?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 ] ] ] ]
} ]
'

Curl example multi item POST: 

curl 'https://engine.tygron.com/api/session/event/editorparametric/set_polygons/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ [ 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 ] ] ] ]
} ] ]
'

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/editorparametric/set_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_parametric_set_polygons&oldid=81662"