Complex type

ControlActionDeliveryStructure

Defined in SIRI/xsd/siri_controlAction_service.xsd:309

Type for Delivery for Control Action Service.

Base type

AbstractServiceDeliveryStructure

Used by elements

ControlActionDelivery

Content model

Type structure

inherited from ResponseStructure 1 item
- ResponseTimestamp 1..1 xsd:dateTime
  
  Time individual response element was created.
inherited from AbstractServiceDeliveryStructure 11 items
- choice 1..1
  - groupContextualisedResponseEndpointGroup 1..1
    
    Endpoint reference proprerties for response message: participant and SIRI service type are given by context.
    - RequestMessageRef 0..1 MessageQualifierStructure
      
      Arbitrary unique reference to the request which gave rise to this message.
  - groupSubscriptionIdentifierResourcePropertyGroup 1..1
    
    Unique reference to subscription May be used to reference subscription in subsequent interactions.
    - SubscriberRef 0..1 ParticipantRefStructure
      
      Unique identifier of Subscriber - reference to a Participant.
    - SubscriptionFilterRef 0..1 SubscriptionFilterRefStructure
      
      Unique identifier of Subscription filter to which this subscription is assigned. If there is onlya single filter, then can be omitted.
    - SubscriptionRef 1..1 SubscriptionQualifierStructure
      
      Reference to a service subscription: unique within Service and Subscriber.
- groupDelegatorEndpointGroup 1..1
  
  If request has been proxied by an intermediate aggregting system, trackng informattion relating to the original requestor. This allows the aggregation to be stateless.
  - DelegatorAddress 0..1 EndpointAddress
    
    Address of original Consumer, i.e. requesting system to which delegating response is to be returned. +SIRI 2.0
  - DelegatorRef 0..1 ParticipantRefStructure
    
    Identifier of delegating system that originated message. +SIRI 2.0
- groupDeliveryStatusGroup 1..1
  
  Status Information for individual request.
  - Status 0..1 xsd:booleandefault true
    
    Whether the request was processed successfully or not. Default is 'true'.
  - ErrorCondition 0..1 ServiceDeliveryErrorConditionStructure
    
    Description of any error or warning condition.
  - groupSuccessInfoGroup 1..1
    
    Additional information provided if request is successful.
    - ValidUntil 0..1 xsd:dateTime
      
      End of data horizon of the data producer.
    - ShortestPossibleCycle 0..1 PositiveDurationType
      
      Minimum interval at which updates can be sent.
- groupDeliveryDefaultGroup 1..1
  
  Common defaults.
  - DefaultLanguage 0..1 xsd:language
    
    Default language for text elements.
Defined here
groupControlActionPayloadGroup 1..1

Payload part of Control Action Service delivery.
- controlActions 0..1
  
  Describes ControlActions
  - ControlAction 1..unbounded ControlActionStructure
- groupsOfControlActions 0..1
  
  Add one or more ControlActions to a set of related ControlActions.
  - GroupOfControlActions 1..unbounded
    
    Describes a group of control action
    - GroupOfControlActionsCode 1..1 xsd:NMTOKEN
      
      Identification of the set: can be the Master Case / Situation Id
    - PurposeOfGrouping 0..1 NaturalLanguageStringStructure
      
      Functional purpose for which GROUPs of CONTROL ACTIONs is defined.
    - Description 0..unbounded NaturalLanguageStringStructure
      
      Contains a generic textual description of the Control Action Set (reason fro creatin the set, etc.)
    - groupMasterRef 1..1
      - choice 1..1
        
        MasterControlCaseRef 1..1 ControlActionRefStructure
        
        SituationRef 1..1 SituationRefStructure
        
        Reference to a SITUATION associated with the element.
    - AddedControlActions 0..1
      
      Codes of Control Actions added to the set (group)
      - AddedControlActionRef 1..unbounded ControlActionRefStructure
        
        Control Action Code
    - RemovedControlActions 0..1
      
      Codes of Control Actions removed from the set (group)
      - RemovedControlActionRef 1..unbounded ControlActionRefStructure
        
        Control Action Code
- revokedControlActions 0..1
  
  Revokes one or several ControlActions
  - RevokedControlAction 1..unbounded
    
    Only certain Control Actions can be revoked. Revoking will typically only shorten the time scope of a Control Action.
    - choice 1..1
      - ControlActionRef 1..1 ControlActionRefStructure
        
        Control Action Code
      - ItemIdentifierRef 1..1 ItemRefStructure
        
        Itemidentifier of an update of the ControlAction (only that update is revoked)
    - RevokedFromDateTime 0..1 xsd:dateTime
      
      Time at which the ControlAction has been revoke, or will be revoked.
    - SourceNote 0..1 NaturalLanguageStringStructure
      
      This is a note including a hint of who revoked this control action. It could include name and organisational unit of the information provider
- driverMessages 0..1
  
  Set of message echnaged with dirvers
  - DriverMessage 1..unbounded DriverMessageStructure
    
    Describes a message exchanges with a driver
- vehicleDetectings 0..1
  
  Set of detections of Vehicles
  - VehicleDetecting 1..unbounded VehicleDetectingStructure
    
    Describes a vehicle detection
Note 0..unbounded NaturalLanguageStringStructure

Text associated with whole delivery. (Unbounded 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

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