Api session event participant parametric design plan: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older editNewer edit →
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
43,025 edits
No edit summary
No edit summary
Line 10: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(STAKEHOLDER Integer ID)
| (STAKEHOLDER Integer ID)
|[[Stakeholder]]s
| [[Stakeholder]]s
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(PARAMETRIC_DESIGN Integer ID)
| (PARAMETRIC_DESIGN Integer ID)
|[[Parametric Design]]s
| [[Parametric Design]]s
|
|  
|-
|-
|2
| 2
|REQUIRED
| REQUIRED
|(FunctionType or multiple values in array [a, b, c])
| (FunctionType or multiple values in array [a, b, c])
|[[Function]]Type[]
| [[Function]]Type[]
|
|  
|-
|-
|3
| 3
|REQUIRED
| REQUIRED
|(Integer number or multiple values in array [1, 2, 3])
| (Integer number or multiple values in array [1, 2, 3])
|Integer[]
| Integer[]
|
|  
|-
|-
|4
| 4
|REQUIRED
| REQUIRED
|(MultiPolygon or multiple values in array [a, b, c])
| (MultiPolygon or multiple values in array [a, b, c])
|[[#Api Model MultiPolygon|MultiPolygon]][][]
| [[#Api Model MultiPolygon|MultiPolygon]][][]
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 45: Line 45:
!Description
!Description
|-
|-
|200
| 200
|Integer[] (Integer array)
| Integer[] (Integer array)
|-
|-
|300-600
| 300-600
|Codes Overview
| Codes Overview
|}
|}
===Example POST===
===Example POST===

Revision as of 11:44, 8 June 2026

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

Description: Parametric Design Plan

Name Importance Type Description Values
0 REQUIRED (STAKEHOLDER Integer ID) Stakeholders
1 REQUIRED (PARAMETRIC_DESIGN Integer ID) Parametric Designs
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/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));

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_event_participant_parametric_design_plan&oldid=84359"