SIRI-SX

SIRI-SX

The Service Interface for Real Time Information - Situation Exchange

Version

Current version for SIRI-SX is:   v1.1  (last changed  Jul 28, 2021)

Contents

 

This document is part of the Norwegian SIRI Profile and describes datasets and elements used for exchanging textual traffic situation messages in the SIRI Situation Exchange (SXreal-time format.

SIRI-SX is used to model textual descriptions of disruptions, or deviations from the planned public transport information. The messages can be applied directly to stops, lines, vehicles etc. in the already existing public transport data by the use of ID references.

Data requirements

Sending of a SIRI-SX ServiceDelivery, data must be in accordance with this profile and the entire dataset should be contained within a single XML file.

Note that the profile does not present an exhaustive list of all real-time information technically possible to transfer via SIRI-SX, but it lays the foundation for which demands are placed on the datasets in order to meet the demands set by Håndbok N801.

It is permitted for client systems to send more than one Situations (PtSituationElement) per SituationExchangeDelivery, in order for real-time information to be conflated and be transferred as part of the same ServiceDelivery.

The examples associated with this profile are meant to show practical implementations of specific use cases, and may contain supplementary optonal data fields, or lack mandatory data fields, compared to a full and complete dataset. See Components for closer descriptions of the data types, specifications and requirements on the unique elements of the SIRI SX-data.

Components

SituationExchangeDelivery

SituationExchangeDelivery

A data type for the representation of one or more situations, or updates on previously published situations through Situations (PtSituationElement) per SituationExchangeDelivery with the status and scope of the affected services.

SituationExchangeDelivery < ServiceDelivery

 

Name

Type

Cardinality

Description

attribute

version

xsd:NMTOKEN

1: 1

Version ID for SitutaionExhangeDelivery

element

ResponseTimestamp

xsd:dateTime

1: 1

Timestamp for when the dataset was created/published.

element

Situations

PtSituationElement

1: *

Data object for a Public Transport Situation Exchange.

PtSituationElement

A container element for situation data.

PtSituationElement

 

Name

Type

Cardinality

Description

element

CreationTime

xsd:dateTime

1: 1

Timestamp for when the situation was created.

element

ParticipantRef

ParticipantCode

1: 1

Codespace of the data source (see codespace).

element

SituationNumber

xsd:anyURI

1: 1

Unique situation-ID for PtSituationElement.

Format:
CODESPACE:SituationNumber:ID
e.g.: ABC:SituationNumber:123

element

Version

xsd:integer

0: 1

Version-number for the current message. Could be used together with VersionedAtTime to easier track changes over time.

element

Source

SituationSource

1: 1

Information on the source of the message.

element

VersionedAtTime

xsd:dateTime

0: 1

Timestamp when the situation element was updated.

element

Progress

WorkflowStatusEnumeration

1: 1

Status of a situation message.

Possible values:

  • open

  • closed (the situation is over and traffic has returned to normal)

Please note that when Progress is set to 'closed' the message is considered expired and should not be presented to the public.

element

ValidityPeriod

HalfOpenTimestampRangeStructure

1: *

Validity period(s) set with a start time and optionally with an end time. When the end time of the situation is undefined the expiration of the situation is considered unknown until cancellation status for the situation is sent. If the situation has several periods, all but the last period must have an end date.

Note that for closed (Progress=closed) messages, the ValidityPeriod must have an EndTime with a minimum of five hours into the future to ensure the message is properly delivered and received by all systems.

Once EndTime has expired, the message will no longer be re-distributed in real-time data streams or services.

element

UndefinedReason

Reason

1: 1

Reason should always be <UndefinedReason/>.

The field is mandatory due to format specification, but is not used.

element

Severity

SeverityEnumeration

0: 1

How severely the situation affects public transport services.

Possible values:

  • noImpact

  • verySlight

  • slight

  • normal (default)

  • severe

  • verySevere

element

Priority

xsd:nonNegativeInteger

0: 1

Number value from 1 to 10 indicating the priority (urgency) of the situation message. 

1 - First (i.e. highest) message priority. Equivalent to DATEX2 urgency level "extremelyUrgent"
2 - 10 - Urgent, of various priority. Equivalent to DATEX2 urgency level "urgent" with added priority order.

Left blank (default) is equivalent to DATEX2 urgency level "normal urgency".

element

ReportType

ReportTypeEnumeration

1: 1

Type of situation report. The field is required in order to differentiate general information from incidents.

Possible values:

  • general (used for public information not impacting the actual operation of the PT-service. eg. "No food service on this journey")

  • incident (used for public information impacting the operation of the PT-service. eg. "expect delays due to road construction work") 

element

Planned

xsd:boolean

0: 1

Whether the situation in question is due to planned events, or an unexpected incident.

element

Summary

NaturalLanguageStringStructure

1: *

(Can be 0 when Progress = "closed") 

The textual summary of the situation (which is not already described by structured data). One summary per language (if more than one, the xml:lang attribute must be set).

Maximum 160 characters (to keep the message readable).

element

Description

NaturalLanguageStringStructure

0: *

Expanded textual description (if more than one, the xml:lang attribute must be set) of the situation (do not repeat information from Summary, or structured data).

Please do not add advice on how to avoid the situation, as this should be presented in the Advice field.

element

Advice

NaturalLanguageStringStructure

0: *

Textual advice (if more than one, the xml:lang attribute must be set) on how a passenger should react/respond to the situation.

element

InfoLinks

InfoLinks

0: 1

Link to a website which has further information on the situation.

element

Affects

Affects

1: 1

A description of what the situation affects.

Only allowed to be blank (have no content) when message progress is set to "closed".

SituationSource

Information on the source of the message.

SituationSource

 

Name

Type

Cardinality

Description

element

SourceType

SourceType

1: 1

Information type

Possible values:

  • directReport

Required by the format spesification, but not used.

HalfOpenTimestampRangeStructure

Period can be open- or closed-ended.

HalfOpenTimestampRangeStructure

 

Name

Type

Cardinality

Description

element

StartTime

xsd:dateTime

1: 1

Start time for the period.

element

EndTime

xsd:dateTime

0: 1

End time for the period.

InfoLinks

Collection of information links

InfoLinks

 

Name

Type

Cardinality

Description

element

InfoLink

InfoLink

1: 1

Link to a website which has further information on the situation.

InfoLink

Link to a website which has further information on the situation.

InfoLink

 

Name

Type

Cardinality

Description

element

Uri

xsd:anyUri

1: 1

Link to a website which has further information on the situation.

element

Label

NaturalLanguageStringStructure

0: 1

Label for the link.

Affects

Data objects for a closer description of required element affected by the situation.

Affects

Affects

 

Name

Type

Cardinality

Description

(choice) element




Networks

AffectedNetwork

1: *

(Can be 0 when Progress = "closed") 

Network with operators and lines affected by the situation.

StopPlaces

AffectedStopPlace

Stops affected by the situation.

StopPoints

AffectedStopPoint

Stops affected by the situation, with the possibility of specifying criteria of situation relevance.

VehicleJourneys

AffectedVehicleJourney

Trips affected by the situation.

AffectedNetwork

References to an affected Network element(s).

Please note that VehicleMode and Submode are the same as in Norwegian NeTEx profile, TransportModes

AffectedNetwork

 

Name

Type

Cardinality

Description

element

AffectedOperator

AffectedOperatorStructure

0: 1

Reference to the affected operator.

element

NetworkRef

xsd:NMTOKEN

1: 1

Reference to affected Network.

element

VehicleMode

VehicleModesOfTransportEnumeration

0: 1

Affected modality.

Possible values:

  • all

  • air

  • bus

  • coach

  • funicular (please note: does not have a corresponding submode)

  • metro

  • rail

  • taxi (please note: does not have a corresponding submode)

  • telecabin (mapped to til cableway) (please note: does not have a corresponding submode)

  • tram

  • water

  • selfDrive

Modes must be specified together with corresponding submode (when applicable), whenever the situation does not affect all modalities in the affected planned data.

(choice) element





AirSubmode

AirSubmodesOfTransportEnumeration

0: 1