Global element

StopMonitoringRequest

Defined in SIRI/xsd/siri_stopMonitoring_service.xsd:141

Request for information about Stop Visits, i.e. arrivals and departures at a stop.

Type

StopMonitoringRequestStructure

Related elements

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

Referenced by: StopMonitoringSubscriptionRequest

Content model

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

    • MonitoringRef 1..1 MonitoringRefStructure

      Reference to Monitoring Point(s) about which data is requested. May be a STOP POINT, timing point, or a group of points under a single reference.

    • OperatorRef 0..1 OperatorRefStructure

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

    • LineRef 0..1 LineRefStructure

      Filter the results to include only Stop Visits for VEHICLEs for the given LINE.

    • DirectionRef 0..1 DirectionRefStructure

      Filter the results to include only Stop Visits for vehicles running in a specific relative DIRECTION, for example, "inbound" or "outbound". (Direction does not specify a destination.)

    • DestinationRef 0..1 DestinationRefStructure

      Filter the results to include only journeys to the DESTINATION of the journey.

    • StopVisitTypes 0..1 StopVisitTypeEnumerationdefault all

      Whether to include arrival Visits, departure Visits, or all. Default is 'all'.

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

    • MaximumStopVisits 0..1 xsd:nonNegativeInteger

      The maximum number of Stop Visits to include in a given delivery. The first n Stop Visits within the look ahead window are included. Only Visits within the Lookahead Interval are returned. The MinimumStopVisits parameter can be used to reduce the the number of entries for each LINE within the total returned.

    • choice 1..1
      • MinimumStopVisitsPerLine 0..1 xsd:nonNegativeInteger

        The minimum number of Stop Visits for a given LINE to include in a given delivery. If there are more Visits within the LookAheadInterval than allowed by MaximumStopVisits and a MinimumStopVisits value is specified, then at least the minimum number will be delivered for each LINE. I.e Stop Visits will be included even if the Stop Visits are later than those for some other LINE for which the minimum number of Stop Visits has already been supplied. This allows the Consumer to obtain at least one entry for every available LINE with vehicles approaching the stop. Only STOP Visits within the Look ahead Interval are returned.

      • MinimumStopVisitsPerLineVia 0..1 xsd:nonNegativeInteger

        The minimum number of Stop Visits for a given LINE and VIA combination to include in a given delivery. As for MinimumStopVisitsPerLine but with Via also taken into account. (since SIRI 2.0)

    • MaximumTextLength 0..1 xsd:positiveIntegerdefault 30

      Maximum length of text to return for text elements. Default is 30.

    • StopMonitoringDetailLevel 0..1 StopMonitoringDetailEnumerationdefault normal

      Level of detail to include in response. Default is 'normal'.

    • IncludeSituations 0..1 xsd:booleandefault false

      Whether any related SITUATIONs should be included in the ServiceDelivery. Default is 'false'. (since SIRI 2.0)

    • MaximumNumberOfCalls 0..1

      If calls are to be returned, maximum number of calls to include in response. If absent, exclude all calls.

      • Previous 0..1 xsd:nonNegativeInteger

        Maximum number of ONWARDS CALLs to include in results. Only applies if StopMonitoringDetailLevel of 'calls' specified. Zero for none. If StopMonitoringDetailLevel of 'calls' specified but MaximumNumberOfCalls.Previous absent, include all ONWARDS CALLs.

      • Onwards 0..1 xsd:nonNegativeInteger

        Maximum number of ONWARDS CALLs to include in results. Zero for none. Only applies if StopMonitoringDetailLevel of 'calls'specified. Zero for none. If StopMonitoringDetailLevel of 'calls' specified but MaximumNumberOfCalls.Onwards absent, include all ONWARDS CALLs.

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