VehicleMonitoringRequest

Type

VehicleMonitoringRequestStructure

Related elements

Substitution group chain: AbstractFunctionalServiceRequest abstract → AbstractServiceRequest abstract → AbstractRequest abstract

Referenced by: ServiceRequest, VehicleMonitoringSubscriptionRequest

Content model

Element 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
groupVehicleMonitoringTopicGroup 1..1

Parameters that specify the content to be returned.
- VehicleMonitoringRef 0..1 VehicleMonitoringRefStructure
  
  A predefined scope for making VEHICLE requests.
- choice 0..1
  - VehicleRef 1..1 VehicleRefStructure
    
    Reference to a specific VEHICLE about which data is requested.
  - LineRef 1..1 LineRefStructure
    
    Filter the results to include only vehicles for the specific LINE.
- DirectionRef 0..1 DirectionRefStructure
  
  Filter the results to include only VEHICLEs going to this DIRECTION.
groupVehicleMonitoringRequestPolicyGroup 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:booleandefault false
  
  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 will be used as the default value.
- MaximumVehicles 0..1 xsd:positiveInteger
  
  The maximum number of MONITORED VEHICLE JOURNEYs to include in a given delivery. The most recent n Events within the look ahead window are included.
- VehicleMonitoringDetailLevel 0..1 VehicleMonitoringDetailEnumeration
  
  Level of detail to include in response.
- MaximumNumberOfCalls 0..1
  
  If calls are to be returned, maximum number of calls to include in response. If absent, exclude all calls. (since SIRI 2.0).
  - Previous 0..1 xsd:nonNegativeInteger
    
    Maximum number of previous calls to include. Only applies if VehicleMonitoringDetailLevel of Calls specified. Zero for none. If VehicleMonitoringDetailLevel of Calls specified but MaximumNumberOfCalls.Previous absent, include all previous calls. (since SIRI 2.0).
  - Onwards 0..1 xsd:nonNegativeInteger
    
    Maximum number of onwards calls to include. Zero for none. Only applies if VehicleMonitoringDetailLevel of 'calls' specified. Zero for none. If VehicleMonitoringDetailLevel calls specified but MaximumNumberOfCalls.Onwards absent, include all onwards calls. (since SIRI 2.0).
- IncludeSituations 0..1 xsd:boolean
  
  Whether any related Situations should be included in the ServiceDelivery. Default is 'false'. (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).

Properties

Attributes

1

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