Api session items scenarios: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
37,736 edits
Created page with "api session items Scenario Endpoints. Manipulate items with event: editorscenario. ==Limit Queries==version=100: <pre>https://engine.tygron.com/api/session/items/scenarios/?version=100&token=API_TOKEN</pre> ==Limit Queries==max version: <pre>https://engine.tygron.com/api/session/items/scenarios/version/?token=API_TOKEN</pre> size: <pre>https://engine.tygron.com/api/session/items/scenarios/size/?token=API_TOKEN</pre> Scenarios (GeoJSON): <pre>https://engine.ty..."
 
No edit summary
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
api session items [[Scenario]] Endpoints.
Api session items [[Scenario]] Endpoint: /api/session/items/scenarios/
Manipulate items with event: [[editorscenario]].
 
==Limit Queries==version=100:  
Edit items with events described at [[Api session event editor scenario]].
<pre>https://engine.tygron.com/api/session/items/scenarios/?version=100&token=API_TOKEN</pre>
 
==Limit Queries==max version:  
Default Query:
<pre>https://engine.tygron.com/api/session/items/scenarios/version/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/?f=JSON&token=API_TOKEN</syntaxhighlight>
Example Response:
<syntaxhighlight lang="text" copy>[ {
  "attributes" : null,
  "description" : "",
  "events" : [ ],
  "id" : 0,
  "limitNeighborhoodIDs" : [ ],
  "limitType" : "DEFAULT",
  "maquetteOverride" : null,
  "name" : "Scenario",
  "restartTestrun" : true,
  "version" : 2
} ]</syntaxhighlight>
==Limit Queries==
version=100:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/?version=100&token=API_TOKEN</syntaxhighlight>
==Show Queries==
max version:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/version/?token=API_TOKEN</syntaxhighlight>
size:  
size:  
<pre>https://engine.tygron.com/api/session/items/scenarios/size/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/size/?token=API_TOKEN</syntaxhighlight>
Scenarios (GeoJSON):  
Scenarios (GeoJSON):  
<pre>https://engine.tygron.com/web/scenarios.geojson?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/scenarios.geojson?token=API_TOKEN</syntaxhighlight>
==Limit Queries==HTML:  
==Formats==
<pre>https://engine.tygron.com/api/session/items/scenarios/?f=HTML&token=API_TOKEN</pre>
HTML:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/?f=HTML&token=API_TOKEN</syntaxhighlight>
JSON:  
JSON:  
<pre>https://engine.tygron.com/api/session/items/scenarios/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/?f=JSON&token=API_TOKEN</syntaxhighlight>
CSV:  
CSV:  
<pre>https://engine.tygron.com/api/session/items/scenarios/?f=CSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/?f=CSV&token=API_TOKEN</syntaxhighlight>
SSV:  
SSV:  
<pre>https://engine.tygron.com/api/session/items/scenarios/?f=SSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/?f=SSV&token=API_TOKEN</syntaxhighlight>
SMILE:  
SMILE:  
<pre>https://engine.tygron.com/api/session/items/scenarios/?f=SMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/?f=SMILE&token=API_TOKEN</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<pre>https://engine.tygron.com/api/session/items/scenarios/?f=ZIPJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<pre>https://engine.tygron.com/api/session/items/scenarios/?f=ZIPSMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
{{article end|seealso=*[[Api Content Items]]}}
==Api Model CodedEvent==
API Model description of CodedEvent
 
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|parameters
|Object<nowiki>[]</nowiki>
|
|}
 
==Api Model LimitType==
API Enumeration description of LimitType
 
{|class=wikitable
!Name
!Description
|-
|DEFAULT
|
|-
|NEIGHBORHOODS
|
|-
|MEASURE_NEIGHBORHOODS
|
|}
 
==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]]
*[[Api session event editor scenario]]
}}


[[Category:API]]
[[Category:API]]
[[Category:Items]]

Latest revision as of 12:14, 29 May 2026

Api session items Scenario Endpoint: /api/session/items/scenarios/

Edit items with events described at Api session event editor scenario.

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

See also

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