SIRI-SX

The Service Interface for Real Time Information - Situation Exchange

Version

Current version for SIRI-SX is:   v1.1  (last changed  )

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 SIRI-SX#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

NameTypeCardinalityDescription
attribute

version

xsd:NMTOKEN1: 1Version ID for SitutaionExhangeDelivery
elementResponseTimestampxsd:dateTime1: 1

Timestamp for when the dataset was created/published.

elementSituationsSIRI-SX#PtSituationElement1: *Data object for a Public Transport Situation Exchange.

PtSituationElement

A container element for situation data.

PtSituationElement

NameTypeCardinalityDescription
element

CreationTime

xsd:dateTime1: 1Timestamp for when the situation was created.
elementParticipantRefParticipantCode1: 1Codespace of the data source (see codespace).
elementSituationNumberxsd:anyURI1: 1

Unique situation-ID for PtSituationElement.

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

elementSourceSIRI-SX#SituationSource1: 1

Information on the source of the message.

elementVersionedAtTimexsd:dateTime0: 1Timestamp when the situation element was updated.
elementProgressWorkflowStatusEnumeration

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.

elementValidityPeriodSIRI-SX#HalfOpenTimestampRangeStructure1: *

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.

elementUndefinedReasonReason1: 1

Reason should always be <UndefinedReason/>.

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

elementSeveritySeverityEnumeration0: 1

How severely the situation affects public transport services.

Possible values:

  • noImpact
  • verySlight
  • slight
  • normal (default)
  • severe
  • verySevere
elementPriorityxsd:nonNegativeInteger0: 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".

elementReportTypeReportTypeEnumeration1: 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") 

elementPlannedxsd:boolean0: 1

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

elementSummaryNaturalLanguageStringStructure

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).

elementDescriptionNaturalLanguageStringStructure0: *

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.

elementAdviceNaturalLanguageStringStructure0: *

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

elementInfoLinksSIRI-SX#InfoLinks0: 1

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

elementAffectsSIRI-SX#Affects1: 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

NameTypeCardinalityDescription
element

SourceType

SourceType1: 1

Information type

Possible values:

  • directReport

Required by the format spesification, but not used.

HalfOpenTimestampRangeStructure

Period can be open- or closed-ended.

HalfOpenTimestampRangeStructure

NameTypeCardinalityDescription
element

StartTime

xsd:dateTime1: 1

Start time for the period.

elementEndTimexsd:dateTime0: 1End time for the period.

Collection of information links

InfoLinks

NameTypeCardinalityDescription
element

InfoLink

SIRI-SX#InfoLink1: 1

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

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

InfoLink

NameTypeCardinalityDescription
element

Uri

xsd:anyUri1: 1Link to a website which has further information on the situation.
elementLabelNaturalLanguageStringStructure0: 1Label for the link.

Affects

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

Affects

NameTypeCardinalityDescription

(choice) element




NetworksSIRI-SX#AffectedNetwork

1: *

(Can be 0 when Progress = "closed") 

Network with operators and lines affected by the situation.

StopPlacesSIRI-SX#AffectedStopPlace

Stops affected by the situation.

StopPointsSIRI-SX#AffectedStopPoint

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

VehicleJourneysSIRI-SX#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

NameTypeCardinalityDescription
element

AffectedOperator

SIRI-SX#AffectedOperatorStructure0: 1

Reference to the affected operator.

elementNetworkRefxsd:NMTOKEN1: 1Reference to affected Network.
elementVehicleModeVehicleModesOfTransportEnumeration0: 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





AirSubmodeAirSubmodesOfTransportEnumeration0: 1





Possible values:

  • domesticFlight
  • helicopterService
  • internationalFlight
BusSubmodeBusSubmodesOfTransportEnumeration

Possible values:

  • airportLinkBus
  • expressBus
  • localBusService (mapped to localBus)
  • nightBus
  • railReplacementBus
  • regionalBus
  • schoolBus
  • shuttleBus
  • sightseeingBus
CoachCoachSubmodesOfTransportEnumeration

Possible values:

  • internationalCoachService (mapped to internationalCoach)
  • nationalCoachService (mapped to nationalCoach)
  • touristCoachService (mapped to touristCoach)
MetroSubmodeMetroSubmodesOfTransportEnumeration

