Complex type

SituationExchangeRequestStructure

Defined in SIRI/xsd/siri_situationExchange_service.xsd:142

Type for Functional Service Request for Situation Exchange Service.

Base type

AbstractFunctionalServiceRequestStructure

Used by elements

SituationExchangeRequest

Content model

Type structure

inherited from AbstractRequestStructure 1 item
- RequestTimestamp 1..1 xsd:dateTime
  
  Timestamp on request.
inherited from AbstractServiceRequestStructure 1 item
- groupContextualisedRequestEndpointGroup 1..1
  
  Unique reference to request: participant and SIRI service type are given by context. Used on requests that are embedded in the context of another request. Only a message identfiier may be needed.
  - MessageIdentifier 0..1 MessageQualifierStructure
    
    Arbitrary unique reference to this message.
Defined here
groupSituationExchangeTopicGroup 1..1

Parameters that specify the content to be returned. Logically ANDed with other values.
- groupTemporalSubscriptionGroup 1..1
  
  Parameters to control time for which subscription applies.
  - PreviewInterval 0..1 PositiveDurationType
    
    Forward duration for which SITUATIONs should be included, that is, only SITUATIONs that start before the end of this window time will be included.
  - StartTime 0..1 xsd:dateTime
    
    Start time for selecting SITUATIONs to be sent. Only SITUATIONs or updates created after this time will be sent. This enables a restart without resending everything.
- groupTemporalContentFilterGroup 1..1
  
  Parameters to filter Situation Exchange Service requests, based on the time. Logically ANDed with other values.
  - ValidityPeriod 0..1 HalfOpenTimestampInputRangeStructure
    
    Temporal scope of Situations be included in response. The Situations must be valid within the specified period of time. (since SIRI 2.0)
  - IncludeOnlyIfInPublicationWindow 0..1 xsd:booleandefault false
    
    Only incidents that are currently within their publication window shouldbe included. Otherwose all incidents will be included. Default is false
- groupAffectedModeGroup 1..1
  
  Mode Submode. Overrides any value sspecified for (i) Affected Network (ii) General Context.
  - VehicleMode 0..1 VehicleModesOfTransportEnumerationdefault unknown
    
    Vehicle mode or mode of transport.
  - groupPtNetworkModeChoiceGroup 0..1
    
    Submode of mode.
    - choice 1..1
      - AirSubmode 1..1 AirSubmodesOfTransportEnumerationdefault unknown
        
        TPEG Pti08 and Pts108 "AirService" submodes.
      - BusSubmode 1..1 BusSubmodesOfTransportEnumerationdefault unknown
        
        TPEG Pti05 and Pts105 "BusService" submodes.
      - CoachSubmode 1..1 CoachSubmodesOfTransportEnumerationdefault unknown
        
        TPEG Pti03 and Pts103 "CoachService" submodes.
      - MetroSubmode 1..1 MetroSubmodesOfTransportEnumerationdefault unknown
        
        TPEG Pti04 metro and Pts104 "UrbanRailwayService" submodes.
      - RailSubmode 1..1 RailSubmodesOfTransportEnumerationdefault unknown
        
        TPEG Pti02, Pts102 "RailwayService" and train link loc13 submodes.
      - TramSubmode 1..1 TramSubmodesOfTransportEnumerationdefault unknown
        
        TPEG Pti06 tram and Pts104 "UrbanRailwayService" submodes.
      - WaterSubmode 1..1 WaterSubmodesOfTransportEnumerationdefault unknown
        
        TPEG Pti07 and Pts107 "WaterTransportService" submodes.
      - TelecabinSubmode 1..1 TelecabinSubmodesOfTransportEnumerationdefault unknown
        
        TPEG Pti09 telecabin and Pts109 "GondolaCableCarService" submodes.
  - AccessMode 0..1 ifopt:AccessModesEnumeration
- groupSituationClassifierFilterGroup 1..1
  
  Parameters to filter Situation Exchange Service requests, based on the SITUATION Classifiers. Logically ANDed with other values.
  - Severity 0..1 SeverityEnumerationdefault normal
    
    Severity filter value to apply: only SITUATIONs with a severity greater than or equal to the specified value will be returned. See TPEG severities. Default is 'normal'.
  - Scope 0..unbounded ScopeTypeEnumeration
    
    Types of SITUATION to include.
  - Predictability 0..1 PredictabilityEnumeration
    
    Whether just planned, unplanned or both SITUATIONs will be returned.
  - Keywords 0..1 xsd:NMTOKENS
    
    Arbitrary application specific classifiers. Only SITUATIONs that match these keywords will be returned.
