Api session event editor parametric apply: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
50,011 edits
No edit summary
No edit summary
 
Line 1: Line 1:
API Endpoint: api/session/event/editorparametric/apply/
API Endpoint: api/session/event/editorparametric/apply/


Description: Apply
Description: Apply a [[Parametric Design]] for a [[Stakeholder]], [[Function]] Types, [[Function]] IDs and one or more [[MultiPolygon]]s per [[Function]] Type.


{|class=wikitable
{|class=wikitable
Line 13: Line 13:
| REQUIRED
| REQUIRED
| (PARAMETRIC_DESIGN Integer ID)
| (PARAMETRIC_DESIGN Integer ID)
| [[Parametric Design]]s
| [[Parametric Design]]
|  
|  
|-
|-
Line 19: Line 19:
| REQUIRED
| REQUIRED
| (STAKEHOLDER Integer ID)
| (STAKEHOLDER Integer ID)
| [[Stakeholder]]s
| [[Stakeholder]] (owner)
|  
|  
|-
|-
Line 25: Line 25:
| REQUIRED
| REQUIRED
| (FunctionType or multiple values in array [a, b, c])
| (FunctionType or multiple values in array [a, b, c])
| [[Function]]Type[]
| [[Function]] Types
|  
|  
|-
|-
Line 31: Line 31:
| REQUIRED
| REQUIRED
| (Integer number or multiple integer values in array [1, 2, 3])
| (Integer number or multiple integer values in array [1, 2, 3])
| Integer[]
| [[Function]] IDs
|  
|  
|-
|-
Line 37: Line 37:
| REQUIRED
| REQUIRED
| (MultiPolygon or multiple values in array [a, b, c])
| (MultiPolygon or multiple values in array [a, b, c])
| [[MultiPolygon]][][]
| Array of [[MultiPolygon]]s per [[Function]] Type
|  
|  
|}
|}
Line 46: Line 46:
|-
|-
| 200
| 200
| Integer[] (Integer array)
| Integer[] (Building IDs)
|-
|-
| 300-600
| 300-600

Latest revision as of 15:31, 10 November 2026

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

Description: Apply a Parametric Design for a Stakeholder, Function Types, Function IDs and one or more MultiPolygons per Function Type.

Index Importance Type Description Values
0 REQUIRED (PARAMETRIC_DESIGN Integer ID) Parametric Design
1 REQUIRED (STAKEHOLDER Integer ID) Stakeholder (owner)
2 REQUIRED (FunctionType or multiple values in array [a, b, c]) Function Types
3 REQUIRED (Integer number or multiple integer values in array [1, 2, 3]) Function IDs
4 REQUIRED (MultiPolygon or multiple values in array [a, b, c]) Array of MultiPolygons per Function Type

Response Codes

Response Code: Description
200 Integer[] (Building IDs)
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=96931"