Versions Compared

Old Version 5

changes.mady.by.user Bert

Saved on

compared with

New Version Current

changes.mady.by.user Sofie Holden

Saved on

Key

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

...

The tables below list which fields are supported by Samtrafiken. Any fields or attributes which are not on the list listed are ignored.

Element

Required

Notes

Situations

Required

Contains one or more PtSituationElement, see below

...

Element

Required

Notes

SituationNumber

Required

An internal identifier for a situation. May contain characters, but the number obtained by removing the characters should be unique for the situation

SummariesSummary

Required

Short summary text

PtSituationElement items without any summaries summary are ignored.

Only In case multiple elements are present, only the first summary is read

DescriptionsDescription

Optional

Complete text note for the message

Only In case multiple elements are present, only the first description is read

CreationTime

Required

The time when this situation was created

Source.SourceType

Required

Required by the format specification, but not used by Samtrafiken

Source.ExternalCode

Optional

Code for this deviation in external systems

Source.Other

Optional

External system id

Source.Name

Optional

The name of the source. Currently never exported by Samtrafiken

Progress

Required

OPEN or CLOSED. Only Open messages are read by Samtrafiken.

ValidityPeriod

Required

Only the first
Info

When set to CLOSED, only SituationNumber is required, as Samtrafiken will just close the message without reading any other fields for possible updates.

ValidityPeriod

Required

Only the first validity period is read

ValidityPeriod.StartTime

Required

From which time the message applies

ValidityPeriod.EndTime

Optional

At which time the message no longer applies

UndefinedReason

Required

Reason should always be <UndefinedReason/>.

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

Affects > StopPlaces > AffectedStopPlace

Optional

https://samtrafiken.atlassian.net/wiki/spaces/SamtrafikenOpenData/pages/4400152638/SIRI-SX+2.0#AffectedStopPlace

Currently unsupported

If affected stop places are set, no other type of affects should be set

Affects > StopPoints > AffectedStopPoints

Optional

https://samtrafiken.atlassian.net/wiki/spaces/SamtrafikenOpenData/pages/4400152638/SIRI-SX+2.0#AffectedStopPoint

If affected stop places are set, no other type of affects should be set

Affects > Networks > AffectedNetwork

Optional

https://samtrafiken.atlassian.net/wiki/spaces/SamtrafikenOpenData/pages/4400152638/SIRI-SX+2.0#AffectedNetwork

If affected networks are set, no other type of affects should be set

Affects > VehicleJourneys > AffectedVehicleJourney

Optional

If affected vehicle journeys are set, no other type of affects should be set

...

Element

Required

Notes

FramedVehicleJourneyRef > DatedVehicleJourneyRef

Required

One or more.

Should match the static data.Reference to ServiceJourney in the static data, for example SE:022:ServiceJourney:1234567-12345

FramedVehicleJourneyRef > DataFrameRef

Required

Trip start date in YYYY-MM-DD format. Used to match with static data

VehicleJourneyRefs

Forbidden

Not supported. Messages containing one or more references will be rejected to prevent incorrect output.

DatedVehicleJourneyRefs

Forbidden

Not supported. Messages containing one or more references will be rejected to prevent incorrect output.

Route

Optional

Ignored by Samtrafiken - AffectedVehicleJourneys are applied to the entire vehicle journey

...

Element

Required

Notes

RouteRef

Forbidden

RouteRef is not implemented by Samtrafiken. Messages containing it will be rejected to prevent incorrect output.

StopPoints

Optional

The stop points where traffic for the AffectedLine will be affected.

If not set, the affectedRoute element won’t have any effect.

StopPoints > StopPointRef

Should reference a StopPlace or Quay in the static data. Reference to a StopPlace if all quays are affected.

Examples

Stop no longer trafficked from a certain day, applied to the stop on specific lines

Code Block
breakoutModewide
languagexml
<situationExchangeDeliveryStructure xmlns:ns5="http://www.siri.org.uk/siri" xmlns:ns2="http://www.ifopt.org.uk/acsb" xmlns:ns4="http://datex2.eu/schema/2_0RC1/2_0" xmlns:ns3="http://www.ifopt.org.uk/ifopt">
    <ns5:ResponseTimestamp>2024-10-14T15:18:23.917+02:00</ns5:ResponseTimestamp>
    <ns5:SubscriberRef>Samtrafiken</ns5:SubscriberRef> <!-- as specified  <ns5:SubscriptionRef>situation_exchange-1728919101</ns5:SubscriptionRef>
    <ns5:Situations>
        <ns5:PtSituationElement>
