Getting all traffic events

Returns all traffic events that:

If you want to get also inactive events, you have to set to TRUE the parameter <publishInactiveEvents> (please see → Main configuration of the DATEX II Interface).

You can not get:

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:

Request

GET 

https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex2import/optima/situationPublication

Request resource

Not applicable.

Request parameters

Parameter Required Description

type

NO

String parameter to filter the event type.

You can set the filter value to:

  • road: default value (if the type is not specified in the request).
  • signal: to filter only signal control events.
  • all: to get all events.

You can specify several types, connected by logical OR.

Request content-type

application/xml

Request body (payload)

XML message describing a traffic event according to DATEX II format with Optima extensions.

Response status

HTTP status Description

200 OK

Result of the processed request.

400 Bad request

It is not valid one (or more) of the types specified in the query.

Response content-type

application/xml

Response output

XML message describing a traffic event according to DATEX II format with Optima extensions.

Request

https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex2import/optima/situationPublication/?type=road

Response status

200

Response content-type

application/xml

Response output

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<d2LogicalModel xmlns="http://datex2.eu/schema/2/2_0">
    <exchange>
        <supplierIdentification>
            <country>other</country>
            <nationalIdentifier>OPTIMA</nationalIdentifier>
        </supplierIdentification>
    </exchange>
    <payloadPublication xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SituationPublication" lang="other">
        <publicationTime>2019-05-09T17:16:21.342+02:00</publicationTime>
        <publicationCreator>
            <country>other</country>
            <nationalIdentifier>OPTIMA</nationalIdentifier>
        </publicationCreator>
        <situation id="OPTIMA_SITN_1543942625020" version="1">
            <headerInformation>
                <confidentiality>noRestriction</confidentiality>
                <informationStatus>real</informationStatus>
            </headerInformation>
            <situationRecord xsi:type="ReroutingManagement" id="OPTIMA_EVNT_1543942625020" version="1">
                <situationRecordCreationTime>2018-12-04T17:57:05.026+01:00</situationRecordCreationTime>
                <situationRecordVersionTime>2018-12-04T17:57:05.026+01:00</situationRecordVersionTime>
                <severity>low</severity>
                <source>
                    <sourceCountry>other</sourceCountry>
                    <sourceIdentification>OPTIMA</sourceIdentification>
                </source>
                <validity>
                    <validityStatus>definedByValidityTimeSpec</validityStatus>
                    <validityTimeSpecification>
                        <overallStartTime>2018-12-04T17:57:28.000+01:00</overallStartTime>
                    </validityTimeSpecification>
                </validity>
                <impact>
                    <delays>
                        <delayBand>negligible</delayBand>
                        <delayTimeValue>13.577143</delayTimeValue>
                    </delays>
                </impact>
                <generalPublicComment>
                    <comment>
                        <values>
                            <value lang="en">
                            example of rerouting advised with compliance shares for each alternative path
                            </value>
                        </values>
                    </comment>
                </generalPublicComment>
                <nonGeneralPublicComment>
                    <comment>
                        <values>
                            <value lang="en">
                            </value>
                        </values>
                    </comment>
                </nonGeneralPublicComment>
                <groupOfLocations xsi:type="ItineraryByIndexedLocations">
                    <itineraryExtension>
                        <itineraryWithCompliance>
                            <compliance>0.19999998807907104</compliance>
                        </itineraryWithCompliance>
                    </itineraryExtension>
                </groupOfLocations>
                <alternativeRoute xsi:type="ItineraryByIndexedLocations">
                    <itineraryExtension>
                        <itineraryWithCompliance>
                            <compliance>0.6000000238418579</compliance>
                        </itineraryWithCompliance>
                    </itineraryExtension>
                </alternativeRoute>
                <alternativeRoute xsi:type="ItineraryByIndexedLocations">
                    <itineraryExtension>
                        <itineraryWithCompliance>
                            <compliance>0.20000000298023224</compliance>
                        </itineraryWithCompliance>
                    </itineraryExtension>
                </alternativeRoute>
            </situationRecord>
        </situation>
    </payloadPublication>
</d2LogicalModel>

Output description

In the response is present an event of rerouting.