This API returns the details associated to a specific scenario.
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 the details of specific scenario according to orca2.xsd.
Tip: Further information may be added to the previous response, in association with possible errors.
Response example: simple scenario
Request
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex-interface/scenario/1
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
Result of the processed request. In this example, a simple 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:23:27.856">
<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/27
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
Result of the processed request. In this example, a scenario with idno=27, with:
|
Response output
<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-11T15:55:20.434">
<MetaInfo>
<timezone>Europe/Rome</timezone>
</MetaInfo>
<scenario idno="27" description="A scenario with a Datex2 event" active="0">
<d2Envelope>
<ns2:exchange>
<ns2:supplierIdentification>
<ns2:country>other</ns2:country>
<ns2:nationalIdentifier>OPTIMA</ns2:nationalIdentifier>
</ns2:supplierIdentification>
</ns2:exchange>
<ns2:payloadPublication xsi:type="ns2:SituationPublication" lang="other">
<ns2:publicationTime>2019-01-11T15:55:20.417+01:00</ns2:publicationTime>
<ns2:publicationCreator>
<ns2:country>other</ns2:country>
<ns2:nationalIdentifier>OPTIMA</ns2:nationalIdentifier>
</ns2:publicationCreator>
<ns2:situation id="METRO_556_2" version="1">
<ns2:headerInformation>
<ns2:confidentiality>noRestriction</ns2:confidentiality>
<ns2:informationStatus>real</ns2:informationStatus>
</ns2:headerInformation>
<ns2:situationRecord xsi:type="ns2:RoadOrCarriagewayOrLaneManagement" id="METRO_556_2.1" version="1">
<ns2:situationRecordCreationTime>2013-10-23T15:25:07.996+02:00</ns2:situationRecordCreationTime>
<ns2:situationRecordVersionTime>2013-11-01T16:49:00.000+01:00</ns2:situationRecordVersionTime>
<ns2:probabilityOfOccurrence>certain</ns2:probabilityOfOccurrence>
<ns2:source>
<ns2:sourceIdentification>SVRTOC</ns2:sourceIdentification>
</ns2:source>
<ns2:validity>
<ns2:validityStatus>definedByValidityTimeSpec</ns2:validityStatus>
<ns2:validityTimeSpecification>
<ns2:overallStartTime>2012-10-08T08:00:00.000+02:00</ns2:overallStartTime>
</ns2:validityTimeSpecification>
</ns2:validity>
<ns2:impact>
<ns2:trafficConstrictionType>carriagewayBlocked</ns2:trafficConstrictionType>
</ns2:impact>
<ns2:groupOfLocations xsi:type="ns2:NonOrderedLocationGroupByList">
<ns2:locationContainedInGroup xsi:type="ns2:Linear">
<ns2:linearWithinLinearElement>
<ns2:directionRelativeOnLinearSection>aligned</ns2:directionRelativeOnLinearSection>
<ns2:linearElement>
<ns2:roadNumber>59634534</ns2:roadNumber>
</ns2:linearElement>
</ns2:linearWithinLinearElement>
</ns2:locationContainedInGroup>
</ns2:groupOfLocations>
<ns2:roadOrCarriagewayOrLaneManagementType>roadClosed</ns2:roadOrCarriagewayOrLaneManagementType>
</ns2:situationRecord>
</ns2:situation>
<ns2:situationPublicationExtension>
<ns2:signalActionPublication>
<ns2:signalOperatorAction xsi:type="ns2:StreetSignalAction" id="PIPPO_556_2" version="7">
<ns2:situationVersionTime>2018-12-05T00:00:00.000+01:00</ns2:situationVersionTime>
<ns2:validity>
<ns2:validityStatus>definedByValidityTimeSpec</ns2:validityStatus>
<ns2:validityTimeSpecification>
<ns2:overallStartTime>2018-12-08T14:00:00.000+01:00</ns2:overallStartTime>
<ns2:validPeriod>
<ns2:startOfPeriod>2018-12-06T00:00:00.000+01:00</ns2:startOfPeriod>
<ns2:endOfPeriod>2018-12-08T00:00:00.000+01:00</ns2:endOfPeriod>
<ns2:recurringTimePeriodOfDay xsi:type="ns2:TimePeriodByHour">
<ns2:startTimeOfPeriod>03:22:00.000+01:00</ns2:startTimeOfPeriod>
<ns2:endTimeOfPeriod>16:24:00.000+01:00</ns2:endTimeOfPeriod>
</ns2:recurringTimePeriodOfDay>
<ns2:recurringDayWeekMonthPeriod>
<ns2:applicableDay>friday</ns2:applicableDay>
</ns2:recurringDayWeekMonthPeriod>
</ns2:validPeriod>
</ns2:validityTimeSpecification>
</ns2:validity>
<ns2:generalPublicComment>Contains information about the signal parameters that were switched as a result of operator decision. Allow to specify the green share for an existing signal group.</ns2:generalPublicComment>
<ns2:streetLocation>
<ns2:streetID>565533001</ns2:streetID>
<ns2:tailStreetNodeID>633479300</ns2:tailStreetNodeID>
</ns2:streetLocation>
<ns2:greenShare>0.0</ns2:greenShare>
</ns2:signalOperatorAction>
</ns2:signalActionPublication>
</ns2:situationPublicationExtension>
</ns2:payloadPublication>
</d2Envelope>
<kpiIDs>
<kpiId>1</kpiId>
<kpiId>2</kpiId>
</kpiIDs>
</scenario>
</payloadPublication>
</Orca2Model>