Global element

PtSituationElement

Defined in SIRI/xsd/siri_model/siri_situation.xsd:242

Type for individual PT Incident.

Type

PtSituationElementStructure

Content model

Element structure

inherited from AbstractSituationElementStructure 7 items
- CreationTime 1..1 xsd:dateTime
  
  Time of creation of SITUATION.
- groupSituationSharedIdentityGroup 1..1
  
  Elements Reference to a SITUATION or an update to a SITUATION. Participant ref is optional and may be supplied from context.
  - groupSituationBaseIdentityGroup 1..1
    
    Type for reference to a SITUATION or an update to a SITUATION. Participant ref is optional and may be supplied from context.
    - CountryRef 0..1 ifopt:CountryRefStructure
      
      Unique identifier of a Country of a Participant who created SITUATION. Provides namespace for Participant If absent proided from context.
    - ParticipantRef 0..1 ParticipantRefStructure
      
      Unique identifier of a Participant. Provides namespace for SITUATION. If absent provdied from context.
    - SituationNumber 1..1 EntryQualifierStructure
      
      Unique identifier of SITUATION within a Participant. Excludes any version number.
  - groupSituationUpdateIdentityGroup 1..1
    
    Type for reference to a SITUATION or an update to a SITUATION. Participant ref is optional and may be supplied from context.
    - UpdateCountryRef 0..1 ifopt:CountryRefStructure
      
      Unique identifier of a Country of a Participant who created Update SITUATION element. Provides namespace for VersionParticipant If absent same as.
    - UpdateParticipantRef 0..1 ParticipantRefStructure
      
      Unique identifier of a Participant. Provides namespace for SITUATION. If absent provdied from context.
    - Version 0..1 SituationVersion
      
      Unique identifier of update version within a SITUATION Number Omit if reference to the base SITUATION.
inherited from SituationElementStructure 3 items
- groupSituationInfoGroup 1..1
  
  situation Informatiion.
  - References 0..1 ReferencesStructure
    
    Associations with other SITUATIONs.
  - Source 1..1 SituationSourceStructure
    
    Information about source of information, that is, where the agent using the capture client obtained an item of information, or in the case of an automated feed, an identifier of the specific feed. Can be used to obtain updates, verify details or otherwise assess relevance.
- VersionedAtTime 0..1 xsd:dateTime
  
  Time at which SITUATION element was versioned. Once versioned, no further changes can be made.
Defined here
groupPtSituationBodyGroup 1..1

Body of SITUATION.
- groupStatusGroup 1..1
  
  Status elements.
  - Verification 0..1 VerificationStatusEnumeration
    
    Whether the SITUATION has been verified.
  - Progress 0..1 WorkflowStatusEnumerationdefault open
    
    ProgressStatus. One of a specified set of overall processing states assigned to SITUATION. For example, 'Draft' for not yet published; 'Published' for live SITUATIONs; 'Closed' indicates a completed SITUATION.
  - QualityIndex 0..1 QualityIndexEnumerationdefault reliable
    
    Assessement of likely correctness of data. Default is reliable
  - Reality 0..1 D2LogicalModel:InformationStatusEnum
    
    Whether SITUATION is real or a test.
  - Likelihood 0..1 D2LogicalModel:ProbabilityOfOccurrenceEnum
    
    Likellihood of a future situation happening.
  - Publication 0..unbounded PublicationStatusType
    
    DEPRECATED - Use the element Progress instead, which provides an enumeration of possible values detailed in WorkflowStatusEnumeration. Publishing status one of a specified set of substates to which a SITUATION can be assigned. -v2.1
- groupTemporalGroup 1..1
  
  Elements affecting temporal scope of SITUATION.
  - ValidityPeriod 1..unbounded HalfOpenTimestampOutputRangeStructure
    
    Overall inclusive Period of applicability of SITUATION.
  - Repetitions 0..1
    
    Situation applies only on the repeated day types within the overall validity period(s). For example, Sunday.
    - DayType 1..unbounded DayTypeEnumerationdefault everyDay
      
      Day on which a SITUATION may apply - TPEG Pti34 DayType
  - PublicationWindow 0..unbounded HalfOpenTimestampOutputRangeStructure
    
    Publication Window for SITUATION if different from validity period.
