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 (SX) real-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
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 | SIRI-SX#PtSituationElement | 1: * | Data object for a Public Transport Situation Exchange. |
PtSituationElement
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: |
element | Source | SIRI-SX#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:
Please note that when Progress is set to 'closed' the message is considered expired and should not be presented to the public. |
element | ValidityPeriod | SIRI-SX#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:
|
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" 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:
|
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 | SIRI-SX#InfoLinks | 0: 1 | Link to a website which has further information on the situation. |
element | Affects | SIRI-SX#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:
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 | SIRI-SX#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 | ||||
---|---|---|---|---|
Name | Type | Cardinality | Description | |
(choice) element | Networks | SIRI-SX#AffectedNetwork | 1: * (Can be 0 when Progress = "closed") | Network with operators and lines affected by the situation. |
StopPlaces | SIRI-SX#AffectedStopPlace | Stops affected by the situation. | ||
StopPoints | SIRI-SX#AffectedStopPoint | Stops affected by the situation, with the possibility of specifying criteria of situation relevance. | ||
VehicleJourneys | SIRI-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 | ||||
---|---|---|---|---|
Name | Type | Cardinality | Description | |
element | AffectedOperator | SIRI-SX#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:
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 | Possible values:
|
BusSubmode | BusSubmodesOfTransportEnumeration | Possible values:
| ||
Coach | CoachSubmodesOfTransportEnumeration | Possible values:
| ||
MetroSubmode | MetroSubmodesOfTransportEnumeration | Possible values:
| ||
RailSubmode | RailSubmodesOfTransportEnumeration | Possible values:
| ||
TramSubmode | TramSubmodesOfTransportEnumeration | Possible values:
| ||
WaterSubmode | WaterSubmodesOfTransportEnumeration | Possible values:
| ||
(choice) element | AffectedLine | SIRI-SX#AffectedLineStructure | 1: * | Reference(s) to affected line(s). Must be stated explicitly AffectedLine or AllLines due to technical demands on the element in the SIRI standard. |
AllLines | xsd:string (empty) | 1: 1 |
AffectedOperatorStructure
Reference to an affected Operator.
AffectedOperatorStructure | ||||
---|---|---|---|---|
Name | Type | Cardinality | Description | |
element | OperatorRef | xsd:NMTOKEN | 1: 1 | Reference to an affected operator. |
AffectedLineStructure
Information about an affected Line.
AffectedLineStructure | ||||
---|---|---|---|---|
Name | Type | Cardinality | Description | |
element | LineRef | xsd:NMTOKEN | 1: 1 | Reference to Line in question (ID to the corresponding object in the timetable data). |
element | Routes | SIRI-SX#AffectedRoute | 0: * | 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. |
element | Sections | SIRI-SX#AffectedSection | 0: * |
AffectedRoute
Wrapper object to describe information about a Route affected by the situation.
AffectedRouteStructure | ||||
---|---|---|---|---|
Name | Type | Cardinality | Description | |
element | AffectedRoute | SIRI-SX#AffectedRouteStructure | 1: 1 | Reference to Route in question (ID to the corresponding object in the timetable data). |
AffectedRouteStructure
Information about an affected Route
AffectedRouteStructure | ||||
---|---|---|---|---|
Name | Type | Cardinality | Description | |
element | RouteRef | xsd:NMTOKEN | 0: 1 | Reference to Route in question (ID to the corresponding object in the timetable data). |
choice (element) | StopPoints | SIRI-SX#AffectedStopPoint | 0: * | Reference to affected stop(s) in the affected Line. |
Sections | SIRI-SX#AffectedSection | 0: * | Reference to affected section(s) in the affected Line/Journey. |
AffectedSection
Wrapper object to describe information about a Section affected by the situation.
AffectedSection | ||||
---|---|---|---|---|
Name | Type | Cardinality | Description | |
element | AffectedSection | SIRI-SX#AffectedSectionStructure | 1: * | Reference to Route in question (ID to the corresponding object in the timetable data). |
AffectedSectionStructure
Information about an affected Section
AffectedSectionStructure | ||||
---|---|---|---|---|
Name | Type | Cardinality | Description | |
element | IndirectSectionRef | SIRI-SX#IndirectSectionRef | 0: * | Reference to a section of a Line that is affected. |
IndirectSectionRef
Information about an affected Section
IndirectSectionRef | ||||
---|---|---|---|---|
Name | Type | Cardinality | Description | |
element | FirstQuayRef | xsd:NMTOKEN | 1: 1 | Reference to first stop in the affected Section. |
element | LastQuayRef | xsd:NMTOKEN | 1: 1 | Reference to Last stop in the affected Section. |
AffectedStopPoint
Reference(s) to affected stop(s).
AffectedStopPoint | ||||
---|---|---|---|---|
Name | Type | Cardinality | Description | |
element | StopPointRef | xsd:NMTOKEN | 1: 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. |
element | StopPointName | NaturalLanguageStringStructure | 0: 1 | Name of StopPlace (Not used, but may be set to increase human readability.) |
element | StopCondition | RoutePointTypeEnumeration | 0: * | Specifies which passengers the message applies to, for example, people who are disembarking at an affected stop. Possible values:
If this field is left blank or omitted the message will be interpreted as affecting boarding and alighting. |
AffectedStopPlace
References to affected stops.
AffectedStopPlace | ||||
---|---|---|---|---|
Name | Type | Cardinality | Description | |
element | AccessibilityAssessment | SIRI-SX#AccessibilityAssessment | 0: 1 | Specifies whether the object is still available for users with special needs. |
element | StopPlaceRef | xsd:NMTOKEN | 1: 1 | Reference to StopPlace or specific Quay (ID corresponding to objects in the national stop place registry). |
element | PlaceName | NaturalLanguageStringStructure | 0: 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). |
element | AffectedComponents | SIRI-SX#AffectedComponent | 0: * | 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 | ||||
---|---|---|---|---|
Name | Type | Cardinality | Description | |
element | acsb:MobilityImpairedAccess | xsd:boolean | 1: 1 | Specifies whether the object is still available for users with special needs. |
element | acsb:Limitations | acsb:AccessibilityLimitation | 1: 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 | ||||
---|---|---|---|---|
Name | Type | Cardinality | Description | |
element | WheelchairAccess | AccessibilityEnumeration | 1: 1 | Possible values:
|
element | StepFreeAccess | AccessibilityEnumeration | 1: 1 | Possible values:
|
element | EscalatorFreeAccess | AccessibilityEnumeration | 1: 1 | Possible values:
|
element | LiftFreeAccess | AccessibilityEnumeration | 1: 1 | Possible values:
|
AffectedComponent
Complementary information regarding parts of a stop being affected by the situation (for example which quay).
AffectedComponent | ||||
---|---|---|---|---|
Name | Type | Cardinality | Description | |
element | ComponentRef | xsd:NMTOKEN | 0: 1 | Reference to the Quay in question (ID corresponding to objects in the national stop place registry). Used if ComponentType is "quay" |
element | ComponentType | ifopt:StopPlaceComponentTypeEnumeration | 1: 1 | Possible values:
|
element | AccessFeatureType | ifopt:AccessibilityFeatureEnumeration | 0: 1 | Possible values:
Used when it necessary to specify limitations for users with special mobility needs. |
AffectedVehicleJourney
Reference(s) to affected VehicleJourney(s) with Route.
AffectedVehicleJourney | ||||
---|---|---|---|---|
Name | Type | Cardinality | Description | |
(choice) element | VehicleJourneyRef | xsd:NMTOKEN | 1: 1 | Reference to affected VehicleJourney (ID to the corresponding object in the timetable data). |
DatedVehicleJourneyRef | xsd:NMTOKEN | Reference to affected DatedVehicleJourney (ID to the corresponding object in the timetable data). | ||
FramedVehicleJourneyRef | FramedVehicleJourneyRefStructure | Reference with date to affected VehicleJourney (ID to the corresponding object in the timetable data). | ||
element | Operator | SIRI-SX#AffectedOperatorStructure | 0: 1 | Reference to affected Operator (ID to the corresponding object in the timetable data). Not used, but may be set to increase human readability. |
element | LineRef | xsd:NMTOKEN | 0: 1 | Reference to affected Line (ID to the corresponding object in the timetable data). Not used, but may be set to increase human readability. |
element | Route | SIRI-SX#AffectedRouteStructure | 1: * | 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. |
element | OriginAimedDepartureTime | xsd:dateTime | 0: 1 | Originally planned departure time (per time table) from the first stop of the departure. |