Global element

SubscriptionRequest

Defined in SIRI/xsd/siri/siri_base.xsd:146

Request from Subscriber to Producer for a subscription. Answered with a SubscriptionResponse.

Type

SubscriptionRequestStructure

Related elements

Referenced by: Siri

Content model

Element structure

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

      Elements for authentication. (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 RequestStructure 5 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.

    • groupDelegatorEndpointGroup 1..1

      If request has been proxied by an intermediate aggregating system , tracking information relating to the original requestor. This allows the aggregation to be stateless. (since SIRI 2.0)

      • DelegatorAddress 0..1 EndpointAddress

        Address of original Consumer, i.e. requesting system to which delegating response is to be returned. (since SIRI 2.0)

      • DelegatorRef 0..1 ParticipantRefStructure

        Identifier of delegating system that originated message. (since SIRI 2.0)

  • inherited from AbstractSubscriptionRequestStructure 3 items
    • groupSubscriberEndpointGroup 1..1

      Unique reference to request. May be used to reference request in subsequent interactions.

      • ConsumerAddress 0..1 EndpointAddress

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

      • SubscriptionFilterIdentifier 0..1 xsd:NMTOKEN

        Reference to a Subscription Filter with which this subscription is to be aggregated for purposes of notification and delivery. If absent, use the default filter. If present, use any existing filter with that identifier, if none found, create a new one. Optional SIRI feature.

    • SubscriptionContext 0..1 SubscriptionContextStructure

      General values that apply to subscription. Usually set by configuration.

  • inherited from SubscriptionRequestStructure 1 item