Complex type

PassengerInformationActionStructure

Defined in SIRI/xsd/siri_model/siri_situationActions.xsd:593

No documentation provided.

Base type

ParameterisedActionStructure

Used by elements

PassengerInformationAction

Content model

Type structure

  • inherited from SimpleActionStructure 1 item
  • inherited from ParameterisedActionStructure 6 items
    • Description 0..1 NaturalLanguageStringStructure

      Description of action.

    • Keywords 0..1 xsd:NMTOKENS

      A whitespace-separated list of arbitrary application specific classifiers, tags or message categories for filtering or display, for example as icons on a situation map. Overwrites Keywords on PtSituationElement level (in the context of this action).

    • ActionData 0..unbounded ActionDataStructure

      Data associated with action.

    • PublicationRef 0..1 xsd:NMTOKEN

      Unique identifier of the Published Action, intended to faciliate its tracking by data consumers. IMPORTANT NOTE: In SIRI v3.0, chances are high that the element will differ and/or be restructured though the functionality will not change.

    • PublicationWindow 0..unbounded ClosedTimestampRangeStructure

      Defines a number of publication windows. When not sent, then the publication windows of higher level are valid. Can be overwritten by deeper level.

    • ConsequenceRef 0..unbounded ConsequenceRefStructure

      Refers to the unique identifier of one or several Consequences that trigerred this Action. The ConsequenceRef should remain unique during the lifecycle of the ActionData. IMPORTANT NOTE: In SIRI v3.0, chances are high that the element will differ and/or be restructured though the functionality will not change.

  • Defined here
  • ActionRef 1..1 EntryQualifierStructure

    Reference to the action number within the incident concept.

  • Period 0..unbounded HalfOpenTimestampOutputRangeStructure

    Period restricts the applicability of a PassengerInformationAction to a specific sub-range of the enclosing ValidityPeriod on PtSituationElement level. In particular when using the Perspective 'whilePlanningTrip', a single ValidityPeriod at PtSituationElement level may be insufficient to ensure correct selection of the actually affected journeys in a journey planning context. This applies whenever a PassengerInformationAction is intended to be effective only during certain parts of the overall SITUATION duration or validity (e.g. time-of-day–dependent passenger information). Period SHALL ONLY be used when a single ValidityPeriod is insufficient to differentiate the applicability of multiple actions. Period MUST always be a strict subset of the enclosing ValidityPeriod and MUST NOT start earlier or end later. For PassengerInformationActions with Perspective 'atStopPoint' and/or 'onBoardVehicle', Period has no meaning and SHALL NOT be used. If omitted, then the ValidityPeriods on PtSituationElement level apply.

  • RecordedAtTime 1..1 xsd:dateTime

    The time of the last update. This must be the timestamp of the original data source and not that of an intermediate system, such as a data hub. This timestamp has to be changed by the source system with every update.

  • Version 0..1 SituationVersion

    The monotonically increasing version of the passenger information instance. If absent, is the same version as the enclosing Situation

  • SourceRef 0..1 ParticipantRefStructure

    The system which created this passenger information. If absent, the same system as the PtSituationElement.ParticipantRef.

  • OwnerRef 0..1 OrganisationRefStructure

    The organisation which owns this passenger information.

  • Perspective 1..unbounded PerspectiveEnumeration

    Perspective of the passenger, e.g. general, vehicleJourney, stopPoint.

  • ActionPriority 0..1 xsd:positiveInteger

    Prioritises a passenger information action from the information owner's point of view, e.g. suitable for sorting or hiding individual passenger information actions. 1 = highest priority.

  • ActionIsClosing 0..1 xsd:booleandefault false

    ActionIsClosing 'true' signals to the consuming system that the corresponding TextualContent informs passengers about a normalisation. Consequently, the consuming system will display a specific symbol, understood by passengers as "traffic is normalizing" or "restrictions are lifted", in combination with the TextualContent of this action. Actions corresponding to a normalisation of traffic typically have a lower display priority than other actions, i.e., should be displayed only if enough space is available. By default, an action does not correspond to a normalisation, i.e., has ActionIsClosing 'false'.

  • TextualContent 1..unbounded TextualContentStructure

    The actual, structured passenger information for a specific TextualContentSize.