complexType "HeartbeatNotificationStructure"
Namespace:
http://www.siri.org.uk/siri
Content:
complex, 15 elements
Defined:
globally in siri_common_services-v2.0.xsd; see XML source
Includes:
definition of 1 element
Used:
at 1 location
XML Representation Summary
<...>
   
Content: 
</...>
Content Model Elements (15):
AccountId (type xsd:NMTOKEN), AccountKey (type xsd:normalizedString), Address (type EndpointAddress), DataReady (type xsd:boolean), DelegatorAddress (type EndpointAddress), DelegatorRef (type ParticipantRefStructure), ErrorCondition (defined in CheckStatusPayloadGroup group), Extensions, MessageIdentifier (type MessageQualifierStructure), ProducerRef (type ParticipantRefStructure), RequestTimestamp, ServiceStartedTime (type xsd:dateTime), ShortestPossibleCycle (type PositiveDurationType), Status, ValidUntil (type xsd:dateTime)
All Direct / Indirect Based Elements (1):
HeartbeatNotification
Known Usage Locations
Annotation
Type for Service Heartbeat Notification.
Type Definition Detail
Type Derivation Tree
AbstractRequestStructure (extension)
  AuthenticatedRequestStructure (extension)
      ProducerRequestEndpointStructure (extension)
          HeartbeatNotificationStructure
