Api session event editor parametric add example: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Event to Add Example
API Endpoint: api/session/event/editorparametric/add_example/
 
Description: Add Example
 
{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 7: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(Enumeration)
| (Enumeration)
|Example
| Example
|CITY_NEIGHBORHOOD, SUBURBAN_NEIGHBORHOOD, URBAN_NEIGHBORHOOD  or  WINDMILL_AREA
| CITY_NEIGHBORHOOD, SUBURBAN_NEIGHBORHOOD, URBAN_NEIGHBORHOOD  or  WINDMILL_AREA
|}
|}
===Response Codes===
===Response Codes===
Line 18: Line 21:
!Description
!Description
|-
|-
|204
| 204
|No Content
| No Content
|-
|-
|300-600
| 300-600
|Codes Overview
| Codes Overview
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editorparametric/add_example/?f=JSON&token=API_TOKEN
Curl example POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorparametric/add_example/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '"CITY_NEIGHBORHOOD"'
with content:  
</syntaxhighlight>
<pre>[ "URBAN_NEIGHBORHOOD" ]
JavaScript example POST
</pre>
<syntaxhighlight lang="text" copy>var options = {
{{article end|seealso=*[[api session event editor parametric]]
 method: "POST",
*[[api session items parametricdesigns]]
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '"CITY_NEIGHBORHOOD"'
};
fetch("https://engine.tygron.com/api/session/event/editorparametric/add_example/", 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 12:05, 15 June 2026

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

Description: Add Example

Index Importance Type Description Values
0 REQUIRED (Enumeration) Example CITY_NEIGHBORHOOD, SUBURBAN_NEIGHBORHOOD, URBAN_NEIGHBORHOOD or WINDMILL_AREA

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/add_example/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '"CITY_NEIGHBORHOOD"'

JavaScript example POST

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '"CITY_NEIGHBORHOOD"'
};
fetch("https://engine.tygron.com/api/session/event/editorparametric/add_example/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));