by Samtrafiken when the subscription is created, not required when publish/subscribe is not used for data transfer -->
           <ns5:CreationTime>2024-10-07T13:57:38.53+02:00<SubscriptionRef>situation_exchange-1728919101</ns5:CreationTime>SubscriptionRef> <!-- as specified by Samtrafiken when the subscription is created, not required when <ns5:ParticipantRef>OrganisationName</ns5:ParticipantRef>
      publish/subscribe is not used for data transfer -->
     <ns5:SituationNumber>TX1234567</ns5:SituationNumber>Situations>
            <ns5:Source>PtSituationElement>
                <ns5:Other>RT1234567<<ns5:CreationTime>2024-10-07T13:57:38.53+02:00</ns5:Other>CreationTime>
            <ns5:ParticipantRef>OrganisationName</ns5:ParticipantRef>
   <ns5:Name>ORG\USER</ns5:Name>
                <ns5:ExternalCode>RT1234567-TX1234567<SituationNumber>TX1234567</ns5:ExternalCode>SituationNumber>
            </ns5<ns5:Source>
                <ns5:Progress>open<Other>RT1234567</ns5:Progress>Other>
                <ns5:ValidityPeriod>Name>ORG\USER</ns5:Name>
                <ns5:StartTime>2024-10-07T13:57:00+02:00<ExternalCode>RT1234567-TX1234567</ns5:StartTime>ExternalCode>
            </ns5:ValidityPeriod>Source>
            <ns5:Summary>Hållplats Västra Saltvik</Progress>open</ns5:Summary>Progress>
            <ns5:Description>HållplatsValidityPeriod>
Västra Saltvik i Härnösand är färdigbyggd och trafikeras från och med 7 oktober av linje 501, 532 och 534. Med anledning av detta trafikeras hållplats Hamnleden fortsättningsvis endast i riktning från stan. <ns5:StartTime>2024-10-07T13:57:00+02:00</ns5:StartTime>
            </ns5:Description>ValidityPeriod>
            <ns5:Affects><UndefinedReason/>
            <ns5:Summary>Hållplats    <ns5:Networks>Västra Saltvik</ns5:Summary>
            <ns5:Description>Hållplats Västra Saltvik i Härnösand är färdigbyggd och <ns5:AffectedNetwork>trafikeras från och med 7 oktober av linje 501, 532 och 534. Med anledning av detta trafikeras hållplats Hamnleden fortsättningsvis endast i riktning från  <ns5:AffectedLine>stan.</ns5:Description>
            <ns5:Affects>
                <ns5:LineRef>SE:022:Line:9011022050100000</ns5:LineRef>Networks>
                    <ns5:AffectedNetwork>
   </ns5:AffectedLine>                     </ns5<ns5:AffectedNetwork>AffectedLine>
                    <ns5:AffectedNetwork>        <ns5:LineRef>SE:022:Line:9011022050100000</ns5:LineRef>
                <ns5:AffectedLine>        </ns5:AffectedLine>
                    <ns5:LineRef>SE:022:Line:9011022053200000<</ns5:LineRef>AffectedNetwork>
                    <ns5:AffectedNetwork>
       <ns5:Routes>                 <ns5:AffectedLine>
               <ns5:AffectedRoute>             <ns5:LineRef>SE:022:Line:9011022053200000</ns5:LineRef>
                       <ns5:StopPoints>     <ns5:Routes>
                                   <ns5:AffectedOnly>true</ns5:AffectedOnly>
  AffectedRoute>
                                     <ns5:AffectedStopPoint>StopPoints>
                                            <ns5:StopPointRef>SE:022:Quay:9022022000898005<AffectedOnly>true</ns5:StopPointRef>AffectedOnly>
                                        </ns5<ns5:AffectedStopPoint>
                                        <ns5:AffectedStopPoint>         <ns5:StopPointRef>SE:022:Quay:9022022000898005</ns5:StopPointRef>
                                      <ns5:StopPointRef>SE:022:Quay:9022022001948002<  </ns5:StopPointRef>AffectedStopPoint>
                                        </ns5<ns5:AffectedStopPoint>
                                            <!-- more stoppoints --><ns5:StopPointRef>SE:022:Quay:9022022001948002</ns5:StopPointRef>
                                        </ns5:StopPoints>AffectedStopPoint>
                                </ns5:AffectedRoute>        <!-- more stoppoints -->
                 </ns5:Routes>                   </ns5:StopPoints>
           </ns5:AffectedLine>                     </ns5:AffectedNetwork>AffectedRoute>
                    <ns5:AffectedNetwork>        </ns5:Routes>
                <ns5:AffectedLine>        </ns5:AffectedLine>
                    <ns5:LineRef>SE:022:Line:9011022053400000<</ns5:LineRef>AffectedNetwork>
                            <ns5:Routes>AffectedNetwork>
                        <ns5:AffectedLine>
       <ns5:AffectedRoute>                     <ns5:LineRef>SE:022:Line:9011022053400000</ns5:LineRef>
               <ns5:StopPoints>             <ns5:Routes>
                           <ns5:AffectedOnly>true</ns5:AffectedOnly>     <ns5:AffectedRoute>
                                    <ns5:AffectedStopPoint>
 StopPoints>
                                          <ns5:StopPointRef>SE:022:Quay:9022022000898004<AffectedOnly>true</ns5:StopPointRef>AffectedOnly>
                                        </ns5<ns5:AffectedStopPoint>
                                        <ns5:AffectedStopPoint>    <ns5:StopPointRef>SE:022:Quay:9022022000898004</ns5:StopPointRef>
                                        <ns5:StopPointRef>SE:022:Quay:9022022001948002</</ns5:StopPointRef>AffectedStopPoint>
                                        </ns5<ns5:AffectedStopPoint>
                                        <!-- more points -->
 <ns5:StopPointRef>SE:022:Quay:9022022001948002</ns5:StopPointRef>
                                   </ns5:StopPoints>      </ns5:AffectedStopPoint>
                          </ns5:AffectedRoute>              <!-- more points -->
           </ns5:Routes>                         </ns5:AffectedLine>StopPoints>
                                </ns5:AffectedNetwork>AffectedRoute>
                            </ns5:Networks>Routes>
                <ns5:StopPoints>        </ns5:AffectedLine>
            <ns5:AffectedStopPoint>        </ns5:AffectedNetwork>
                <ns5:StopPointRef>SE:022:Quay:9022022080290001<</ns5:StopPointRef>Networks>
                    </ns5:AffectedStopPoint><ns5:StopPoints>
                    <ns5:AffectedStopPoint>
                        <ns5:StopPointRef>SE:022:Quay:9022022080290002<9022022080290001</ns5:StopPointRef>
                    </ns5:AffectedStopPoint>
                </ns5:StopPoints>    <ns5:AffectedStopPoint>
                        <<ns5:StopPointRef>SE:022:Quay:9022022080290002</ns5:Affects>StopPointRef>
                    </ns5:PtSituationElement>AffectedStopPoint>
                </ns5:Situations>
