Complex type

EstimatedCallStructure

Defined in SIRI/xsd/siri_model/siri_estimatedVehicleJourney.xsd:385

Type for real-time info about a VEHICLE JOURNEY Stop.

Used by elements

EstimatedCall

Content model

Type structure

8 top-level

groupStopPointInSequenceGroup 1..1

Elements identifying an ordered visit to a SCHEDULED STOP POINT within a SERVICE PATTERN.
- StopPointRef 1..1 StopPointRefStructure
  
  Reference to a SCHEDULED STOP POINT.
  
  Reference to a STOP POINT.
- VisitNumber 0..1 VisitNumberType
  
  Sequence of visit to SCHEDULED STOP POINT.within VEHICLE JOURNEY. Increases monotonically, but not necessarily sequentially.
- Order 0..1 xsd:positiveInteger
  
  For implementations for which the overall Order is not used for VisitNumber, (i.e. if VisitNumberIsOrder is false) then can be used to associate the stop Order as well if useful.
- StopPointName 0..unbounded NaturalLanguageStringStructure
  
  Name of SCHEDULED STOP POINT. (Unbounded since SIRI 2.0)
choice 0..1
- ExtraCall 0..1 xsd:booleandefault false
  
  This CALL is an addition to the respective journey in the production timetable or to the previously sent prediction. If omitted: CALL is planned.
- Cancellation 0..1 CallCancellationdefault false
groupCallRealTimeInfoGroup 1..1

Information relating to real-time properties of call.
- PredictionInaccurate 0..1 xsd:booleandefault false
  
  Whether the prediction for a specific stop or the whole journey is considered to be of a useful accuracy or not. Default is 'false', i.e. prediction is considered to be accurate. If prediction is degraded, e.g. because of a situation, PredictionInaccurate is used to indicate a lowered quality of data. Inherited property. PredictionInaccurate can be used in combination with InCongestion, but is more general.
- PredictionInaccurateReason 0..1 PredictionInaccurateReasonEnumeration
  
  Can be used to inform the passenger about the reason for a change of the prediction (in)accuracy in case PredictionInaccurate is set to 'true'. (since SIRI 2.1)
- Occupancy 0..1 OccupancyEnumeration
  
  An approximate figure of how occupied the journey is after departing from a given stop, e.g. 'manySeatsAvailable' or 'standingRoomOnly'. If omitted: Passenger load is unknown. Occupancies and capacities for individual VEHICLEs, e.g. parts of a COMPOUND TRAIN, can also be specified in more detail for the departure on CALL level.
groupCallPropertyGroup 1..1

Elements describing the CALL Properties Values for these elements can be specified on an production VEHICLE JOURNEY CALL. Each real-time journey CALL takes its values from the corresponding dated VEHICLE JOURNEY CALL. The absence of a value on an real-time CALL l indicates that the value should be inherited (i) from any recent preceding update message for the same entity, or if there is no previous override, (ii) from its immediate parent entity.
- TimingPoint 0..1 xsd:booleandefault true
  
  Whether the stop is a TIMING POINT. Times for stops that are not timing points are sometimes interpolated crudely from the timing points, and may represent a lower level of accuracy. Default is 'true'.
- BoardingStretch 0..1 xsd:booleandefault false
  
  Whether this is a Hail and Ride Stop. Default is 'false'.
- RequestStop 0..1 xsd:booleandefault false
  
  Whether Vehicle stops only if requested explicitly by passenger. Default is 'false'.
- OriginDisplay 0..unbounded NaturalLanguageStringStructure
  
  Origin to show for the VEHICLE at the specific stop (vehicle signage), if different to the Origin Name for the full journey. (since SIRI 2.0)
- DestinationDisplay 0..unbounded NaturalLanguageStringStructure
  
  Destination to show for the VEHICLE at the specific stop (vehicle signage), if different to the Destination Name for the full journey.
groupCallNoteGroup 1..1

Annotations of the CALL.
- CallNote 0..unbounded NaturalLanguageStringStructure
  
  Text annotation that applies to this CALL.
groupDisruptionGroup 1..1

Elements describing nature of disruption.
- FormationCondition 0..unbounded FormationConditionStructure
  
  Information about a change of the formation (e.g. TRAIN composition) or changes of vehicles within the formation. (since SIRI 2.1)
- FacilityConditionElement 0..unbounded FacilityConditionStructure
  
  Information about a change of Equipment availability at stop or on vehicle that may affect access or use.