- groupSituationStatusFilterGroup 1..1
  
  Parameters to filter Situation Exchange Service requests, based on the SITUATION Status. Logically ANDed with other values.
  - Verification 0..1 VerificationStatusEnumeration
    
    Whether incident has been verified or not If not specified return all.
  - Progress 0..unbounded WorkflowStatusEnumerationdefault open
    
    Workflow Progress Status. 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. If not specified return open, published closing and closed. l.
  - Reality 0..1 D2LogicalModel:InformationStatusEnum
    
    Whether SITUATION is real or a test. If not specified return all.
- groupSituationNetworkFilterGroup 0..1
  
  Parameters to filter Situation Exchange Service requests, based on the SITUATION Network. Logically ANDed with other values.
  - OperatorRef 0..1 OperatorRefStructure
    
    Reference to an OPERATOR. If unspecified, all OPERATOR.s.
  - OperationalUnitRef 0..unbounded OperationalUnitRefStructure
    
    OPERATIONAL UNIT responsible for managing services.
  - NetworkRef 0..1 OperatorRefStructure
    
    Reference to a NETWORK.
  - choice 1..1
    - LineRef 0..unbounded LineRefStructure
      
      Filter the results to include only the given line.
    - Lines 0..1
      
      Filter the results to include only situations along the given LINEs.
      - LineDirection 1..unbounded LineDirectionStructure
        
        Filter the results to include only the given line. and direction
  - StopPointRef 0..unbounded StopPointRefStructure
    
    Reference to a SCHEDULED STOP POINT.
    
    Reference to a STOP POINT.
  - ConnectionLinkRef 0..unbounded ConnectionLinkRefStructure
    
    Reference to a CONNECTION link
  - FacilityRef 0..unbounded FacilityRefStructure
    
    Reference to a Facility.
- groupSituationStopPlaceFilterGroup 1..1
  
  Parameters to filter Situation Exchange Service requests, based on the STOP PLACEs affected SITUATIONs. Logically ANDed with other values.
  - StopPlaceRef 0..1 ifopt:StopPlaceRefStructure
    
    Reference to a STOP PLACE.
  - StopPlaceComponentRef 0..1 ifopt:StopPlaceSpaceRefStructure
    
    Reference to part of a STOP PLACE. (since SIRI 2.0)
- groupSituationJourneyFilterGroup 1..1
  
  Parameters to filter Situation Exchange Service requests, based on the VEHICLE JOURNEYs affected by the SITUATION. Logically ANDed with other values.
  - choice 0..1
    
    Use of simple reference is deprecated
    - FramedVehicleJourneyRef 1..1 FramedVehicleJourneyRefStructure
      
      Refercence to a VEHICLE JOURNEY framed by the day. SIRI 2.0
    - VehicleJourneyRef 1..1 VehicleJourneyRefStructure
      
      Reference to a VEHICLE JOURNEY.
  - InterchangeRef 0..1 InterchangeRefStructure
    
    Reference to a SERVICE JOURNEY INTERCHANGE.
  - VehicleRef 0..1 VehicleRefStructure
    
    Reference to a VEHICLE.
- groupSituationPlaceFilterGroup 1..1
  
  Parameters to filter Situation Exchange Service requests, based on the SITUATION Place. Logically ANDed with other values.
  - CountryRef 0..1 ifopt:CountryRefStructure
    
    Reference to a COUNTRY where incident takes place If specified only incidents that affect this place country will be returned.
  - PlaceRef 0..1 xsd:NMTOKEN
    
    Reference to a TOPOGRAPHIC PLACE. Only incidents which are deemed to affect this place will be returned.
  - Location 0..2 LocationStructure
    
    Bounding box of an arbitrary area. Only incidents geocoded as falling within area will be included.
- SituationRoadFilter 0..1
  
  Parameters to filter Situation Exchange Service requests, based on the SITUATION Road. Logically ANDed with other values.
  - RoadFilter 1..unbounded RoadFilterStructure
- AccessibilityNeedFilter 0..unbounded acsb:PassengerAccessibilityNeedsStructure
  
  Parameters to filter Situation Exchange Service requests, based on specific needs .
groupSituationExchangeRequestPolicyGroup 1..1

Parameters that affect the request processing.
- Language 0..unbounded xsd:languagedefault en
  
  Preferred languages in which to return text values.
- IncludeTranslations 0..1 xsd:boolean
  
  Whether additional translations of text names are to be included in elements. If false, then only one element should be returned. Default is false.
  
  Where multiple values are returned The first element returned ill be used as the default value.
- MaximumNumberOfSituationElements 0..1 xsd:positiveInteger
  
  The maximum number of SITUATION elements to return in a given delivery. The most recent n Events within the look ahead window are included.
Extensions 0..1 ExtensionsStructure

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

Properties

Attributes

Attribute	Type	Use	Documentation	Source
`version`	`VersionString`	optional default: `2.1`	Version number of request. Fixed