Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Service Interface for Real Time Information - Situation Exchange

Info
titleVersion

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

...

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.

...

SituationExchangeDelivery < ServiceDelivery

NameTypeCardinalityDescription
attribute

version

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

Timestamp for when the dataset was created/published.

elementSituations6373706061: *Data object for a Public Transport Situation Exchange.

...

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

elementSource6373706061: 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.

elementVersionedAtTimexsd:dateTime0: 1

Timestamp when the situation element was updated.

elementValidityPeriod6373706061: *

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.

elementInfoLinks6373706060: 1

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

elementAffects6373706061: 1

A description of what the situation affects.

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

...

AffectedNetwork

NameTypeCardinalityDescription
element

AffectedOperator

6373706060: 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) elementAffectedLine6373706061: *

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

...

AffectedLineStructure

NameTypeCardinalityDescription
elementLineRefxsd:NMTOKEN1: 1

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

elementRoutes6373706060: *

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: *

...

AffectedRouteStructure

NameTypeCardinalityDescription
elementAffectedRoute6373706061: 1

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

AffectedRouteStructure

Info

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)StopPoints6373706060: *

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

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

...

AffectedSection

NameTypeCardinalityDescription
elementAffectedSection6373706061: *

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

AffectedSectionStructure

Info

Information about an affected Section

...

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

NameTypeCardinalityDescription
elementAccessibilityAssessment6373706060: 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).

elementAffectedComponents6373706060: *

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

...

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

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

elementOperator6373706060: 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.

elementRoute6373706061: *

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.

...