Global element

StopPointsRequest

Defined in OpRa/SIRI/xsd/siri_discovery.xsd:161

Requests a list of the STOP POINTs and places covered by a Producer.

Type

StopPointsDiscoveryRequestStructure

Related elements

Substitution group chain: AbstractDiscoveryRequest abstract → AuthenticatedRequest abstract

Referenced by: Siri

Content model

Element structure

  • inherited from AbstractRequestStructure 1 item
  • inherited from AuthenticatedRequestStructure 2 items
    • groupAuthenticatedRequestGroup 1..1

      Elemenst for authecticiation. (since SIRI 2.0)

      • AccountId 0..1 xsd:NMTOKEN

        Account Identifier. May be used to attribute requests to a particular application provider and authentication key. The account may be common to all users of an application, or to an individual user. Note that to identify an individual user the RequestorRef can be used with an anonymised token. . (since SIRI 2.0)

      • AccountKey 0..1 xsd:normalizedString

        Authentication key for request. May be used to authenticate requests from a particular account. (since SIRI 2.0)

  • inherited from AbstractDiscoveryRequestStructure 3 items
    • groupRequestorEndpointGroup 1..1

      Elements relating to system that sent request.

      • Address 0..1 EndpointAddress

        Address to which response is to be sent. This may also be determined from RequestorRef and preconfigured data.

      • RequestorRef 1..1 ParticipantRefStructure

        Reference to a requestor - Participant Code.

      • MessageIdentifier 0..1 MessageQualifierStructure

        Arbitrary unique identifier that can be used to reference this message in subsequent interactions.

  • inherited from StopPointsDiscoveryRequestStructure 8 items
    • groupStopPointsDiscoveryRequestTopicGroup 1..1

      Parameters that specify the content to be returned. ((since SIRI 2.0))

      • choice 1..1
        • BoundingBox 0..1 BoundingBoxStructure

          Rectangle containing stops be returned. ((since SIRI 2.0))

        • Circle 0..1 LocationStructure

          Circle containing stops be returned. Point indicates centre, precision indicates radius ((since SIRI 2.0))

        • PlaceRef 0..1 xsd:normalizedString

          Filter the results to include only stops associated with the PLACE . ((since SIRI 2.0))

      • OperatorRef 0..1 OperatorRefStructure

        Filter the results to include only stops run by the specified OPERATOR. ((since SIRI 2.0))

      • LineRef 0..1 LineRefStructure

        Filter the results to include only stops for the given LINE. ((since SIRI 2.0))

    • groupStopPointsDiscoveryRequestPolicyGroup 1..1

      Parameters that affect the request processing. Mostly act to reduce the number of stops returned. ((since SIRI 2.0))

      • Language 0..unbounded xsd:languagedefault en

        Preferred languages in which to return text values. (since SIRI 2.0)

      • StopPointsDetailLevel 0..1 StopPointsDetailEnumerationdefault normal

        Level of detail to include in response. Default is 'normal'. (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
inherited 1 attribute from base types
AttributeTypeUseDocumentationInherited from
version VersionString optional
default: 2.1

Version number of request. Fixed

 StopPointsDiscoveryRequestStructure