- groupClassifierGroup 1..1
  
  Structured Classification Elements using TPEG Pts038 AlertCause.
  - groupReasonGroup 1..1
    
    Structured Reason elements. The TpegReason and/or PublicEventReason enumerated values can be used to generate standardized messages describing the SITUATION. If no enumerated values are given, ReasonName is used instead. Note: this means that ReasonName is NOT a complete message, but only a (few) word(s) to be included in the message!
    - groupTpegReasonGroup 1..1
      
      Structured classification of nature of SITUATION, from which a standardized message can be generated.
      - choice 1..1
        
        AlertCause 1..1 AlertCauseEnumeration
        
        TPEG Pts38: AlertCause.
        
        UnknownReason 1..1 xsd:string
        
        DEPRECATED since SIRI 2.1 - use only AlertCause.
        
        MiscellaneousReason 1..1 xsd:NMTOKEN
        
        DEPRECATED since SIRI 2.1 - use only AlertCause.
        
        PersonnelReason 1..1 xsd:NMTOKEN
        
        DEPRECATED since SIRI 2.1 - use only AlertCause.
        
        EquipmentReason 1..1 xsd:NMTOKEN
        
        DEPRECATED since SIRI 2.1 - use only AlertCause.
        
        EnvironmentReason 1..1 xsd:NMTOKEN
        
        DEPRECATED since SIRI 2.1 - use only AlertCause.
        
        UndefinedReason 1..1 xsd:string
        
        DEPRECATED since SIRI 2.1 - use only AlertCause.
    - groupTpegSubReasonGroup 0..1
      
      DEPRECATED since SIRI 2.1 - use only TpegReasonGroup and PublicEventReason.
      - choice 1..1
        
        MiscellaneousSubReason 1..1 xsd:NMTOKEN
        
        DEPRECATED and changed to nmtoken since SIRI 2.1 (TPEG Pti19 - Miscellaneous Event Reason)
        
        PersonnelSubReason 1..1 xsd:NMTOKEN
        
        DEPRECATED and changed to nmtoken since SIRI 2.1 (TPEG Pti20 - Personnel Event Reason)
        
        EquipmentSubReason 1..1 xsd:NMTOKEN
        
        DEPRECATED and changed to nmtoken since SIRI 2.1 (TPEG Pti21 - Equipment Event Reason)
        
        EnvironmentSubReason 1..1 xsd:NMTOKEN
        
        DEPRECATED and changed to nmtoken since SIRI 2.1 (TPEG Pti22 - Environment Event Reason)
    - PublicEventReason 0..1 D2LogicalModel:PublicEventTypeEnum
      
      Structured classification of Public Event, from which a standardized message can be generated.
    - ReasonName 0..unbounded NaturalLanguageStringStructure
      
      Textual classification of nature of SITUATION, from which a standardized message can be generated. Not normally needed, except when TpegReason and PublicEventReason are absent. (Unbounded since SIRI 2.0)
    - ControlActionRef 0..1 ControlActionRefStructure
      
      Reference to a ControlAction being a reason for the situation. It is place in the ReasonGroup to emphasise that the CONTROL ACTION is the reason for the SITUATION, and not the way around: in the opposite case (a SITUATION being the reason for the CONTROL ACTION, some weather condition, or an accident, for example) the CONTROL ACTION will refer the SITUATION.
      
      Note that if the ControlAction is the master ControlAction of a GroupOfControlActions it is assumed that the refence is valid for all the ControlActions of the group.
  - Severity 0..1 SeverityEnumerationdefault normal
    
    Severity of Incident - TPEG Pti26. Default is 'normal'.
  - Priority 0..1 xsd:nonNegativeInteger
    
    Arbitrary rating of priority 1-High.
  - Sensitivity 0..1 SensitivityEnumeration
    
    Confidentiality of SITUATION.
  - Audience 0..1 AudienceEnumerationdefault public
    
    Intended audience of SITUATION.
  - ScopeType 0..1 ScopeTypeEnumeration
    
    Nature of scope, e.g. general, network.
  - ReportType 0..1 ReportTypeEnumerationdefault unknown
    
    Scope of incident - TPEG Pti27 ReportType
  - Planned 0..1 xsd:booleandefault false
    
    Whether the SITUATION was planned (e.g. engineering works) or unplanned (e.g. service alteration). Default is 'false', i.e. unplanned.
  - 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. Can be overwritten in an individual action.
  - SecondaryReasons 0..1
    
    Additional reasons
    - sequence 1..unbounded
      - Reason 1..1
        
        Reason
        
        groupReasonGroup 1..1
        
        Structured Reason elements. The TpegReason and/or PublicEventReason enumerated values can be used to generate standardized messages describing the SITUATION. If no enumerated values are given, ReasonName is used instead. Note: this means that ReasonName is NOT a complete message, but only a (few) word(s) to be included in the message!
        
        groupTpegReasonGroup 1..1
        
        Structured classification of nature of SITUATION, from which a standardized message can be generated.
        
        choice 1..1
        
        AlertCause 1..1 AlertCauseEnumeration
        
        TPEG Pts38: AlertCause.
        
        UnknownReason 1..1 xsd:string
        
        DEPRECATED since SIRI 2.1 - use only AlertCause.
        
        MiscellaneousReason 1..1 xsd:NMTOKEN
        
        DEPRECATED since SIRI 2.1 - use only AlertCause.
        
        PersonnelReason 1..1 xsd:NMTOKEN
        
        DEPRECATED since SIRI 2.1 - use only AlertCause.
        
        EquipmentReason 1..1 xsd:NMTOKEN
        
        DEPRECATED since SIRI 2.1 - use only AlertCause.
        
        EnvironmentReason 1..1 xsd:NMTOKEN
        
        DEPRECATED since SIRI 2.1 - use only AlertCause.
        
        UndefinedReason 1..1 xsd:string
        
        DEPRECATED since SIRI 2.1 - use only AlertCause.
        
        groupTpegSubReasonGroup 0..1
        
        DEPRECATED since SIRI 2.1 - use only TpegReasonGroup and PublicEventReason.
        
        choice 1..1
        
        MiscellaneousSubReason 1..1 xsd:NMTOKEN
        
        DEPRECATED and changed to nmtoken since SIRI 2.1 (TPEG Pti19 - Miscellaneous Event Reason)
        
        PersonnelSubReason 1..1 xsd:NMTOKEN
        
        DEPRECATED and changed to nmtoken since SIRI 2.1 (TPEG Pti20 - Personnel Event Reason)
        
        EquipmentSubReason 1..1 xsd:NMTOKEN
        
        DEPRECATED and changed to nmtoken since SIRI 2.1 (TPEG Pti21 - Equipment Event Reason)
        
        EnvironmentSubReason 1..1 xsd:NMTOKEN
        
        DEPRECATED and changed to nmtoken since SIRI 2.1 (TPEG Pti22 - Environment Event Reason)
        
        PublicEventReason 0..1 D2LogicalModel:PublicEventTypeEnum
        
        Structured classification of Public Event, from which a standardized message can be generated.
        
        ReasonName 0..unbounded NaturalLanguageStringStructure
        
        Textual classification of nature of SITUATION, from which a standardized message can be generated. Not normally needed, except when TpegReason and PublicEventReason are absent. (Unbounded since SIRI 2.0)
        
        ControlActionRef 0..1 ControlActionRefStructure
        
        Reference to a ControlAction being a reason for the situation. It is place in the ReasonGroup to emphasise that the CONTROL ACTION is the reason for the SITUATION, and not the way around: in the opposite case (a SITUATION being the reason for the CONTROL ACTION, some weather condition, or an accident, for example) the CONTROL ACTION will refer the SITUATION.
        
        Note that if the ControlAction is the master ControlAction of a GroupOfControlActions it is assumed that the refence is valid for all the ControlActions of the group.
