Returns all results related to traffic forecasts calculated through the parallel simulations.
The response provides a zipped CSV file that contains a set of data related to the request.
Authentication phase
Before using the endpoint, you must run the authentication phase (→ Login).
After the authentication, a session opens and a valid session token persists until:
- The end of the session time-out, that is set through the parameter sessionTimeout (→ OptimaWSI configuration > OptimaAuth section).
- An explicit Logout call (→ Logout).
Request
Request
GET
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-planning/results/strt
Request parameters
| Parameter | Required | Description |
|---|---|---|
|
simulation |
YES |
Identifier of the simulation.
|
|
startTime |
NO |
Start of the time interval used to compute the forecast results. You must either specify both startTime and endTime, or neither. If startTime=endTime=null, both are set to the values of the last simulation. The format is ISO 8601 with or without timezone. |
|
endTime |
NO |
End of the time interval used to compute the forecast results. You must either specify both startTime and endTime, or neither. If startTime=endTime=null, both are set to the values of the last simulation. The format is ISO 8601 with or without timezone. Tip: The dimension of the time interval can have a meaningful impact on the performance of the simulations. Greater is the interval (endTime-startTime), slower could be the calculation of the results. |
|
boundingBox |
NO |
Identifier of the bounding box, as comma-separated values format: xmin,ymin,xmax,ymax. The area of the rectangle must not be empty and must intersect with the overall network area. Tip: xmin<xmax. |
|
street |
NO |
Identifier of the street. |
|
fromNode |
NO |
Identifier of the starting node. |
Request content-type
Not applicable.
Request body (payload)
Not applicable.
Response
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
Result of the processed request. |
|
400 Bad request |
Several conditions can be classified under this code. Generally, when an IllegalArgumentException occurs. For example, if in the request is present an invalid boundingBox. |
|
404 Not found |
It is not present any street in the request. |
|
500 Internal server error |
Several possible exception server side. |
Response content-type
TXT
Response output
A zipped CSV file.
Example
Request
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-planning/results/strt?startTime=2019-03-07T22:00:00&endTime=2019-03-07T23:55:00&simulation=107&boundingBox=151.114562,-33.872652,151.228622,-33.807733
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
Result of the processed request. |
Response output
The response is a CSV file, usually based on a big number of rows.
Here only a short fragment of a common response structure:
| simu | strt | fsnd | tsys | time | iflw | oflw | ouca | nveh | stor | queu | quel | quen | ista |
| 107 | 1.32E+08 | 498160 | 6.48 | 0 | 0 | 3000 | 0 | 50.4 | 0 | 0 | 0 | 0 | |
| 107 | 1.32E+08 | 498160 | 6.48 | 45.53883 | 44.93116 | 3000 | 0.081388 | 50.214 | 0 | 0 | 0 | 0 | |
| 107 | 1.32E+08 | 498160 | 6.48 | 92.90111 | 92.82738 | 3000 | 0.167151 | 50.011 | 0 | 0 | 0 | 0 | |
| 107 | 1.32E+08 | 498160 | 6.481 | 83.07809 | 83.22769 | 3000 | 0.149684 | 50.05 | 0 | 0 | 0 | 0 | |
| 107 | 1.32E+08 | 498160 | 6.48 | 74.55443 | 74.55224 | 3000 | 0.134196 | 50.087 | 0 | 0 | 0 | 0 | |
| 107 | 1.32E+08 | 498160 | 6.48 | 67.94128 | 68.02552 | 3000 | 0.122375 | 50.114 | 0 | 0 | 0 | 0 | |
| 107 | 1.32E+08 | 498160 | 6.48 | 56.61867 | 56.66497 | 3000 | 0.101958 | 50.162 | 0 | 0 | 0 | 0 | |
| 107 | 1.32E+08 | 498160 | 6.48 | 51.31142 | 51.36332 | 3000 | 0.09241 | 50.184 | 0 | 0 | 0 | 0 | |
| 107 | 1.32E+08 | 498160 | 6.48 | 48.30254 | 48.30494 | 3000 | 0.086947 | 50.197 | 0 | 0 | 0 | 0 |