Global element

FacilityRequest

Defined in SIRI/xsd/siri_discovery.xsd:599

Requests a list of the Facilities covered by a Producer.

Type

FacilityRequestStructure

Related elements

Substitution group chain: AbstractDiscoveryRequest abstract → AuthenticatedRequest abstract

Content model

Element structure

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

      Elements for authentication. +SIRI v2.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. . +SIRI v2.0

      • AccountKey 0..1 xsd:normalizedString

        Authentication key for request. May be used to authenticate requests from a particular account. +SIRI v2.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.

  • Defined here
  • groupFacilityRequestTopicGroup 1..1

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

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

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

      • PlaceRef 0..1 xsd:normalizedString

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

    • OperatorRef 0..1 OperatorRefStructure

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

    • LineRef 0..1 LineRefStructure

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

  • groupFacilityRequestPolicyGroup 1..1

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

    • Language 0..unbounded xsd:languagedefault en

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

    • FacilityDetailLevel 0..1 FacilityDetailEnumerationdefault 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
AttributeTypeUseDocumentation
version VersionString optional
default: 2.1

Version number of request. Fixed