Possible values:

  • metro
  • urbanRailway
RailSubmodeRailSubmodesOfTransportEnumeration

Possible values:

  • interbational [sic]. Please note, the typo is incorrectly implemented in the official standard. Mapped to 'international'.
  • interRegionalRailService (mapped to interregionalRail)
  • local
  • longDistanceTrain (mapped to longDistance)
  • sleeperRailService (mapped to nightRail)
  • regionalRail
  • specialTrainService (mapped to airportLinkRail)
  • touristRailway
TramSubmodeTramSubmodesOfTransportEnumeration

Possible values:

  • localTramService (mapped to localTram)
WaterSubmodeWaterSubmodesOfTransportEnumeration

Possible values:

  • highSpeedPassengerService
  • highSpeedVehicleService
  • internationalCarFerryService (mapped to internationalCarFerry)
  • internationalPassengerFerry
  • localCarFerryService (mapped to localCarFerry)
  • localPassengerFerry
  • nationalCarFerryService (mapped to nationalCarFerry)
  • sightseeingService
(choice) elementAffectedLineSIRI-SX#AffectedLineStructure1: *

Reference(s) to affected line(s).

Must be stated explicitly AffectedLine or AllLines due to technical demands on the element in the SIRI standard.

AllLinesxsd:string (empty)1: 1

AffectedOperatorStructure

Reference to an affected Operator.

AffectedOperatorStructure

NameTypeCardinalityDescription
element

OperatorRef

xsd:NMTOKEN1: 1Reference to an affected operator.

AffectedLineStructure

Information about an affected Line.

AffectedLineStructure

NameTypeCardinalityDescription
elementLineRefxsd:NMTOKEN1: 1

Reference to Line in question (ID to the corresponding object in the timetable data).

elementRoutesSIRI-SX#AffectedRoute0: *

Reference to Route(s) in question (ID to the corresponding object in the timetable data), when the situation does not apply to the entire Line.

elementSectionsSIRI-SX#AffectedSection0: *

AffectedRoute

Wrapper object to describe information about a Route affected by the situation.

AffectedRouteStructure

NameTypeCardinalityDescription
elementAffectedRouteSIRI-SX#AffectedRouteStructure1: 1

Reference to Route in question (ID to the corresponding object in the timetable data).

AffectedRouteStructure

Information about an affected Route

AffectedRouteStructure

NameTypeCardinalityDescription
elementRouteRefxsd:NMTOKEN0: 1Reference to Route in question (ID to the corresponding object in the timetable data).
choice (element)StopPointsSIRI-SX#AffectedStopPoint0: *

Reference to affected stop(s) in the affected Line.

SectionsSIRI-SX#AffectedSection0: *Reference to affected section(s) in the affected Line/Journey.

AffectedSection

Wrapper object to describe information about a Section affected by the situation.

AffectedSection

NameTypeCardinalityDescription
elementAffectedSectionSIRI-SX#AffectedSectionStructure1: *

Reference to Route in question (ID to the corresponding object in the timetable data).

AffectedSectionStructure

Information about an affected Section

AffectedSectionStructure

NameTypeCardinalityDescription
element

IndirectSectionRef

SIRI-SX#IndirectSectionRef0: *

Reference to a section of a Line that is affected.

IndirectSectionRef

Information about an affected Section

IndirectSectionRef

NameTypeCardinalityDescription
element

FirstQuayRef

xsd:NMTOKEN1: 1

Reference to first stop in the affected Section.

elementLastQuayRefxsd:NMTOKEN1: 1Reference to Last stop in the affected Section.

AffectedStopPoint

Reference(s) to affected stop(s).

AffectedStopPoint

NameTypeCardinalityDescription
elementStopPointRefxsd:NMTOKEN1: 1

Reference to the Quay in question (ID corresponding to objects in the national stop place registry).

If the quay is currently unknown, or the message applies to all quays, a reference to StopPlace may be used instead.

elementStopPointNameNaturalLanguageStringStructure0: 1Name of StopPlace (Not used, but may be set to increase human readability.)
elementStopConditionRoutePointTypeEnumeration0: *

Specifies which passengers the message applies to, for example, people who are disembarking at an affected stop.

