This API returns a list hosting all scenarios.
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).
Response
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
Result of the processed request. |
|
500 Internal server error |
The endpoint instance is not found. |
Response content-type
application/xml
Response output
An XML message that contains all scenarios according with orca2.xsd.
Tip: Further information may be added to the previous response, in association with possible errors.
Response example: single scenario
Request
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex-interface/scenario
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
Result of the processed request. In this example, one scenario with idno=1. |
Response output
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Orca2Model xmlns="http://sistemaits.com/orca2/1" xmlns:ns2="http://datex2.eu/schema/2/2_0" xmlns:ns3="http://datex2.eu/schema/2/2_0/com/sistemaits/ext">
<exchange>
<provider>PTV-OPTIMA</provider>
</exchange>
<payloadPublication xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ScenarioManagement" publicationTime="2016-03-18T12:20:32.934">
<MetaInfo>
<timezone>Europe/Rome</timezone>
</MetaInfo>
<scenario idno="1" description="A road closed" active="0"/>
....
</payloadPublication>
</Orca2Model>
Request
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex-interface/scenario
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
Result of the processed request. In this example, three scenarios with idno = 1, 27 and 28. The scenario idno = 28 is associated to two distinct KPIs. |
Response output
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Orca2Model xmlns="http://sistemaits.com/orca2/1" xmlns:ns2="http://datex2.eu/schema/2/2_0">
<exchange>
<provider>PTV-OPTIMA</provider>
</exchange>
<payloadPublication xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ScenarioManagement" publicationTime="2019-01-11T16:30:55.85">
<MetaInfo>
<timezone>Europe/Rome</timezone>
</MetaInfo>
<scenario idno="1" description="A scenario with a Datex2 event" active="0"/>
<kpiIDs/>
</scenario>
<scenario idno="27" description="A scenario with a Datex2 event by alecs" active="0">
<kpiIDs>
<kpiId>1</kpiId>
<kpiId>2</kpiId>
</kpiIDs>
</scenario>
<scenario idno="28" description="A scenario with a Datex2 event by alecs" active="0">
<kpiIDs/>
</scenario>
</payloadPublication>
</Orca2Model>