- sequence 1..1
  
  This sequence is here only for compatibility reasons between Siri 1.0 and Siri 1.1
  - FacilityChangeElement 0..1 FacilityChangeStructure
    
    A change to the availaibility of EQUIPMENT. Basic structure defined in the first 1.0 SIRI XSd.
  - SituationRef 0..unbounded SituationRefStructure
    
    Reference to a SITUATION associated with the element.
- ControlActionRef 0..1 ControlActionRefStructure
  
  Reference to a ControlAction having possible consequences on the EstimatedVehicleJourney. 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.
groupOnwardsCallGroup 1..1

Elements describing the CALL. Values for these elements can be specified on an production VEHICLE JOURNEY CALL. Each real-time journey CALL takes its values from the corresponding dated VEHICLE JOURNEY CALL. The absence of a value on an real-time CALL l indicates that the value should be inherited (i) from any recent preceding update message for the same entity, or if there is no previous override, (ii) from its immediate parent entity.
- groupOnwardVehicleArrivalTimesGroup 1..1
  
  Elements for Arrival in onward CALl.
  - AimedArrivalTime 0..1 xsd:dateTime
    
    Target arrival time of VEHICLE at stop according to latest working timetable.
  - choice 1..1
    - ExpectedArrivalTime 0..1 xsd:dateTime
      
      Estimated time of arriival of VEHICLE at stop .
    - LatestExpectedArrivalTime 0..1 xsd:dateTime
      
      Latest time at which a VEHICLE will arrive at stop. (since SIRI 2.1)
    - ExpectedArrivalPredictionQuality 0..1 PredictionQualityStructure
      
      Prediction quality, either as approximate level, or more quantitative percentile range of predictions that will fall within a given range of times. (since SIRI 2.0)
    - ArrivalPredictionUnknown 1..1 EmptyType
      
      If the producer is (temporarily) not able to deliver real-time predictions (e.g. because of a connection loss), he has various options (and combinations of them) to inform the consumer: (i) set Monitored to 'false' (ii) transmit ExpectedArrivalTime together with "PredictionInaccurate=true" (iii) drop/omit ExpectedArrivalTime (iv) set ArrivalStatus to 'noReport' However, this might introduce ambiguity: e.g. option (iii) might be interpreted as "on time" by one consumer, but also as "indefinite delay" by another consumer. To avoid this, the producer should transmit xxxPredictionUnknown instead of any expected times. (since SIRI 2.1)
- groupMonitoredStopArrivalStatusGroup 1..1
  
  Elements describing the arrival status of a VEHICLE at a stop.
  - ArrivalStatus 0..1 CallStatusEnumeration
    
    Classification of the timeliness of the visit according to a fixed list of values. If not specified, same as DepartureStatus.
  - ArrivalCancellationReason 0..1 NaturalLanguageStringStructure
    
    Text annotation to be used in cases where ArrivalStatus is set to 'cancelled'. (since SIRI 2.1)
  - ArrivalProximityText 0..1 NaturalLanguageStringStructure
    
    Arbitrary text string to show to indicate the status of the departure of the VEHICLE for example, “Enroute”, “5 Km”, “Approaching”. May depend on the policy of the OPERATOR, for example show “Approaching” if less than 200metres away from stop. (since SIRI 2.0)
  - ArrivalPlatformName 0..1 NaturalLanguageStringStructure
    
    Bay or platform (QUAY) name to show passenger i.e. expected platform for vehicle to arrive at. Inheritable property. Can be omitted if the same as the DeparturePlatformName If there no arrival platform name separate from the departure platform name, the precedence is: (i) any arrival platform on any related dated timetable element, (ii) any departure platform name on this estimated element; (iii) any departure platform name on any related dated timetable CALL.
  - ArrivalBoardingActivity 0..1 ArrivalBoardingActivityEnumerationdefault alighting
    
    Type of alighting allowed at stop. Default is 'Alighting'.
  - ArrivalStopAssignment 0..unbounded StopAssignmentStructure
    
    Assignment of planned, expected and/or recorded arrival at STOP POINT to a phsyical QUAY (platform). If not given, assume same as for departure. (since SIRI 2.0).
  - ArrivalFormationAssignment 0..unbounded FormationAssignmentStructure
    
    Assignment of a TRAIN formation to a physical QUAY (platform or sectors thereof). If not given, assume same as for departure. (since SIRI 2.1)
  - ArrivalOrientationRelativeToQuay 0..unbounded VehicleOrientationRelativeToQuay
    
    Indication of the direction of travel of the vehicle (e.g. TRAIN formation) with respect to the platform, or more precisely the QUAY. Unbounded to allow multiple languages. (since SIRI 2.1) Examples: - "towards A" or "towards sector A" if the QUAY is separated into sub-QUAYs or so called sectors. This would be equivalent to the vehicle arriving at sector A first when approaching the QUAY with sectors A-B-C-D. If the arriving vehicle is represented as an arrow, "towards A" would be abstracted as "=> A-B-C-D". - "towards 0" or "towards reference point 0" if sectors are not available or the QUAY has a reference point, e.g. for measuring the length of the QUAY, identified by "0". This would be equivalent to the vehicle arriving at this reference point first when approaching the QUAY. If the arriving vehicle is represented as an arrow, "towards 0" would be abstracted as "=> 0...100". "100" (as in percent) could denote the opposite side of the QUAY (measured at the full length of the QUAY with respect to the reference point). It is advised to specify a reference point that is meaningful for passengers on location.
  - ArrivalOperatorRefs 0..unbounded OperatorRefStructure
    
    OPERATORs of of service up until arrival. May change for departure. (since SIRI 2.0).