XML Source (see within schema source)
<xsd:complexType name="HeartbeatNotificationStructure">
<xsd:annotation>
<xsd:documentation>Type for Service Heartbeat Notification.</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="ProducerRequestEndpointStructure">
<xsd:sequence>
<xsd:group ref="CheckStatusPayloadGroup"/>
<xsd:element minOccurs="0" ref="Extensions"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
Content Element Detail (all declarations; 15/15)
AccountId
Type:
xsd:NMTOKEN, predefined, simple content
Defined:
locally within AuthenticatedRequestGroup group
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
XML Source (see within schema source)
<xsd:element minOccurs="0" name="AccountId" type="xsd:NMTOKEN">
<xsd:annotation>
<xsd:documentation>
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
</xsd:documentation>
</xsd:annotation>
</xsd:element>
AccountKey
Type:
xsd:normalizedString, predefined, simple content
Defined:
locally within AuthenticatedRequestGroup group
Authentication key for request. May be used to authenticate requests from a particular account. +SIRI v2.0
XML Source (see within schema source)
<xsd:element minOccurs="0" name="AccountKey" type="xsd:normalizedString">
<xsd:annotation>
<xsd:documentation>
Authentication key for request. May be used to authenticate requests from a particular account. +SIRI v2.0
</xsd:documentation>
</xsd:annotation>
</xsd:element>
Address
Type:
EndpointAddress, simple content
Defined:
locally within ProducerRequestEndpointGroup group
Address to which response is to be sent. This may also be determined from ProducerRef and preconfigured data.
XML Source (see within schema source)
<xsd:element minOccurs="0" name="Address" type="EndpointAddress">
<xsd:annotation>
<xsd:documentation>
Address to which response is to be sent. This may also be determined from ProducerRef and preconfigured data.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
DataReady
Type:
xsd:boolean, predefined, simple content
Defined:
locally within CheckStatusPayloadGroup group
Whether data delivery is ready to be fetched SIRI v 2.0
XML Source (see within schema source)
<xsd:element minOccurs="0" name="DataReady" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>
Whether data delivery is ready to be fetched SIRI v 2.0
</xsd:documentation>
</xsd:annotation>
</xsd:element>
DelegatorAddress
Type:
EndpointAddress, simple content
Defined:
locally within DelegatorEndpointGroup group
Address of original Consumer, i.e. requesting system to which delegating response is to be returned. +SIRI 2.0
XML Source (see within schema source)
<xsd:element minOccurs="0" name="DelegatorAddress" type="EndpointAddress">
<xsd:annotation>
<xsd:documentation>
Address of original Consumer, i.e. requesting system to which delegating response is to be returned. +SIRI 2.0
</xsd:documentation>
</xsd:annotation>
</xsd:element>
DelegatorRef
Type:
ParticipantRefStructure, simple content
Defined:
locally within DelegatorEndpointGroup group
Identifier of delegating system that originated message. +SIRI 2.0
XML Source (see within schema source)
<xsd:element minOccurs="0" name="DelegatorRef" type="ParticipantRefStructure">
<xsd:annotation>
<xsd:documentation>
Identifier of delegating system that originated message. +SIRI 2.0
</xsd:documentation>
</xsd:annotation>
</xsd:element>
ErrorCondition
Type:
anonymous complexType, complex content
Defined:
locally within CheckStatusPayloadGroup group
Description of any error or warning condition that applies to the status check.
XML Source (see within schema source)
<xsd:element minOccurs="0" name="ErrorCondition">
<xsd:annotation>
<xsd:documentation>
Description of any error or warning condition that applies to the status check.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:choice>
<xsd:element ref="ServiceNotAvailableError"/>
<xsd:element ref="OtherError"/>
</xsd:choice>
<xsd:element minOccurs="0" name="Description" type="ErrorDescriptionStructure">
<xsd:annotation>
<xsd:documentation>Text description of error.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
Extensions
Type:
ExtensionsStructure, complex content
Defined:
by reference within (this) HeartbeatNotificationStructure complexType
XML Source (see within schema source)
<xsd:element minOccurs="0" ref="Extensions"/>
MessageIdentifier
Type:
MessageQualifierStructure, simple content
Defined:
locally within ProducerRequestEndpointGroup group
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.
XML Source (see within schema source)
<xsd:element minOccurs="0" name="MessageIdentifier" type="MessageQualifierStructure">
<xsd:annotation>
<xsd:documentation>
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.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
ProducerRef
Type:
ParticipantRefStructure, simple content
Defined:
locally within ProducerRequestEndpointGroup group
Unique identifier of Producer - Participant reference.
XML Source (see within schema source)
<xsd:element minOccurs="0" name="ProducerRef" type="ParticipantRefStructure">
<xsd:annotation>
<xsd:documentation>
Unique identifier of Producer - Participant reference.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
RequestTimestamp
Type:
xsd:dateTime, predefined, simple content
Defined:
by reference within AbstractRequestStructure complexType
XML Source (see within schema source)
<xsd:element ref="RequestTimestamp"/>
ServiceStartedTime
Type:
xsd:dateTime, predefined, simple content
Defined:
locally within CheckStatusPayloadGroup group
Time at which current instantiation of service started.
XML Source (see within schema source)
<xsd:element minOccurs="0" name="ServiceStartedTime" type="xsd:dateTime">
<xsd:annotation>
<xsd:documentation>
Time at which current instantiation of service started.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
ShortestPossibleCycle
Type:
PositiveDurationType, simple content
Defined:
locally within SuccessInfoGroup group
Minimum interval at which updates can be sent.
XML Source (see within schema source)
<xsd:element minOccurs="0" name="ShortestPossibleCycle" type="PositiveDurationType">
<xsd:annotation>
<xsd:documentation>Minimum interval at which updates can be sent.</xsd:documentation>
</xsd:annotation>
</xsd:element>
Status
Type:
xsd:boolean, predefined, simple content
Default:
"true"
Defined:
by reference within CheckStatusPayloadGroup group
XML Source (see within schema source)
<xsd:element minOccurs="0" ref="Status"/>
ValidUntil
Type:
xsd:dateTime, predefined, simple content
Defined:
locally within SuccessInfoGroup group
End of data horizon of the data producer.
XML Source (see within schema source)
<xsd:element minOccurs="0" name="ValidUntil" type="xsd:dateTime">
<xsd:annotation>
<xsd:documentation>End of data horizon of the data producer.</xsd:documentation>
</xsd:annotation>
</xsd:element>
This XML schema documentation has been generated with DocFlex/XML 1.9.5 using DocFlex/XML XSDDoc 2.8.1 template set.
DocFlex/XML is a tool for programming and running highly sophisticated documentation and reports generators by the data obtained from any kind of XML files. The actual doc-generators are implemented in the form of special templates that are designed visually using a high-quality Template Designer GUI basing on the XML schema (or DTD) files describing the data source XML.
DocFlex/XML XSDDoc is a commercial template application of DocFlex/XML that implements a high-quality XML Schema documentation generator with simultaneous support of framed multi-file HTML, single-file HTML and RTF output formats. (More formats are planned in the future).
A commercial license for "DocFlex/XML XSDDoc" will allow you:
  • To configure the generated documentation so much as you want. Thanks to our template technology, it was possible to support > 400 template parameters, which work the same as "options" of ordinary doc-generators. The parameters are organized in nested groups, which form a parameter tree. Most of them have their default values calculated dynamically from a few primary parameters. So, you'll never need to specify all of them. That will give you swift and effective control over the generated content!
  • To use certain features disabled in the free mode (such as the full documenting of substitution groups).
  • To select only the initial, imported, included, redefined XML schemas to be documented or only those directly specified by name.
  • To include only XML schema components specified by name.
  • To document local element components both globally and locally (similar to attributes).
  • To allow/suppress unification of local elements by type.
  • To enable/disable reproducing of namespace prefixes.
  • To use PlainDoc.tpl main template to generate all the XML schema documentation in a signle-file form as both HTML and incredible quality RTF output.
  • To format your annotations with XHTML tags and reproduce that formatting both in HTML and RTF output.
  • To insert images in your annotations using XHTML <img> tags (supported both in HTML and RTF output).
  • To remove this very advertisement text!
Once having only such a license, you will be able to run the fully-featured XML schema documentation generator both with DocFlex/XML (Full Edition) and with DocFlex/XML RE, which is a reduced free edition containing only the template interpretor / output generator. No other licenses will be required!
But this is not all. In addition to it, a commercial license for "DocFlex/XML SDK" will allow you to modify the XSDDoc templates themselves as much as you want. You will be able to achieve whatever was impossible to do with the template parameters only. And, of course, you could develop any template applications by your own!
Please note that by purchasing a license for this software, you not only acquire a useful tool, you will also make an important investment in its future development, the results of which you could enjoy later by yourself. Every single your purchase matters and makes a difference for us!
To purchase a license, please follow this link: http://www.filigris.com/shop/