Api session event participant parametric design plan: 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/parametric_design_plan/
API Endpoint: api/session/event/participant/parametric_design_plan/


Description: [[Parametric Design]] Plan
Description: [[Stakeholder]] plans a generated [[Parametric Design]]


{|class=wikitable
{|class=wikitable
Line 13: Line 13:
| REQUIRED
| REQUIRED
| (STAKEHOLDER Integer ID)
| (STAKEHOLDER Integer ID)
| [[Stakeholder]]s
| [[Stakeholder]]
|  
|  
|-
|-
Line 19: Line 19:
| REQUIRED
| REQUIRED
| (PARAMETRIC_DESIGN Integer ID)
| (PARAMETRIC_DESIGN Integer ID)
| [[Parametric Design]]s
| [[Parametric Design]]
|  
|  
|-
|-
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[]
| [[Plot Design]] 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 [[Plot Design]]
|  
|  
|}
|}
Line 46: Line 46:
|-
|-
| 200
| 200
| Integer[] (Integer array)
| Integer[] (Building IDs)
|-
|-
| 300-600
| 300-600

Latest revision as of 14:55, 11 November 2026

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

Description: Stakeholder plans a generated Parametric Design

Index Importance Type Description Values
0 REQUIRED (STAKEHOLDER Integer ID) Stakeholder
1 REQUIRED (PARAMETRIC_DESIGN Integer ID) Parametric Design
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]) Plot Design IDs
4 REQUIRED (MultiPolygon or multiple values in array [a, b, c]) Array of MultiPolygons per Plot Design

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/participant/parametric_design_plan/' -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/participant/parametric_design_plan/' -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/participant/parametric_design_plan/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));