- groupOnwardVehicleDepartureTimesGroup 1..1
  
  Elements for departure in ONWARD CALL.
  - AimedDepartureTime 0..1 xsd:dateTime
    
    Target departure time of VEHICLE from stop according to latest working timetable.
  - choice 1..1
    - ExpectedDepartureTime 0..1 xsd:dateTime
      
      Estimated time of departure of VEHICLE from stop, most likely taking into account all control actions such as waiting.
    - ProvisionalExpectedDepartureTime 0..1 xsd:dateTime
      
      Expected departure time of VEHICLE without waiting time due to operational actions. For people at stop this would normally be shown if different from Expected departure time. So if servcie decides not to wait may leave earler than expected departure time (since SIRI 2.0).
    - EarliestExpectedDepartureTime 0..1 xsd:dateTime
      
      Earliest time at which VEHICLE may leave the stop. Used to secure connections. Used for passenger announcements. Passengers must be at boarding point by this time to be sure of catching VEHICLE. i.e. "Vehicle will not leave before this time" - may be revised from original aimed time. (since SIRI 2.0)
    - ExpectedDeparturePredictionQuality 0..1 PredictionQualityStructure
      
      Prediction quality, either as approximate level, or more quantitative percentile range of predictions that will fall within a given range of times. (since SIRI 2.0)
    - DeparturePredictionUnknown 1..1 EmptyType
      
      If the producer is (temporarily) not able to deliver real-time predictions (e.g. because of a connection loss), he has various options (and combinations of them) to inform the consumer: (i) set Monitored to 'false' (ii) transmit ExpectedDepartureTime together with "PredictionInaccurate=true" (iii) drop/omit ExpectedDepartureTime (iv) set DepartureStatus to 'noReport' However, this might introduce ambiguity: e.g. option (iii) might be interpreted as "on time" by one consumer, but also as "indefinite delay" by another consumer. To avoid this, the producer should transmit xxxPredictionUnknown instead of any expected times. (since SIRI 2.1)
- groupPassengerDepartureTimesGroup 1..1
  
  Passenger arrival times at STOP PLACE in order to meet VEHICLE departure times for CALL.
  - AimedLatestPassengerAccessTime 0..1 xsd:dateTime
    
    Latest target time at which a PASSENGER should aim to arrive at the STOP PLACE containing the stop. This time may be earlier than the VEHICLE departure times and may include time for processes such as checkin, security, etc.(As specified by CHECK CONSTRAINT DELAYs in the underlying data). If absent assume to be the same as Earliest expected departure time. (since SIRI 2.0)
  - ExpectedLatestPassengerAccessTime 0..1 xsd:dateTime
    
    Latest expected time at which a PASSENGER should aim to arrive at the STOP PLACE containing the stop. This time may be earlier than the VEHICLE departure times and may include time for processes such as checkin, security, etc.(As specified by CHECK CONSTRAINT DELAYs in the underlying data). If absent assume to be the same as Earliest expected departure time. (since SIRI 2.0)
