XML Schema "siri_common_services-v2.0.xsd"
Target Namespace:
http://www.siri.org.uk/siri
Version:
2.0
Defined Components:
elements (12 global + 51 local), complexTypes (20), simpleTypes (2), element groups (20)
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\Users\Tony\eclipse_workspace\siri-20-java\xsd\siri\siri_common_services-v2.0.xsd; see XML source
Includes Schemas (1):
siri_requests-v2.0.xsd [src]
Included in Schemas (2):
siri.xsd [src], siri_base-v2.0.xsd [src]
Annotation
SIRI Framework - Common Requests.
All Element Summary (local elements unified by type)
All (in TerminateSubscriptionRequest)
Terminate all subscriptions for the requestor.
Type:
EmptyType
Content:
simple
Defined:
locally within TerminateSubscriptionTopicGroup group; see XML source
AllData (in DataSupplyRequest)
Whether to return all data, or just new updates since the last delivery.
Type:
xsd:boolean
Content:
simple
Defined:
locally within DataSupplyTopicGroup group; see XML source
AllowedPredictors (in ServiceRequestContext)
Who may make a prediction.
Type:
PredictorsEnumeration
Content:
simple
Defined:
locally within PredictionMethodGroup group; see XML source
CheckStatusAddress (in ServiceRequestContext)
Address to which CheckStatus requests are to be sent.
Type:
EndpointAddress
Content:
simple
Defined:
locally within ServiceEndpointAddressGroup group; see XML source
CheckStatusRequest
Request from Consumer to Producer to check whether services is working.
Type:
CheckStatusRequestStructure
Content:
complex, 1 attribute, 9 elements
Subst.Gr:
may substitute for element AbstractTrackedRequest
Defined:
globally; see XML source
Used:
at 1 location
CheckStatusResponse
Response from Producer to Consumer to inform whether services is working.
Type:
CheckStatusResponseStructure
Content:
complex, 14 elements
Subst.Gr:
may substitute for element AbstractResponse
Defined:
globally; see XML source
Used:
at 1 location
ConfirmDelivery (in ServiceRequestContext)
Whether Consumers should issue an acknowledgement on successful receipt of a delivery.
Type:
xsd:boolean
Content:
simple
Defined:
locally within DeliveryContextGroup group; see XML source
ConsumerAddress (type EndpointAddress)
Type:
EndpointAddress
Content:
simple
Defined:
locally at 2 locations
DataHorizon (in ServiceRequestContext)
Maximum data horizon for requests.
Type:
PositiveDurationType
Content:
simple
Defined:
locally within TemporalContextGroup group; see XML source
DataNameSpaces (in ServiceRequestContext)
Default names pace used to scope data identifiers.
Type:
DataNameSpacesStructure
Content:
complex, 5 elements
Defined:
locally within ReferenceContextGroup group; see XML source
DataReady (type xsd:boolean)
Whether data delivery is ready to be fetched SIRI v 2.0
Type:
xsd:boolean
Content:
simple
Defined:
locally within CheckStatusPayloadGroup group; see XML source
DataReadyAcknowledgement
Response from Consumer to Producer to acknowledge to Producer that a DataReadyRequest has been received.
Type:
DataReadyResponseStructure
Content:
complex, 7 elements
Subst.Gr:
may substitute for element AbstractResponse
Defined:
globally; see XML source
Used:
at 2 locations
DataReadyNotification
Request from Producer to Consumer to notify that data update is ready to fetch.
Type:
DataReadyRequestStructure
Content:
complex, 8 elements
Subst.Gr:
may substitute for elements: ProducerRequest, AuthenticatedRequest
Defined:
globally; see XML source
Used:
at 2 locations
DataReceivedAcknowledgement
Response from Consumer to Producer to acknowledge that data hase been received.
Type:
DataReceivedResponseStructure
Content:
complex, 7 elements
Subst.Gr:
may substitute for element AbstractResponse
Defined:
globally; see XML source
Used:
at 3 locations
DataSupplyRequest
Request from Consumer to Producer to fetch update previously notified by a Data ready message.
Type:
DataSupplyRequestStructure
Content:
complex, 10 elements
Subst.Gr:
may substitute for element AbstractRequest
Defined:
globally; see XML source
Used:
at 2 locations
DeliveryMethod (in ServiceRequestContext)
Whether Delivery is fetched or retrieved.
Type:
DeliveryMethodEnumeration
Content:
simple
Defined:
locally within DeliveryContextGroup group; see XML source
Description (type ErrorDescriptionStructure)
Type:
ErrorDescriptionStructure
Content:
simple
Defined:
locally at 7 locations
DistanceUnits (in ServiceRequestContext)
Units for Distance Type.
Type:
xsd:normalizedString
Content:
simple
Defined:
locally within ReferenceContextGroup group; see XML source
ErrorCondition (defined in CheckStatusPayloadGroup group)
Description of any error or warning condition that applies to the status check.
Type:
anonymous complexType
Content:
complex, 3 elements
Defined:
locally within CheckStatusPayloadGroup group; see XML source
Includes:
definitions of 3 elements
ErrorCondition (in DataReadyAcknowledgement)
Description of any error or warning condition as to why Consumer cannot fetch data.
Type:
anonymous complexType
Content:
complex, 3 elements
Defined:
locally within DataReadyResponseStructure complexType; see XML source
Includes:
definitions of 3 elements
ErrorCondition (in DataReceivedAcknowledgement)
Description of any error or warning condition.
Type:
anonymous complexType
Content:
complex, 3 elements
Defined:
locally within DataReceivedPayloadGroup group; see XML source
Includes:
definitions of 3 elements
ErrorCondition (in TerminationResponseStatus)
Description of any error or warning condition.
Type:
anonymous complexType
Content:
complex, 5 elements
Defined:
locally within TerminationResponseStatusStructure complexType; see XML source
Includes:
definitions of 5 elements
ErrorCondition (type ServiceDeliveryErrorConditionStructure)
Type:
ServiceDeliveryErrorConditionStructure
Content:
complex, 16 elements
Defined:
locally at 3 locations
ErrrorCondition (in SubscriptionTerminatedNotification)
Text description providing additional information about the reason for the subscription termination.
Type:
ErrorConditionStructure
Content:
complex, 11 elements
Defined:
locally within SubscriptionTerminatedNotificationStructure complexType; see XML source
GetDataAddress (in ServiceRequestContext)
Address to which requests are to return data.
Type:
EndpointAddress
Content:
simple
Defined:
locally within ServiceEndpointAddressGroup group; see XML source
GmlCoordinateFormat (type SrsNameType)
Type:
SrsNameType
Content:
simple
Defined:
locally at 2 locations
HeartbeatNotification
Notification from Producer to Consumer to indicate that the service is running normally.
Type:
HeartbeatNotificationStructure
Content:
complex, 15 elements
Subst.Gr:
may substitute for elements: ProducerRequest, AuthenticatedRequest
Defined:
globally; see XML source
Used:
at 1 location
Language (type xsd:language)
Type:
xsd:language
Content:
simple
Defined:
locally at 18 locations
LineNameSpace (in DataNameSpaces)
Name space for LINE names and DIRECTIONss.
Type:
xsd:anyURI
Content:
simple
Defined:
locally within DataNameSpacesStructure complexType; see XML source
ManageSubscriptionAddress (in ServiceRequestContext)
Address to which subscription requests are to be sent.
Type:
EndpointAddress
Content:
simple
Defined:
locally within ServiceEndpointAddressGroup group; see XML source
MaximimumNumberOfSubscriptions (in ServiceRequestContext)
Maximum Number of subscriptions that can be sustained by the subscriber.
Type:
xsd:positiveInteger
Content:
simple
Defined:
locally within ResourceContextGroup group; see XML source
MessageRef (type MessageQualifierStructure)
Reference to an arbitrary unique reference associated with the request which gave rise to this response.
Type:
MessageQualifierStructure
Content:
simple
Defined:
locally within DeliveryEndpointGroup group; see XML source
MultipartDespatch (type xsd:boolean)
Type:
xsd:boolean
Content:
simple
Defined:
locally at 2 locations
NotificationRef (in DataSupplyRequest)
Reference to a specific notification message for which data is to be fetched.
Type:
MessageRefStructure
Content:
simple
Defined:
locally within DataSupplyTopicGroup group; see XML source
NotifyAddress (in ServiceRequestContext)
Address to which notifcations requests are to be sent.
Type:
EndpointAddress
Content:
simple
Defined:
locally within ClientEndpointAddressGroup group; see XML source
PredictionFunction (in ServiceRequestContext)
Name of prediction method used.
Type:
xsd:string
Content:
simple
Defined:
locally within PredictionMethodGroup group; see XML source
ProductCategoryNameSpace (in DataNameSpaces)
Name space for Product Categories.
Type:
xsd:anyURI
Content:
simple
Defined:
locally within DataNameSpacesStructure complexType; see XML source
RequestTimeout (in ServiceRequestContext)
Timeout for requests.
Type:
PositiveDurationType
Content:
simple
Defined:
locally within TemporalContextGroup group; see XML source
ResponseStatus
Contains infromation about the processing of a an individual service subscription - either success info or an error condition.
Type:
StatusResponseStructure
Content:
complex, 9 elements
Defined:
globally; see XML source
Used:
at 2 locations
ServiceFeatureNameSpace (in DataNameSpaces)
Name space for service features.
Type:
xsd:anyURI
Content:
simple
Defined:
locally within DataNameSpacesStructure complexType; see XML source
ServiceRequestContext (type ServiceRequestContextStructure)
General request properties - typically configured rather than repeated on request.
Type:
ServiceRequestContextStructure
Content:
complex, 22 elements
Defined:
locally within ContextualisedRequestStructure complexType; see XML source
ServiceStartedTime (type xsd:dateTime)
Type:
xsd:dateTime
Content:
simple
Defined:
locally at 3 locations
StatusResponseAddress (in ServiceRequestContext)
Address to which CheckStatus responses and heartbeats are to be sent.
Type:
EndpointAddress
Content:
simple
Defined:
locally within ClientEndpointAddressGroup group; see XML source
StopPointNameSpace (in DataNameSpaces)
Name space for STOP POINTs.
Type:
xsd:anyURI
Content:
simple
Defined:
locally within DataNameSpacesStructure complexType; see XML source
SubscribeAddress (in ServiceRequestContext)
Address to which subscription requests are to be sent.
Type:
EndpointAddress
Content:
simple
Defined:
locally within ServiceEndpointAddressGroup group; see XML source
SubscriberAddress (in ServiceRequestContext)
Address to which subscription responses are to be sent.
Type:
EndpointAddress
Content:
simple
Defined:
locally within ClientEndpointAddressGroup group; see XML source
SubscriberRef (type ParticipantRefStructure)
Type:
ParticipantRefStructure
Content:
simple
Defined:
locally at 5 locations
SubscriptionManagerAddress (in SubscriptionResponse)
Type:
EndpointAddress
Content:
simple
Defined:
locally at 2 locations
SubscriptionRef (type SubscriptionQualifierStructure)
Type:
SubscriptionQualifierStructure
Content:
simple
Defined:
locally at 3 locations
SubscriptionResponse
Response from Producer to Consumer to inform whether subscriptions have been created.
Type:
SubscriptionResponseStructure
Content:
complex, 10 elements
Subst.Gr:
may substitute for element AbstractResponse
Defined:
globally; see XML source
Used:
at 3 locations
SubscriptionTerminatedNotification
Notification from Subscriber to Subscription Manager to terminate a subscription.
Type:
SubscriptionTerminatedNotificationStructure
Content:
complex, 12 elements
Subst.Gr:
may substitute for element AbstractResponse
Defined:
globally; see XML source
Used:
at 1 location
TerminateSubscriptionRequest
Request from Subscriber to Subscription Manager to terminate a subscription.
Type:
TerminateSubscriptionRequestStructure
Content:
complex, 12 elements
Subst.Gr:
may substitute for element AuthenticatedRequest
Defined:
globally; see XML source
Used:
at 3 locations
TerminateSubscriptionResponse
Request from Subscriber to Subscription Manager to terminate a subscription.
Type:
TerminateSubscriptionResponseStructure
Content:
complex, 7 elements
Subst.Gr:
may substitute for element AbstractResponse
Defined:
globally; see XML source
Used:
at 3 locations
TerminationResponseStatus (in TerminateSubscriptionResponse)
Status of each subscription termnination response.
Type:
TerminationResponseStatusStructure
Content:
complex, 7 elements
Defined:
locally within TerminationStatusGroup group; see XML source
VehicleFeatureNameSpace (in DataNameSpaces)
Name space for VEHICLE features.
Type:
xsd:anyURI
Content:
simple
Defined:
locally within DataNameSpacesStructure complexType; see XML source
VelocityUnits (in ServiceRequestContext)
Units for Distance Type.
Type:
xsd:normalizedString
Content:
simple
Defined:
locally within ReferenceContextGroup group; see XML source
WgsDecimalDegrees (type EmptyType)
Type:
EmptyType
Content:
simple
Defined:
locally at 2 locations
Complex Type Summary
CheckStatusRequestStructure
Type for check status request.
Content:
complex, 1 attribute, 9 elements
Defined:
globally; see XML source
Includes:
definitions of 1 attribute, 1 element
Used:
at 1 location
CheckStatusResponseBodyStructure
Type for Body of Service Status Check Response.
Content:
complex, 6 elements
Defined:
globally; see XML source
Used:
never
CheckStatusResponseStructure
Type for Service Status Check Response.
Content:
complex, 14 elements
Defined:
globally; see XML source
Includes:
definition of 1 element
Used:
at 1 location
ContextualisedRequestStructure
Type for General SIRI Request.
Content:
complex, 9 elements
Abstract:
(cannot be assigned directly to elements used in instance XML documents)
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
at 2 locations
DataNameSpacesStructure
Name spaces.
Content:
complex, 5 elements
Defined:
globally; see XML source
Includes:
definitions of 5 elements
Used:
at 1 location
DataReadyRequestStructure
Type for Request from Producer to Consumer to notify that data update is ready to fetch.
Content:
complex, 8 elements
Defined:
globally; see XML source
Used:
at 1 location
DataReadyResponseStructure
Type for Data ready Acknowledgement Response.
Content:
complex, 7 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
at 1 location
DataReceivedResponseStructure
Type for Data received Acknowledgement Response.
Content:
complex, 7 elements
Defined:
globally; see XML source
Used:
at 1 location
DataSupplyRequestBodyStructure
Type for Body of Data Supply Request.
Content:
complex, 2 elements
Defined:
globally; see XML source
Used:
never
DataSupplyRequestStructure
Type for Data supply Request.
Content:
complex, 10 elements
Defined:
globally; see XML source
Used:
at 1 location
HeartbeatNotificationStructure
Type for Service Heartbeat Notification.
Content:
complex, 15 elements
Defined:
globally; see XML source
Includes:
definition of 1 element
Used:
at 1 location
ServiceRequestContextStructure
Configurable context for requests.
Content:
complex, 22 elements
Defined:
globally; see XML source
Used:
at 1 location
StatusResponseStructure
Type for Response Status.
Content:
complex, 9 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
at 1 location
SubscriptionResponseBodyStructure
Type for Body of Subscription Response.
Content:
complex, 3 elements
Defined:
globally; see XML source
Includes:
definitions of 3 elements
Used:
never
SubscriptionResponseStructure
Type for Subscription Response.
Content:
complex, 10 elements
Defined:
globally; see XML source
Used:
at 1 location
SubscriptionTerminatedNotificationStructure
Type for Notification to terminate a subscription or subscriptions.
Content:
complex, 12 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
at 1 location
TerminateSubscriptionRequestBodyStructure
Type for Body of Terminate Subscription Request content.
Content:
complex, 3 elements
Defined:
globally; see XML source
Used:
never
TerminateSubscriptionRequestStructure
Type for request to terminate a subscription or subscriptions.
Content:
complex, 12 elements
Defined:
globally; see XML source
Includes:
definition of 1 element
Used:
at 1 location
TerminateSubscriptionResponseStructure
Type for Response to a request to terminate a subscription or subscriptions.
Content:
complex, 7 elements
Defined:
globally; see XML source
Used:
at 1 location
TerminationResponseStatusStructure
Type for Status of termination response.
Content:
complex, 7 elements
Defined:
globally; see XML source
Includes:
definitions of 3 elements
Used:
at 1 location
Simple Type Summary
DeliveryMethodEnumeration
Delivery Method: Fetched or Direct Delivery.
Defined:
globally; see XML source
Used:
at 1 location
PredictorsEnumeration
Allowed values for predictors.
Defined:
globally; see XML source
Used:
at 1 location
Element Group Summary
CheckStatusPayloadGroup
Data received AcknowledgementService Status Check Request content.
Content:
6 elements
Defined:
globally; see XML source
Includes:
definitions of 4 elements
Used:
at 3 locations
ClientEndpointAddressGroup
Address elements for SIRI messages to the Subscriber/Consumer client.
Content:
4 elements
Defined:
globally; see XML source
Includes:
definitions of 4 elements
Used:
at 1 location
DataReceivedPayloadGroup
Data received Acknowledgement content.
Content:
2 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
at 1 location
DataSupplyGroup
Groups the data supply messages.
Content:
3 elements
Defined:
globally; see XML source
Includes:
definitions of 3 elements
Used:
at 1 location
DataSupplyTopicGroup
Specifies content to be included in data supply.
Content:
2 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
at 2 locations
DeliveryContextGroup
Delivery options.
Content:
3 elements
Defined:
globally; see XML source
Includes:
definitions of 3 elements
Used:
at 1 location
DeliveryEndpointGroup
Elements identifying data Consumer, i.e. requestor, if synchronous delivery or subscriber if asynchronous.
Content:
2 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
never
DeliveryRequestGroup
General requests for fetched data delivery.
Content:
2 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
at 2 locations
PredictionMethodGroup
Prediction options.
Content:
2 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
at 1 location
ReferenceContextGroup
Namespace related elements in Request Context.
Content:
6 elements
Defined:
globally; see XML source
Includes:
definitions of 6 elements
Used:
at 1 location
ResourceContextGroup
Resources related elements in Request Context.
Content:
1 element
Defined:
globally; see XML source
Includes:
definition of 1 element
Used:
at 1 location
ServiceEndpointAddressGroup
Address elements for SIRI messages to the Producer server.
Content:
4 elements
Defined:
globally; see XML source
Includes:
definitions of 4 elements
Used:
at 1 location
SiriCommonIndexGroup
Convenience artefact to pick out main elements of the common requests.
Content:
9 elements
Defined:
globally; see XML source
Used:
never
StatusRequestGroup
Requests about system status.
Content:
2 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
at 3 locations
StatusResponseGroup
Responses that infrom about the service status.
Content:
1 element
Defined:
globally; see XML source
Includes:
definition of 1 element
Used:
at 3 locations
SubscriptionManagementGroup
groups the subscription request.
Content:
3 elements
Defined:
globally; see XML source
Includes:
definitions of 3 elements
Used:
at 1 location
SubscriptionResponsePayloadGroup
Subscription Response content.
Content:
4 elements
Defined:
globally; see XML source
Includes:
definitions of 4 elements
Used:
at 1 location
TemporalContextGroup
Timing related elements in Request Context:
Content:
2 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
at 1 location
TerminateSubscriptionTopicGroup
Parameters that specify the content to be processed.
Content:
3 elements
Defined:
globally; see XML source
Includes:
definitions of 3 elements
Used:
at 2 locations
TerminationStatusGroup
Status Info.
Content:
1 element
Defined:
globally; see XML source
Includes:
definition of 1 element
Used:
at 1 location
XML Source
<?xml version="1.0" encoding="UTF-8"?>
<!-- edited with XMLSpy v2011 rel. 2 sp1 (x64) (http://www.altova.com) by Christophe Duquesne (Dryade) -->
<xsd:schema attributeFormDefault="unqualified" elementFormDefault="qualified" id="siri_common_services" targetNamespace="http://www.siri.org.uk/siri" version="2.0" xmlns="http://www.siri.org.uk/siri" xmlns:acsb="http://www.ifopt.org.uk/acsb" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:annotation>
<xsd:appinfo>
<Metadata xmlns="http://www.govtalk.gov.uk/CM/gms-xs">
<Aggregation>main schema</Aggregation>
<Audience>e-service developers</Audience>
<Contributor>CEN TC278 WG3 SG7 Team</Contributor>
<Coverage>Europe</Coverage>
<Creator>
First drafted for version 1.0 CEN TC278 WG3 SG7 Editor Nicholas Knowles, Kizoom. mailto:schemer@siri.org.uk
</Creator>
<Date>
<Created>2004-09-29</Created>
</Date>
<Date>
<Modified>2005-02-14</Modified>
</Date>
<Date>
<Modified>2005-02-20</Modified>
</Date>
<Date>
<Modified>2005-05-11</Modified>
</Date>
<Date>
<Modified>2007-04-17</Modified>
- Name Space changes
</Date>
<Date>
<Modified>2008-10-09</Modified>
-- Add Subscriber ref to TermninateSubscription Request
</Date>
<Date>
<Modified>2008-11-17</Modified>
-- Revise for substitution groups and move down to siri subdirectory
</Date>
<Date>
<Modified>2012-03-23</Modified>
+SIRI v2.0
- Add DataReady to Check Status
- Add DistanceUnits and VelocityUnits to ServiceRequestContext
- [FR] Add Extensions tag to Terminate SubscriptionRequest
</Date>
<Date>
<Modified>2014-03-31</Modified>
+SIRI v2.0 Comments
- Add terminate subscription notification
</Date>
<Date>
<Modified>2014-06-23</Modified>
+SIRI v2.0 Comments
- Revise terminate subscription erroc condition to be consistent with other services
</Date>
<Description>
<p>
SIRI is a European CEN standard for the exchange of real-time information.
</p>
<p>
This subschema describes common communication requests that are the same for all services.
</p>
<p>It contains the following request</p>
<ul>
<li>GS: Terminate Subscription Resquest</li>
<li>GS: Terminate Subscription Response</li>
<li>GS: Subscription Response</li>
<li>GS: Data Ready Notification</li>
<li>GS: Data Ready Acknowledgement</li>
<li>GS: Data Supply Request</li>
<li>GS: Data Received Response</li>
<li>GS: Check Status Request</li>
<li>GS: Check Status Response</li>
<li>GS: Heartbeat Request</li>
</ul>
<p>
Siri supports both direct requests and publish subscribe patterns of interaction
</p>
</Description>
<Format>
<MediaType>text/xml</MediaType>
<Syntax>http://www.w3.org/2001/XMLSchema</Syntax>
<Description>XML schema, W3C Recommendation 2001</Description>
</Format>
<Identifier>
{http://www.siri.org.uk/schema/2.0/xsd/siri/}siri_common_services.xsd
</Identifier>
<Language>[ISO 639-2/B] ENG</Language>
<Publisher>Kizoom, 109-123 Clifton Street, London EC4A 4LD</Publisher>
<Relation>
<Requires>
http://www.siri.org.uk/schema/2.0/xsd/siri/siri_requests-v2.0.xsd
</Requires>
</Relation>
<Rights>
Unclassified
<Copyright>CEN, VDV, RTIG 2004-2012</Copyright>
</Rights>
<Source>
<ul>
<li>
Derived from the VDV, RTIG XML and Trident standards.
</li>
</ul>
</Source>
<Status>Version 2.0 Draft</Status>
<Subject>
<Category>
Arts, recreation and travel, Tourism, Travel (tourism), Transport,
Air transport, Airports,
Ports and maritime transport, Ferries (marine),
Public transport, Bus services, Coach services, Bus stops and stations,
Rail transport, Railway stations and track, Train services, Underground trains,
Business and industry, Transport, Air transport, Ports and maritime transport, Public transport,
Rail transport, Roads and road transport
</Category>
<Project>CEN TC278 WG3 SG7</Project>
</Subject>
<Title>
SIRI XML schema. Service Interface for Real-time Information. Common Requests
</Title>
<Type>Standard</Type>
</Metadata>
</xsd:appinfo>
<xsd:documentation>SIRI Framework - Common Requests.</xsd:documentation>
</xsd:annotation>
<!-- ======================================================================= -->
<!-- ======================================================================= -->
<xsd:include schemaLocation="siri_requests-v2.0.xsd"/>
<!-- ======================================================================= -->
<xsd:group name="SiriCommonIndexGroup">
<xsd:annotation>
<xsd:documentation>
Convenience artefact to pick out main elements of the common requests.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:group ref="SubscriptionManagementGroup"/>
<xsd:group ref="DataSupplyGroup"/>
<xsd:group ref="StatusRequestGroup"/>
<xsd:group ref="StatusResponseGroup"/>
</xsd:sequence>
</xsd:group>
<xsd:group name="StatusRequestGroup">
<xsd:annotation>
<xsd:documentation>Requests about system status.</xsd:documentation>
</xsd:annotation>
<xsd:choice>
<xsd:element ref="CheckStatusRequest"/>
<xsd:element ref="HeartbeatNotification"/>
</xsd:choice>
</xsd:group>
<!--== Requests ===================================================================== -->
<xsd:complexType abstract="true" name="ContextualisedRequestStructure">
<xsd:annotation>
<xsd:documentation>Type for General SIRI Request.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element minOccurs="0" name="ServiceRequestContext" type="ServiceRequestContextStructure">
<xsd:annotation>
<xsd:documentation>
General request properties - typically configured rather than repeated on request.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element ref="RequestTimestamp"/>
<xsd:group ref="AuthenticatedRequestGroup"/>
<xsd:group ref="RequestorEndpointGroup"/>
<xsd:group ref="DelegatorEndpointGroup"/>
</xsd:sequence>
</xsd:complexType>
<xsd:group name="ServiceEndpointAddressGroup">
<xsd:annotation>
<xsd:documentation>
Address elements for SIRI messages to the Producer server.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element minOccurs="0" name="CheckStatusAddress" type="EndpointAddress">
<xsd:annotation>
<xsd:documentation>
Address to which CheckStatus requests are to be sent.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="SubscribeAddress" type="EndpointAddress">
<xsd:annotation>
<xsd:documentation>
Address to which subscription requests are to be sent.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="ManageSubscriptionAddress" type="EndpointAddress">
<xsd:annotation>
<xsd:documentation>
Address to which subscription requests are to be sent. If absent, same as SubscribeAddress.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="GetDataAddress" type="EndpointAddress">
<xsd:annotation>
<xsd:documentation>Address to which requests are to return data.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:group>
<xsd:group name="ClientEndpointAddressGroup">
<xsd:annotation>
<xsd:documentation>
Address elements for SIRI messages to the Subscriber/Consumer client.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element minOccurs="0" name="StatusResponseAddress" type="EndpointAddress">
<xsd:annotation>
<xsd:documentation>
Address to which CheckStatus responses and heartbeats are to be sent. If absent, same as SubscriberAddress.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="SubscriberAddress" type="EndpointAddress">
<xsd:annotation>
<xsd:documentation>
Address to which subscription responses are to be sent.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="NotifyAddress" type="EndpointAddress">
<xsd:annotation>
<xsd:documentation>
Address to which notifcations requests are to be sent. If absent, same as SubscriberAddress.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="ConsumerAddress" type="EndpointAddress">
<xsd:annotation>
<xsd:documentation>
Address to which data is to be sent. If absent, same as NotifyAddress.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:group>
<xsd:complexType name="ServiceRequestContextStructure">
<xsd:annotation>
<xsd:documentation>
Configurable context for requests. Intended Primarily as a documentation mechanism.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:group ref="ServiceEndpointAddressGroup"/>
<xsd:group ref="ClientEndpointAddressGroup"/>
<xsd:group ref="ReferenceContextGroup"/>
<xsd:group ref="TemporalContextGroup"/>
<xsd:group ref="DeliveryContextGroup"/>
<xsd:group ref="ResourceContextGroup"/>
<xsd:group ref="PredictionMethodGroup"/>
</xsd:sequence>
</xsd:complexType>
<xsd:group name="DeliveryContextGroup">
<xsd:annotation>
<xsd:documentation>Delivery options.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element default="direct" minOccurs="0" name="DeliveryMethod" type="DeliveryMethodEnumeration">
<xsd:annotation>
<xsd:documentation>Whether Delivery is fetched or retrieved.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="MultipartDespatch" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>
Whether multi-part delivery is allowed, i.e. the breaking up of updates into more than one delivery messages with a MoreData flag,
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element default="false" minOccurs="0" name="ConfirmDelivery" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>
Whether Consumers should issue an acknowledgement on successful receipt of a delivery. Default is ' false'.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:group>
<xsd:simpleType name="DeliveryMethodEnumeration">
<xsd:annotation>
<xsd:documentation>Delivery Method: Fetched or Direct Delivery.</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:NMTOKEN">
<xsd:enumeration value="direct"/>
<xsd:enumeration value="fetched"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:group name="PredictionMethodGroup">
<xsd:annotation>
<xsd:documentation>Prediction options.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element default="anyone" minOccurs="0" name="AllowedPredictors" type="PredictorsEnumeration">
<xsd:annotation>
<xsd:documentation>Who may make a prediction.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="PredictionFunction" type="xsd:string">
<xsd:annotation>
<xsd:documentation>Name of prediction method used.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:group>
<xsd:simpleType name="PredictorsEnumeration">
<xsd:annotation>
<xsd:documentation>Allowed values for predictors.</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:NMTOKEN">
<xsd:enumeration value="avmsOnly"/>
<xsd:enumeration value="anyone"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:group name="TemporalContextGroup">
<xsd:annotation>
<xsd:documentation>Timing related elements in Request Context:</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element minOccurs="0" name="DataHorizon" type="PositiveDurationType">
<xsd:annotation>
<xsd:documentation>Maximum data horizon for requests.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="RequestTimeout" type="PositiveDurationType">
<xsd:annotation>
<xsd:documentation>
Timeout for requests. [Should this be separate for each type?]
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:group>
<xsd:complexType name="DataNameSpacesStructure">
<xsd:annotation>
<xsd:documentation>Name spaces.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element minOccurs="0" name="StopPointNameSpace" type="xsd:anyURI">
<xsd:annotation>
<xsd:documentation>Name space for STOP POINTs.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="LineNameSpace" type="xsd:anyURI">
<xsd:annotation>
<xsd:documentation>Name space for LINE names and DIRECTIONss.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="ProductCategoryNameSpace" type="xsd:anyURI">
<xsd:annotation>
<xsd:documentation>Name space for Product Categories.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="ServiceFeatureNameSpace" type="xsd:anyURI">
<xsd:annotation>
<xsd:documentation>Name space for service features.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="VehicleFeatureNameSpace" type="xsd:anyURI">
<xsd:annotation>
<xsd:documentation>Name space for VEHICLE features.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:group name="ReferenceContextGroup">
<xsd:annotation>
<xsd:documentation>Namespace related elements in Request Context.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element minOccurs="0" name="DataNameSpaces" type="DataNameSpacesStructure">
<xsd:annotation>
<xsd:documentation>
Default names pace used to scope data identifiers.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element default="en" minOccurs="0" name="Language" type="xsd:language">
<xsd:annotation>
<xsd:documentation>
Preferred language in which to return text values.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:choice minOccurs="0">
<xsd:annotation>
<xsd:documentation>Default geospatial Coordinates used by service.</xsd:documentation>
</xsd:annotation>
<xsd:element name="WgsDecimalDegrees" type="EmptyType">
<xsd:annotation>
<xsd:documentation>
Geospatial coordinates are given as Wgs 84 Latiude and longitude, decimial degrees of arc.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="GmlCoordinateFormat" type="SrsNameType">
<xsd:annotation>
<xsd:documentation>
Name of GML Coordinate format used for Geospatial points in responses.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:choice>
<xsd:element minOccurs="0" name="DistanceUnits" type="xsd:normalizedString">
<xsd:annotation>
<xsd:documentation>
Units for Distance Type. Default is metres. +SIRI v2.0
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="VelocityUnits" type="xsd:normalizedString">
<xsd:annotation>
<xsd:documentation>
Units for Distance Type. Default is metres per second. +SIRI v2.0
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:group>
<xsd:group name="ResourceContextGroup">
<xsd:annotation>
<xsd:documentation>Resources related elements in Request Context.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element minOccurs="0" name="MaximimumNumberOfSubscriptions" type="xsd:positiveInteger">
<xsd:annotation>
<xsd:documentation>
Maximum Number of subscriptions that can be sustained by the subscriber. If absent no limit.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:group>
<!-- ======================================================================= -->
<!--===SUBSCRIPTION MANAGEMENT ==================================================================== -->
<xsd:group name="SubscriptionManagementGroup">
<xsd:annotation>
<xsd:documentation>groups the subscription request.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element ref="SubscriptionResponse"/>
<xsd:element ref="TerminateSubscriptionRequest"/>
<xsd:element ref="TerminateSubscriptionResponse"/>
</xsd:sequence>
</xsd:group>
<!-- === GS: Terminate Subscription Resquest=================================================== -->
<xsd:annotation>
<xsd:documentation>
Request from Subscriber to Subscription Manager to terminate a subscription. Answered with a TerminateSubscriptionResponse.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:complexType name="TerminateSubscriptionRequestStructure">
<xsd:annotation>
<xsd:documentation>
Type for request to terminate a subscription or subscriptions.
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="AuthenticatedRequestStructure">
<xsd:sequence>
<xsd:group ref="RequestorEndpointGroup"/>
<xsd:group ref="DelegatorEndpointGroup">
<xsd:annotation>
<xsd:documentation>
If request has been proxied by an intermediate aggregating system , tracking information relating to the original requestor. This allows the aggregation to be stateless. +SIRI 2.0
</xsd:documentation>
</xsd:annotation>
</xsd:group>
<xsd:element minOccurs="0" ref="Extensions"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:annotation>
<xsd:documentation>
Parameters that specify the content to be processed.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element minOccurs="0" name="SubscriberRef" type="ParticipantRefStructure">
<xsd:annotation>
<xsd:documentation>
Participant identifier of Subscriber. Subscription ref will be unique within this.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:choice>
<xsd:element name="All" type="EmptyType">
<xsd:annotation>
<xsd:documentation>Terminate all subscriptions for the requestor.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="unbounded" name="SubscriptionRef" type="SubscriptionQualifierStructure">
<xsd:annotation>
<xsd:documentation>
Terminate the subscription identfiied by the reference.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:choice>
</xsd:sequence>
</xsd:group>
<xsd:group name="TerminationStatusGroup">
<xsd:annotation>
<xsd:documentation>Status Info.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="TerminationResponseStatus" type="TerminationResponseStatusStructure">
<xsd:annotation>
<xsd:documentation>
Status of each subscription termnination response.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:group>
<!-- === GS: Terminate Subscription Response======================================================== -->
<xsd:annotation>
<xsd:documentation>
Request from Subscriber to Subscription Manager to terminate a subscription. Answered with a TerminateSubscriptionResponse.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:annotation>
<xsd:documentation>
Type for Response to a request to terminate a subscription or subscriptions.
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="ResponseEndpointStructure">
<xsd:sequence>
<xsd:group ref="TerminationStatusGroup"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:complexType name="TerminationResponseStatusStructure">
<xsd:annotation>
<xsd:documentation>Type for Status of termination response.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element minOccurs="0" ref="ResponseTimestamp"/>
<xsd:group minOccurs="0" ref="SubscriptionIdentifierResourcePropertyGroup"/>
<xsd:element ref="Status"/>
<xsd:element minOccurs="0" name="ErrorCondition">
<xsd:annotation>
<xsd:documentation>Description of any error or warning condition.</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:choice>
<xsd:element ref="CapabilityNotSupportedError"/>
<xsd:element ref="UnknownSubscriberError"/>
<xsd:element ref="UnknownSubscriptionError"/>
<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>
</xsd:sequence>
</xsd:complexType>
<!-- === GS: Terminate Subscription Notification ======================================================== -->
<xsd:annotation>
<xsd:documentation>
Notification from Subscriber to Subscription Manager to terminate a subscription.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:annotation>
<xsd:documentation>
Type for Notification to terminate a subscription or subscriptions.
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="ProducerResponseStructure">
<xsd:sequence>
<xsd:group maxOccurs="unbounded" ref="SubscriptionIdentifierResourcePropertyGroup"/>
<xsd:element minOccurs="0" name="ErrrorCondition" type="ErrorConditionStructure">
<xsd:annotation>
<xsd:documentation>
Text description providing additional information about the reason for the subscription termination.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" ref="Extensions"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<!-- ===Responses==================================================================== -->
<xsd:group name="StatusResponseGroup">
<xsd:annotation>
<xsd:documentation>Responses that infrom about the service status.</xsd:documentation>
</xsd:annotation>
<xsd:choice>
<xsd:element ref="CheckStatusResponse"/>
</xsd:choice>
</xsd:group>
<xsd:complexType name="StatusResponseStructure">
<xsd:annotation>
<xsd:documentation>Type for Response Status.</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="ResponseStructure">
<xsd:sequence>
<xsd:group ref="ContextualisedResponseEndpointGroup"/>
<xsd:group minOccurs="0" ref="SubscriptionIdentifierResourcePropertyGroup"/>
<xsd:element minOccurs="0" ref="Status"/>
<xsd:element minOccurs="0" name="ErrorCondition" type="ServiceDeliveryErrorConditionStructure">
<xsd:annotation>
<xsd:documentation>Description of any error or warning condition.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:group ref="SuccessInfoGroup"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="ResponseStatus" type="StatusResponseStructure">
<xsd:annotation>
<xsd:documentation>
Contains infromation about the processing of a an individual service subscription - either success info or an error condition. (VDV Acknowledgement).
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<!-- === GS: Subscription Response======================================================== -->
<xsd:element name="SubscriptionResponse" substitutionGroup="AbstractResponse" type="SubscriptionResponseStructure">
<xsd:annotation>
<xsd:documentation>
Response from Producer to Consumer to inform whether subscriptions have been created. Answers a previous SubscriptionRequest.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:complexType name="SubscriptionResponseStructure">
<xsd:annotation>
<xsd:documentation>Type for Subscription Response.</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="ResponseEndpointStructure">
<xsd:sequence>
<xsd:group ref="SubscriptionResponsePayloadGroup"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:annotation>
<xsd:documentation>Subscription Response content.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" ref="ResponseStatus"/>
<xsd:element minOccurs="0" name="SubscriptionManagerAddress" type="EndpointAddress">
<xsd:annotation>
<xsd:documentation>
Endpoint address of subscription manager if different from that of the Producer or known default.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="ServiceStartedTime" type="xsd:dateTime">
<xsd:annotation>
<xsd:documentation>
Time at which service providing the subscription was last started. Can be used to detect restarts. If absent, unknown.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" ref="Extensions"/>
</xsd:sequence>
</xsd:group>
<!-- ===DATA DELIVERY ============================================================== -->
<xsd:group name="DeliveryRequestGroup">
<xsd:annotation>
<xsd:documentation>General requests for fetched data delivery.</xsd:documentation>
</xsd:annotation>
<xsd:choice>
<xsd:element ref="DataReadyNotification"/>
<xsd:element ref="DataSupplyRequest"/>
</xsd:choice>
</xsd:group>
<!-- === GS: Data Ready Notification======================================================== -->
<xsd:element name="DataReadyNotification" substitutionGroup="ProducerRequest" type="DataReadyRequestStructure">
<xsd:annotation>
<xsd:documentation>
Request from Producer to Consumer to notify that data update is ready to fetch. Answered with a DataReadyResponse.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:group name="DataSupplyGroup">
<xsd:annotation>
<xsd:documentation>Groups the data supply messages.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element ref="DataReadyNotification"/>
<xsd:element ref="DataSupplyRequest"/>
<xsd:element ref="DataReceivedAcknowledgement"/>
</xsd:sequence>
</xsd:group>
<xsd:complexType name="DataReadyRequestStructure">
<xsd:annotation>
<xsd:documentation>
Type for Request from Producer to Consumer to notify that data update is ready to fetch. Answered with a DataReadyResponse.
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="AbstractNotificationStructure"/>
</xsd:complexContent>
</xsd:complexType>
<!-- === GS: Data Ready Acknowledgement======================================================= -->
<xsd:element name="DataReadyAcknowledgement" substitutionGroup="AbstractResponse" type="DataReadyResponseStructure">
<xsd:annotation>
<xsd:documentation>
Response from Consumer to Producer to acknowledge to Producer that a DataReadyRequest has been received.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:complexType name="DataReadyResponseStructure">
<xsd:annotation>
<xsd:documentation>Type for Data ready Acknowledgement Response.</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="ConsumerResponseEndpointStructure">
<xsd:sequence>
<xsd:element minOccurs="0" ref="Status"/>
<xsd:element minOccurs="0" name="ErrorCondition">
<xsd:annotation>
<xsd:documentation>
Description of any error or warning condition as to why Consumer cannot fetch data.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:choice>
<xsd:element ref="UnknownSubscriptionError"/>
<xsd:element ref="OtherError"/>
</xsd:choice>
<xsd:sequence>
<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:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<!-- ======================================================================= -->
<!-- ====GS: Data Supply Request ======================================================= -->
<xsd:element name="DataSupplyRequest" substitutionGroup="AbstractRequest" type="DataSupplyRequestStructure">
<xsd:annotation>
<xsd:documentation>
Request from Consumer to Producer to fetch update previously notified by a Data ready message. Answered with a Service Delivery.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:complexType name="DataSupplyRequestStructure">
<xsd:annotation>
<xsd:documentation>Type for Data supply Request.</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="ConsumerRequestEndpointStructure">
<xsd:sequence>
<xsd:group ref="DataSupplyTopicGroup"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:group name="DataSupplyTopicGroup">
<xsd:annotation>
<xsd:documentation>Specifies content to be included in data supply.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element minOccurs="0" name="NotificationRef" type="MessageRefStructure">
<xsd:annotation>
<xsd:documentation>
Reference to a specific notification message for which data is to be fetched. Can be used to distinguish between notfcatiosn for the same service and subscriber but for different filters.If none specified,
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element default="false" minOccurs="0" name="AllData" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>
Whether to return all data, or just new updates since the last delivery. Default false, i.e. just updates.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:group>
<!-- ====GS: Data Received Response ======================================================= -->
<xsd:element name="DataReceivedAcknowledgement" substitutionGroup="AbstractResponse" type="DataReceivedResponseStructure">
<xsd:annotation>
<xsd:documentation>
Response from Consumer to Producer to acknowledge that data hase been received. Used as optioanl extra step if reliable delivery is needed. Answers a ServiceDelivery.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:group name="DataReceivedPayloadGroup">
<xsd:annotation>
<xsd:documentation>Data received Acknowledgement content.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element ref="Status"/>
<xsd:element minOccurs="0" name="ErrorCondition">
<xsd:annotation>
<xsd:documentation>Description of any error or warning condition.</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:choice>
<xsd:element ref="UnknownSubscriptionError"/>
<xsd:element ref="OtherError"/>
</xsd:choice>
<xsd:sequence>
<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:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:group>
<xsd:complexType name="DataReceivedResponseStructure">
<xsd:annotation>
<xsd:documentation>Type for Data received Acknowledgement Response.</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="ConsumerResponseEndpointStructure">
<xsd:sequence>
<xsd:group ref="DataReceivedPayloadGroup"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:group name="DeliveryEndpointGroup">
<xsd:annotation>
<xsd:documentation>
Elements identifying data Consumer, i.e. requestor, if synchronous delivery or subscriber if asynchronous.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element minOccurs="0" ref="RequestorRef"/>
<xsd:element minOccurs="0" name="MessageRef" type="MessageQualifierStructure">
<xsd:annotation>
<xsd:documentation>
Reference to an arbitrary unique reference associated with the request which gave rise to this response.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:group>
<!-- ==== GS: Check Status Request =================================================== -->
<xsd:element name="CheckStatusRequest" substitutionGroup="AbstractTrackedRequest" type="CheckStatusRequestStructure">
<xsd:annotation>
<xsd:documentation>
Request from Consumer to Producer to check whether services is working. Answers a CheckStatusRequest.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:complexType name="CheckStatusRequestStructure">
<xsd:annotation>
<xsd:documentation>Type for check status request.</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="RequestStructure">
<xsd:sequence>
<xsd:element minOccurs="0" ref="Extensions"/>
</xsd:sequence>
<xsd:attribute default="2.0" name="version" type="VersionString">
<xsd:annotation>
<xsd:documentation>
Version number of request.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:group name="CheckStatusPayloadGroup">
<xsd:annotation>
<xsd:documentation>
Data received AcknowledgementService Status Check Request content.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element minOccurs="0" ref="Status"/>
<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>
<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>
<xsd:group ref="SuccessInfoGroup"/>
<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>
</xsd:sequence>
</xsd:group>
<!-- =====GS: Check Status Request ============================================= -->
<xsd:element name="CheckStatusResponse" substitutionGroup="AbstractResponse" type="CheckStatusResponseStructure">
<xsd:annotation>
<xsd:documentation>
Response from Producer to Consumer to inform whether services is working. Answers a CheckStatusRequest.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:complexType name="CheckStatusResponseStructure">
<xsd:annotation>
<xsd:documentation>Type for Service Status Check Response.</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="ResponseStructure">
<xsd:sequence>
<xsd:group ref="ProducerResponseEndpointGroup"/>
<xsd:group ref="DelegatorEndpointGroup"/>
<xsd:group ref="CheckStatusPayloadGroup"/>
<xsd:element minOccurs="0" ref="Extensions"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<!-- ==== GS: Heartbeat Response ================================================ -->
<xsd:element name="HeartbeatNotification" substitutionGroup="ProducerRequest" type="HeartbeatNotificationStructure">
<xsd:annotation>
<xsd:documentation>
Notification from Producer to Consumer to indicate that the service is running normally.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<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>
<!-- ======================================================================= -->
<!-- ===WSDL=============================================================== -->
<xsd:complexType name="SubscriptionResponseBodyStructure">
<xsd:annotation>
<xsd:documentation>
Type for Body of Subscription Response. Used in WSDL.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" ref="ResponseStatus"/>
<xsd:element minOccurs="0" name="SubscriptionManagerAddress" type="EndpointAddress">
<xsd:annotation>
<xsd:documentation>
Endpoint address of subscription manager if different from that of the Producer or known default.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="ServiceStartedTime" type="xsd:dateTime">
<xsd:annotation>
<xsd:documentation>
Time at which service providing the subscription was last started. Can be used to detect restarts. If absent, unknown.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:annotation>
<xsd:documentation>
Type for Body of Terminate Subscription Request content. Used in WSDL.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:group ref="TerminateSubscriptionTopicGroup"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="DataSupplyRequestBodyStructure">
<xsd:annotation>
<xsd:documentation>
Type for Body of Data Supply Request. Used in WSDL.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:group ref="DataSupplyTopicGroup"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="CheckStatusResponseBodyStructure">
<xsd:annotation>
<xsd:documentation>
Type for Body of Service Status Check Response. Used in WSDL.
</xsd:documentation>
<xsd:documentation>
Same as CheckStatusResponseStructure, but without extension to be consistent with the other operation definition.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:group ref="CheckStatusPayloadGroup"/>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>
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/