Possible values:

  • exceptionalStop (for passengers expecting an interchange)
  • destination (for passengers expecting to disembark, of at the last stop)
  • notStopping (when passing a stop)
  • requestStop (when a passenger must request the serving of a stop)
  • startPoint (at departure or when passengers expect to board)
  • stop (default - affects all interactions with the stop (boarding, alighting, arrival, departure, interchanges)

If this field is left blank or omitted the message will be interpreted as affecting boarding and alighting.

AffectedStopPlace

References to affected stops.

AffectedStopPlace

NameTypeCardinalityDescription
elementAccessibilityAssessmentSIRI-SX#AccessibilityAssessment0: 1

Specifies whether the object is still available for users with special needs.

elementStopPlaceRefxsd:NMTOKEN1: 1

Reference to StopPlace or specific Quay (ID corresponding to objects in the national stop place registry).

elementPlaceNameNaturalLanguageStringStructure0: 1

Name of the stop (not used due to the reference to the national stop place registry, but can be included to make the XML easier to read).

elementAffectedComponentsSIRI-SX#AffectedComponent0: *

Reference(s) to which part(s) of the stop(s) are being affected.

AccessibilityAssessment

Description of (changed) availability as a result of the situation.

AccessibilityAssessment

NameTypeCardinalityDescription
elementacsb:MobilityImpairedAccessxsd:boolean1: 1

Specifies whether the object is still available for users with special needs.

elementacsb:Limitationsacsb:AccessibilityLimitation1: 1

Specifies limitations for users with special needs.

AccessibilityLimitation

Descriptions of limitations for users with special needs.

Must be in accordance with AccessibilityLimitation for the stop, defined in accordance with the Norwegian NeTEx profile for stops.

AccessibilityLimitation

NameTypeCardinalityDescription
elementWheelchairAccessAccessibilityEnumeration1: 1

Possible values:

  • true
  • false
  • unknown
elementStepFreeAccessAccessibilityEnumeration1: 1

Possible values:

  • true
  • false
  • unknown
elementEscalatorFreeAccessAccessibilityEnumeration1: 1

Possible values:

  • true
  • false
  • unknown
elementLiftFreeAccessAccessibilityEnumeration1: 1

Possible values:

  • true
  • false
  • unknown

AffectedComponent

Complementary information regarding parts of a stop being affected by the situation (for example which quay).

AffectedComponent

NameTypeCardinalityDescription
elementComponentRefxsd:NMTOKEN0: 1

Reference to the Quay in question (ID corresponding to objects in the national stop place registry).

Used if ComponentType is "quay"

elementComponentTypeifopt:StopPlaceComponentTypeEnumeration1: 1

Possible values:

  • accessSpace
  • boardingPosition (only for trains)
  • entrance
  • quay
elementAccessFeatureTypeifopt:AccessibilityFeatureEnumeration0: 1

Possible values:

  • escalator
  • lift
  • narrowEntrance
  • ramp
  • stairs

Used when it necessary to specify limitations for users with special mobility needs.

AffectedVehicleJourney

Reference(s) to affected VehicleJourney(s) with Route.

AffectedVehicleJourney

NameTypeCardinalityDescription
(choice) elementVehicleJourneyRefxsd:NMTOKEN1: 1

Reference to affected VehicleJourney (ID to the corresponding object in the timetable data).

DatedVehicleJourneyRefxsd:NMTOKENReference to affected DatedVehicleJourney (ID to the corresponding object in the timetable data).
FramedVehicleJourneyRefFramedVehicleJourneyRefStructure

Reference with date to affected VehicleJourney (ID to the corresponding object in the timetable data).

elementOperatorSIRI-SX#AffectedOperatorStructure0: 1

Reference to affected Operator (ID to the corresponding object in the timetable data).

Not used, but may be set to increase human readability.

elementLineRefxsd:NMTOKEN0: 1

Reference to affected Line (ID to the corresponding object in the timetable data).

Not used, but may be set to increase human readability.

elementRouteSIRI-SX#AffectedRouteStructure1: *

Reference to affected Route(s) (ID to the corresponding object in the timetable data).

Mandatory field (due to format implementation), but can be blank if the situation affects all stops in AffectedVehicleJourney.

elementOriginAimedDepartureTimexsd:dateTime0: 1

Originally planned departure time (per time table) from the first stop of the departure.