Api session items scenarios

From Tygron Support wiki
Revision as of 08:50, 24 April 2026 by Frank@tygron.nl (talk | contribs)
Jump to navigation Jump to search

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 CodedEvent

API Model description of CodedEvent

Name Type Description
id int
parameters Object[]

Api Model LimitType

API Enumeration description of LimitType

Name Description
DEFAULT
NEIGHBORHOODS
MEASURE_NEIGHBORHOODS

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