- groupDescriptionGroup 1..1
  
  Text description of SITUATION. Some or all of this may have been generated from the other structured content elements. Where text has been overriden this is indicated.
  - Language 0..1 xsd:languagedefault en
    
    Default language.
  - Summary 0..unbounded DefaultedTextStructure
    
    Summary of SITUATION. If absent should be generated from structure elements, and/or by condensing Description. (Unbounded since SIRI 2.0)
  - Description 0..unbounded DefaultedTextStructure
    
    Description of SITUATION. Should not repeat any strap line included in Summary. (Unbounded since SIRI 2.0)
  - Detail 0..unbounded DefaultedTextStructure
    
    Additional descriptive details about the SITUATION (Unbounded since SIRI 2.0).
  - Advice 0..unbounded DefaultedTextStructure
    
    Further advice to passengers. (Unbounded since SIRI 2.0)
  - Internal 0..1 DefaultedTextStructure
    
    For internal information only, not passenger relevant
  - Images 0..1
    
    Any images associated with SITUATION.
    - Image 1..unbounded ImageStructure
      
      Image description.
      - inherited from ImageStructure 3 items
        
        choice 1..1
        
        ImageRef 1..1 xsd:anyURI
        
        Reference to an image.
        
        ImageBinary 1..1 xsd:base64Binary
        
        Embedded image.
        
        ImageContent 0..1 ImageContentEnumeration
        
        Categorisation of image content.
  - InfoLinks 0..1
    
    Hyperlinks to other resources associated with SITUATION.
    - InfoLink 1..unbounded InfoLinkStructure
      
      Hyperlink description.
- groupPtBodyGroup 0..1
  
  Body of SITUATION.
  - Affects 0..1 AffectsScopeStructure
    
    Structured model identifiying parts of transport network affected by SITUATION. OPERATOR and NETWORK values will be defaulted to values in general Context unless explicitly overridden.
  - Consequences 0..1 PtConsequencesStructure
    
    Structured model describing effect of the SITUATION on PT system.
  - PublishingActions 0..1 ActionsStructure
    
    Structured model describing distribution actions to handle SITUATION. Any actions stated completely replace those from Context. If no actions are stated, any actions from general Context are used.
Extensions 0..1 ExtensionsStructure

Extensions to schema. (Wrapper tag used to avoid problems with handling of optional 'any' by some validators).