- groupMonitoredStopDepartureStatusGroup 1..1
  
  Elements describing the departure status of a VEHICLE from a stop.
  - DepartureStatus 0..1 CallStatusEnumeration
    
    Classification of the timeliness of the departure part of the CALL, according to a fixed list of values. This may reflect a presentation policy, for example CALLs less than one minute behind target time are still classified as on-time. Applications may use this to guide their own presentation of times.
  - DepartureCancellationReason 0..1 NaturalLanguageStringStructure
    
    Text annotation to be used in cases where DepartureStatus is set to 'cancelled'. (since SIRI 2.1)
  - DepartureProximityText 0..1 NaturalLanguageStringStructure
    
    Arbitrary text string to show to indicate the status of the departure of the vehicle, for example, “Boarding”, “GatesClosed”. (since SIRI 2.0)
  - DeparturePlatformName 0..1 NaturalLanguageStringStructure
    
    Departure QUAY (bay or platform) name. Default taken from planned timetable.
  - DepartureBoardingActivity 0..1 DepartureBoardingActivityEnumerationdefault boarding
    
    Nature of boarding allowed at stop. Default is 'Boarding'.
  - DepartureStopAssignment 0..unbounded StopAssignmentStructure
  - DepartureFormationAssignment 0..unbounded FormationAssignmentStructure
    
    Assignment of a TRAIN formation to a physical QUAY (platform or sectors thereof). (since SIRI 2.1)
  - DepartureOrientationRelativeToQuay 0..unbounded VehicleOrientationRelativeToQuay
    
    Indication of the direction of travel of the vehicle (e.g. TRAIN formation) with respect to the platform, or more precisely the QUAY. Unbounded to allow multiple languages. (since SIRI 2.1) Examples: - "towards A" or "towards sector A" if the QUAY is separated into sub-QUAYs or so called sectors. This would be equivalent to the vehicle departing in the direction of sector A on a QUAY with sectors A-B-C-D. If the departing vehicle is represented as an arrow, "towards A" would be abstracted as "<= A-B-C-D". - "towards 0" or "towards reference point 0" if sectors are not available or the QUAY has a reference point, e.g. for measuring the length of the QUAY, identified by "0". This would be equivalent to the vehicle departing in the direction of this reference point. If the departing vehicle is represented as an arrow, "towards 0" would be abstracted as "<= 0...100". "100" (as in percent) could denote the opposite side of the QUAY (measured at the full length of the QUAY with respect to the reference point). It is advised to specify a reference point that is meaningful for passengers on location.
  - choice 1..1
    - ExpectedDepartureOccupancy 0..unbounded VehicleOccupancyStructure
      
      Expected/Predicted real-time occupancies of a VEHICLE and reservations after departing from a given stop. (since SIRI 2.1)
    - ExpectedDepartureCapacities 0..unbounded PassengerCapacityStructure
      
      Expected/Predicted real-time capacities (number of available seats) of a VEHICLE after departing from a given stop. Alternative way to communicate occupancy measurements. (since SIRI 2.1)
    - RecordedDepartureOccupancy 0..unbounded VehicleOccupancyStructure
      
      Actually recorded/counted occupancies of a VEHICLE and reserved seats after departing from a given stop. (since SIRI 2.1)
    - RecordedDepartureCapacities 0..unbounded PassengerCapacityStructure
      
      Actually recorded/counted capacities of a VEHICLE after departing from a given stop. Alternative way to communicate occupancy measurements. (since SIRI 2.1)
  - DepartureOperatorRefs 0..unbounded OperatorRefStructure
    
    OPERATORs of service for departure and onwards. May change from that for arrival. (since SIRI 2.0).
- groupHeadwayIntervalGroup 1..1
  
  Elements describing the HEADWAY INTERVALs.
  - AimedHeadwayInterval 0..1 PositiveDurationType
    
    For frequency based services, target interval between vehicles at stop.
  - ExpectedHeadwayInterval 0..1 PositiveDurationType
    
    For frequency based services, expected interval between vehicles at stop.
- groupStopProximityGroup 1..1
  
  Elements describing the distance from the stop of a VEHICLE. (since SIRI 2.0).
  - DistanceFromStop 0..1 DistanceType
    
    Distance of VEHICLE from stop of CALL as measured along ROUTE track. Only shown if detail level is 'calls' or higher. Positive value denotes distance before stop. (since SIRI 2.0).
  - NumberOfStopsAway 0..1 xsd:nonNegativeInteger
    
    Count of stops along SERVICE PATTERN between current position of VEHICLE and stop of CALL as measured along ROUTE track. Only shown if detail level is 'calls' or higher. (since SIRI 2.0).
Extensions 0..1 ExtensionsStructure

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