Complex type

ControlActionRequestStructure

Defined in SIRI/xsd/siri_controlAction_service.xsd:215

Type for Functional Service Request for Control Action Service.

Base type

AbstractFunctionalServiceRequestStructure

Used by elements

ControlActionRequest

Content model

Type structure

  • inherited from AbstractRequestStructure 1 item
  • 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.

  • Defined here
  • groupControlActionTopicGroup 1..1

    Parameters that specify the content to be returned.

    • PreviewInterval 0..1 PositiveDurationType

      Forward duration for which Visits should be included, that is, interval before predicted arrival at the stop for which to include Visits: only journeys which will arrive or depart within this time span will be returned.

    • StartTime 0..1 xsd:dateTime

      Start time for PreviewInterval. If absent, then current time is assumed.

    • OperatorRef 0..1 OperatorRefStructure

      Filter the results to include only Stop Visits for VEHICLEs run by the specified OPERATOR.

    • 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

    • IncludeDriverMessages 0..1 xsd:booleandefault false

      Wether Driver Messages shall be included in the answer (defaulf no)

    • IncludeVehicleDetectings 0..1 xsd:booleandefault false

      Wether Vehicle Detecting shall be included in the answer (defaulf no)

  • groupControlActionRequestPolicyGroup 1..1

    Parameters that affect the request processing. Mostly act to reduce the number of stops returned.

    • 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.

    • IncludeSituations 0..1 xsd:booleandefault false

      Whether any related SITUATIONs should be included in the ServiceDelivery. Default is 'false'. +SIRI v2.0

    • MaximumNumberOfControlActions 0..1 xsd:positiveInteger

      The maximum number of CONTROL ACTIONS 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

1
AttributeTypeUseDocumentation
version VersionString optional
default: 2.1

Version number of request.