Api session event editor parametric apply: 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 Apply {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(PARAMETRIC_DESIGN Integer ID) |Parametric Designs | |- |1 |REQUIRED |(STAKEHOLDER Integer ID) |Stakeholders | |- |2 |REQUIRED |(FunctionType or multiple values in array [a, b, c]) |FunctionType[] | |- |3 |REQUIRED |(Integer number or multiple values in array [1, 2, 3]) |Integer[] | |- |4 |REQUIRED |(MultiPolygon or multiple values in array [a, b, c]) |MultiPoly..."
 
No edit summary
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Event to Apply
API Endpoint: api/session/event/editorparametric/apply/
 
Description: Apply
 
{|class=wikitable
{|class=wikitable
!Name
!Name
Line 10: Line 13:
|REQUIRED
|REQUIRED
|(PARAMETRIC_DESIGN Integer ID)
|(PARAMETRIC_DESIGN Integer ID)
|[[Parametric Design]]s
|[[Parametric Design]]
|
|
|-
|-
Line 16: Line 19:
|REQUIRED
|REQUIRED
|(STAKEHOLDER Integer ID)
|(STAKEHOLDER Integer ID)
|[[Stakeholder]]s
|[[Stakeholder]]
|
|
|-
|-
Line 34: Line 37:
|REQUIRED
|REQUIRED
|(MultiPolygon or multiple values in array [a, b, c])
|(MultiPolygon or multiple values in array [a, b, c])
|MultiPolygon[][]
|[[#Api Model MultiPolygon|MultiPolygon]][][]
|
|
|}
|}
Line 49: Line 52:
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editorparametric/apply/?f=HTML&token=API_TOKEN
Curl example POST:


with content:  
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorparametric/apply/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
<pre>[ 12, 6, [ "REMAINDER", "PUBLIC_GREEN", "GARDEN" ], [ 1, 2, 3 ], [ [ {
[ 1, 1, "ROAD", 1, [ {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799374.930932248 ], [ 658718.0709767976, 6799374.930932248 ], [ 658718.0709767976, 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 ] ] ] ]
}, {
}, {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799391.945217045 ], [ 658704.6945919287, 6799391.945217045 ], [ 658704.6945919287, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
  "coordinates" : [ [ [ [ 658636.762, 6799441.896 ], [ 658636.762, 6799451.896 ], [ 658646.762, 6799451.896 ], [ 658646.762, 6799441.896 ], [ 658636.762, 6799441.896 ] ] ] ]
} ] ]
'
</syntaxhighlight>
Curl example multi item POST:
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorparametric/apply/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ 1, 1, [ "ROAD", "WATER", "PARKING" ], [ 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" : [ [ [ [ 658636.762, 6799441.896 ], [ 658636.762, 6799451.896 ], [ 658646.762, 6799451.896 ], [ 658646.762, 6799441.896 ], [ 658636.762, 6799441.896 ] ] ] ]
} ], [ {
} ], [ {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799302.828506164 ], [ 658773.6846449232, 6799302.828506164 ], [ 658773.6846449232, 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, 6799354.561261838 ], [ 658767.9985444586, 6799354.561261838 ], [ 658767.9985444586, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
  "coordinates" : [ [ [ [ 658646.762, 6799441.896 ], [ 658646.762, 6799451.896 ], [ 658656.762, 6799451.896 ], [ 658656.762, 6799441.896 ], [ 658646.762, 6799441.896 ] ] ] ]
} ], [ {
} ], [ {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799423.529580336 ], [ 658731.869637051, 6799423.529580336 ], [ 658731.869637051, 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 ] ] ] ]
}, {
}, {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799408.530768496 ], [ 658725.7596370659, 6799408.530768496 ], [ 658725.7596370659, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
  "coordinates" : [ [ [ [ 658656.762, 6799441.896 ], [ 658656.762, 6799451.896 ], [ 658666.762, 6799451.896 ], [ 658666.762, 6799441.896 ], [ 658656.762, 6799441.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, 1, "ROAD", 1, [ { "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" : [ [ [ [ 658636.762, 6799441.896 ], [ 658636.762, 6799451.896 ], [ 658646.762, 6799451.896 ], [ 658646.762, 6799441.896 ], [ 658636.762, 6799441.896 ] ] ] ]} ] ]'
};
fetch("https://engine.tygron.com/api/session/event/editorparametric/apply/", 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/apply/

Description: Apply

Name Importance Type Description Values
0 REQUIRED (PARAMETRIC_DESIGN Integer ID) Parametric Design
1 REQUIRED (STAKEHOLDER Integer ID) Stakeholder
2 REQUIRED (FunctionType or multiple values in array [a, b, c]) FunctionType[]
3 REQUIRED (Integer number or multiple values in array [1, 2, 3]) Integer[]
4 REQUIRED (MultiPolygon or multiple values in array [a, b, c]) MultiPolygon[][]

Response Codes

Response Code: Description
200 Integer[] (Integer array)
300-600 Codes Overview

Example POST

Curl example POST: 

curl 'https://engine.tygron.com/api/session/event/editorparametric/apply/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ 1, 1, "ROAD", 1, [ {
 "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" : [ [ [ [ 658636.762, 6799441.896 ], [ 658636.762, 6799451.896 ], [ 658646.762, 6799451.896 ], [ 658646.762, 6799441.896 ], [ 658636.762, 6799441.896 ] ] ] ]
} ] ]
'

Curl example multi item POST: 

curl 'https://engine.tygron.com/api/session/event/editorparametric/apply/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ 1, 1, [ "ROAD", "WATER", "PARKING" ], [ 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" : [ [ [ [ 658636.762, 6799441.896 ], [ 658636.762, 6799451.896 ], [ 658646.762, 6799451.896 ], [ 658646.762, 6799441.896 ], [ 658636.762, 6799441.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" : [ [ [ [ 658646.762, 6799441.896 ], [ 658646.762, 6799451.896 ], [ 658656.762, 6799451.896 ], [ 658656.762, 6799441.896 ], [ 658646.762, 6799441.896 ] ] ] ]
} ], [ {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658656.762, 6799451.896 ], [ 658656.762, 6799461.896 ], [ 658666.762, 6799461.896 ], [ 658666.762, 6799451.896 ], [ 658656.762, 6799451.896 ] ] ] ]
}, {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658656.762, 6799441.896 ], [ 658656.762, 6799451.896 ], [ 658666.762, 6799451.896 ], [ 658666.762, 6799441.896 ], [ 658656.762, 6799441.896 ] ] ] ]
} ] ] ]
'

JavaScript example POST: 

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, 1, "ROAD", 1, [ { "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" : [ [ [ [ 658636.762, 6799441.896 ], [ 658636.762, 6799451.896 ], [ 658646.762, 6799451.896 ], [ 658646.762, 6799441.896 ], [ 658636.762, 6799441.896 ] ] ] ]} ] ]'
};
fetch("https://engine.tygron.com/api/session/event/editorparametric/apply/", 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_apply&oldid=81663"