</situationExchangeDeliveryStructure>StopPoints>
            </ns5:Affects>
        </ns5:PtSituationElement>
    </ns5:Situations>
</situationExchangeDeliveryStructure>

Stop no longer trafficked from a certain day, applied to a complete vehicle journey

Code Block
breakoutModewide
languagexml
<situationExchangeDeliveryStructure xmlns:ns5="http://www.siri.org.uk/siri" xmlns:ns2="http://www.ifopt.org.uk/acsb" xmlns:ns4="http://datex2.eu/schema/2_0RC1/2_0" xmlns:ns3="http://www.ifopt.org.uk/ifopt">
    <ns5:ResponseTimestamp>2024-10-14T15:18:23.917+02:00</ns5:ResponseTimestamp>
    <ns5:SubscriberRef>Samtrafiken</ns5:SubscriberRef> <!-- as specified by Samtrafiken when the subscription is created, not required when publish/subscribe is not used for data transfer -->
    <ns5:SubscriptionRef>situation_exchange-1728919101</ns5:SubscriptionRef> <!-- as specified by Samtrafiken when the subscription is created, not required when publish/subscribe is  <ns5:SubscriberRef>Samtrafiken</ns5:SubscriberRef>
    <ns5:SubscriptionRef>situation_exchange-1728919101</ns5:SubscriptionRef>not used for data transfer -->
    <ns5:Situations>
        <ns5:PtSituationElement>
            <ns5:CreationTime>2024-10-07T13:57:38.53+02:00</ns5:CreationTime>
            <ns5:ParticipantRef>OrganisationName</ns5:ParticipantRef>
            <ns5:SituationNumber>TX1234567</ns5:SituationNumber>
            <ns5:Source>
                <ns5:Other>RT1234567</ns5:Other>
                <ns5:Name>ORG\USER</ns5:Name>
                <ns5:ExternalCode>RT1234567-TX1234567</ns5:ExternalCode>
            </ns5:Source>
            <ns5:Progress>open</ns5:Progress>
            <ns5:ValidityPeriod>
                <ns5:StartTime>2024-10-07T13:57:00+02:00</ns5:StartTime>
            </ns5:ValidityPeriod>
            <UndefinedReason/>
            <ns5:Summary>Hållplats Västra Saltvik</ns5:Summary>
            <ns5:Description>Hållplats Västra Saltvik i Härnösand är färdigbyggd och trafikeras från och med 7 oktober av linje 501, 532 och 534. Med anledning av detta trafikeras hållplats Hamnleden fortsättningsvis endast i riktning från stan.</ns5:Description>
            <ns5:Affects>
                <ns5:VehicleJourneys>
                    <ns5:AffectedVehicleJourney>
                        <ns5:FramedVehicleJourneyRef>
                            <ns5:DataFrameRef>2024-10-02</ns5:DataFrameRef>
                            <ns5:DatedVehicleJourneyRef>000500555003<:DatedVehicleJourneyRef>SE:022:ServiceJourney:000500555003</ns5:DatedVehicleJourneyRef>
                        </ns5:FramedVehicleJourneyRef>
                        <ns5:Route> <!-- currently ignored by Samtrafiken -->
                            <ns5:StopPoints>
                                <ns5:AffectedStopPoint>
                                    <ns5:StopPointRef>SE:022:Quay:9022022000001001</ns5:StopPointRef>
                                </ns5:AffectedStopPoint>
                            </ns5:StopPoints>
                        </ns5:Route>
                    </ns5:AffectedVehicleJourney>
                </ns5:VehicleJourneys>
            </ns5:Affects>
        </ns5:PtSituationElement>
    </ns5:Situations>
</situationExchangeDeliveryStructure>