Global element

HeartbeatNotification

Defined in OpRa/SIRI/xsd/siri/siri_common_services.xsd:838

Notification from Producer to Consumer to indicate that the service is running normally.

Type

HeartbeatNotificationStructure

Related elements

Substitution group chain: ProducerRequest 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 ProducerRequestEndpointStructure 5 items
    • groupProducerRequestEndpointGroup 1..1

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

      • Address 0..1 EndpointAddress

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

      • ProducerRef 0..1 ParticipantRefStructure

        Unique identifier of Producer - Participant reference.

      • MessageIdentifier 0..1 MessageQualifierStructure

        Arbitrary unique reference to this message. Some systems may use just timestamp for this. Where there are multiple SubscriptionFilters, this can be used to distinguish between different notifications for different filters.

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

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

  • Defined here
  • groupCheckStatusPayloadGroup 1..1

    Data received AcknowledgementService Status Check Request content.

    • Status 0..1 xsd:booleandefault true

      Whether the request was processed successfully or not. Default is 'true'.

    • DataReady 0..1 xsd:boolean

      Whether data delivery is ready to be fetched SIRI v 2.0

    • ErrorCondition 0..1

      Description of any error or warning condition that applies to the status check.

    • groupSuccessInfoGroup 1..1

      Additional information provided if request is successful.

      • ValidUntil 0..1 xsd:dateTime

        End of data horizon of the data producer.

      • ShortestPossibleCycle 0..1 PositiveDurationType

        Minimum interval at which updates can be sent.

    • ServiceStartedTime 0..1 xsd:dateTime

      Time at which current instantiation of service started.

  • Extensions 0..1 ExtensionsStructure

    Extensions to schema. (Wrapper tag used to avoid problems with handling of optional 'any' by some validators).