Api session items scenarios: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 43: Line 43:
ZIPSMILE:  
ZIPSMILE:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
==Api Model Scenario==
API Model description of Scenario
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|description
|String
|
|-
|events
|CodedEvent<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|limitNeighborhoodIDs
|int<nowiki>[]</nowiki>
|[[Neighborhood]] ID
|-
|limitType
|LimitType
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|restartTestrun
|boolean
|
|-
|version
|int
|
|}
{{article end|seealso=*[[Api Content Items]]
{{article end|seealso=*[[Api Content Items]]
*[[Api session event editor scenario]]
*[[Api session event editor scenario]]

Revision as of 11:53, 20 April 2026

Api session items Scenario Endpoints.

Edit items with event: editorscenario.

Default Query:

https://engine.tygron.com/api/session/items/scenarios/?f=JSON&token=API_TOKEN

Example Response:

[ {
  "attributes" : null,
  "description" : "",
  "events" : [ ],
  "id" : 0,
  "limitNeighborhoodIDs" : [ ],
  "limitType" : "DEFAULT",
  "maquetteOverride" : null,
  "name" : "Scenario",
  "restartTestrun" : true,
  "version" : 2
} ]

Limit Queries

version=100:

https://engine.tygron.com/api/session/items/scenarios/?version=100&token=API_TOKEN

Show Queries

max version:

https://engine.tygron.com/api/session/items/scenarios/version/?token=API_TOKEN

size:

https://engine.tygron.com/api/session/items/scenarios/size/?token=API_TOKEN

Scenarios (GeoJSON):

https://engine.tygron.com/web/scenarios.geojson?token=API_TOKEN

Formats

HTML:

https://engine.tygron.com/api/session/items/scenarios/?f=HTML&token=API_TOKEN

JSON:

https://engine.tygron.com/api/session/items/scenarios/?f=JSON&token=API_TOKEN

CSV:

https://engine.tygron.com/api/session/items/scenarios/?f=CSV&token=API_TOKEN

SSV:

https://engine.tygron.com/api/session/items/scenarios/?f=SSV&token=API_TOKEN

SMILE:

https://engine.tygron.com/api/session/items/scenarios/?f=SMILE&token=API_TOKEN

ZIPJSON:

https://engine.tygron.com/api/session/items/scenarios/?f=ZIPJSON&token=API_TOKEN

ZIPSMILE:

https://engine.tygron.com/api/session/items/scenarios/?f=ZIPSMILE&token=API_TOKEN

Api Model Scenario

API Model description of Scenario

Name Type Description
attributes Map<String,double[]>
description String
events CodedEvent[]
id int
limitNeighborhoodIDs int[] Neighborhood ID
limitType LimitType
maquetteOverride Map<String,double[]>
name String
restartTestrun boolean
version int