XML Schema "hsinfra.xsd"
Target Namespace:
http://schemas.microsoft.com/hs/2001/10/core
Version:
1.0
Defined Components:
elements (6 global + 33 local), complexTypes (17), simpleTypes (1)
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\Projects\Microsoft Hailstorm\xsd\hsinfra.xsd; see XML source
Included in Schemas (1):
hscommon.xsd [src]
Annotation
Schema for .NET My Services Infrastructure types including security related types, system document, message headers, etc. Copyright (c) 2001 Microsoft Corporation. All rights reserved.
All Element Summary
authorizedRole
Type:
authorizedRoleType
Content:
simple
Defined:
globally; see XML source
Used:
never
buildDate (in systemVersion)
This element defines the date and time that the .NET My Services system was built.
Type:
xsd:dateTime
Content:
simple
Defined:
locally within systemVersionType complexType; see XML source
buildDetails (in systemVersion)
Type:
anonymous complexType
Content:
empty, 4 attributes
Defined:
locally within systemVersionType complexType; see XML source
Includes:
definitions of 4 attributes
cat (type catType)
Type:
catType
Content:
empty, 1 attribute
Defined:
locally at 5 locations
code (in fault)
This element contains the hexadecimal error code for this fault entry in the fault chain.
Type:
xsd:string
Content:
simple
Defined:
locally within faultChainFaultType complexType; see XML source
disco (in wsdlMap)
This element is used to specify the location of a DISCO file for this service.
Type:
anonymous complexType
Content:
complex, 1 attribute, elem. wildcard
Defined:
locally within wsdlMapType complexType; see XML source
Includes:
definitions of 1 attribute, elem. wildcard
echoBack
Type:
echoBackType
Content:
complex, elem. wildcard
Defined:
globally; see XML source
Used:
never
expiresAt (type xsd:dateTime)
Type:
xsd:dateTime
Content:
simple
Defined:
locally at 2 locations
fault (in faultChain)
Type:
faultChainFaultType
Content:
complex, 3 elements
Defined:
locally within faultChainType complexType; see XML source
faultChain (type faultChainType)
When a request is being processed by a service, it may be traveling through multiple sections of the service code.
Type:
faultChainType
Content:
complex, 1 element
Defined:
locally within faultDetailType complexType; see XML source
faultResponseAction (type xsd:string)
This is the response action that is to be taken by the client upon receiving this fault message.
Type:
xsd:string
Content:
simple
Defined:
locally within faultDetailType complexType; see XML source
fullDescription (in roleTemplate)
This element contains a description of this roleTemplate that specifies the capabilities a caller will have when accessing information through this role.
Type:
localizableString
Content:
simple, 2 attributes
Defined:
locally within roleTemplate element; see XML source
identity
Type:
identityType
Content:
complex, 1 element
Defined:
globally; see XML source
Used:
never
kerberos (in identity)
This element specifies the identity of the sender of the message in the form of a Kerberos AP request: {servicePrincipalName, [{Uk, Kx3, {A/Y, g}}Kh ]Kp , {T}Kx3, otherKerberosStuff } which is easily transformed into: userId The user on whose behalf this message is being sent.
Type:
xsd:int
Content:
simple
Defined:
locally within identityType complexType; see XML source
key (in request)
This element specifies key information used to zoom in on the document being manipulated.
Type:
anonymous complexType
Content:
empty, 3 attributes
Defined:
locally within requestType complexType; see XML source
Includes:
definitions of 3 attributes
longDescription (in fault)
This element contains the long and context-sensitive description for this fault entry in the fault chain.
Type:
xsd:string
Content:
simple
Defined:
locally within faultChainFaultType complexType; see XML source
method (in methodMap)
Type:
anonymous complexType
Content:
complex, 1 attribute, elem. wildcard
Defined:
locally within methodMapType complexType; see XML source
Includes:
definitions of 1 attribute, elem. wildcard
method (in roleTemplate)
This element specifies the methods available within this roleTemplate by name and by scope.
Type:
anonymous complexType
Content:
empty, 2 attributes
Defined:
locally within roleTemplate element; see XML source
Includes:
definitions of 2 attributes
methodMap (type methodMapType)
Type:
methodMapType
Content:
complex, 3 attributes, 1 element
Defined:
locally within systemBaseType complexType; see XML source
notes (in role)
This element specifies optional notes that may be used to specify the reasoning behind adding this role to the roleList.
Type:
localizableString
Content:
simple, 2 attributes
Defined:
locally within roleType complexType; see XML source
productImplementationName (in version)
This element defines the class of the service to differentiate between different implementations.
Type:
xsd:anyURI
Content:
simple
Defined:
locally within version element; see XML source
productReleaseName (in version)
This element defines the major product release string (for example, ".NET My Services Beta 1".)
Type:
xsd:string
Content:
simple
Defined:
locally within version element; see XML source
request
Type:
requestType
Content:
complex, 4 attributes, 1 element
Defined:
globally; see XML source
Used:
never
response
Type:
responseType
Content:
empty, 1 attribute
Defined:
globally; see XML source
Used:
never
role (type roleType)
Type:
roleType
Content:
complex, 5 attributes, 4 elements, elem. wildcard
Defined:
locally within roleListType complexType; see XML source
roleMap
Type:
roleMapType
Content:
complex, 3 attributes, 2 elements
Defined:
globally; see XML source
Used:
never
roleMap (type roleMapType)
Type:
roleMapType
Content:
complex, 3 attributes, 2 elements
Defined:
locally within systemBaseType complexType; see XML source
roleTemplate (defined in roleMapType complexType)
This element encapsulates the definition of a role.
Type:
anonymous complexType
Content:
complex, 1 attribute, 2 elements
Defined:
locally within roleMapType complexType; see XML source
Includes:
definitions of 1 attribute, 2 elements
schema (in schemaMap)
Type:
anonymous complexType
Content:
complex, 3 attributes, elem. wildcard
Defined:
locally within schemaMapType complexType; see XML source
Includes:
definitions of 3 attributes, elem. wildcard
schemaMap (type schemaMapType)
Type:
schemaMapType
Content:
complex, 3 attributes, 1 element
Defined:
locally within systemBaseType complexType; see XML source
scope (defined in roleMapType complexType)
This element defines a scope which may be referred to by roles within this roleMap to indicate what portions of the document are visible to this role for the specified method.
Type:
anonymous complexType (extension of scopeType)
Content:
complex, 1 attribute, 2 elements
Defined:
locally within roleMapType complexType; see XML source
Includes:
definition of 1 attribute
scope (type roleListScopeType)
Type:
roleListScopeType
Content:
complex, 3 attributes, 2 elements
Defined:
locally within roleListType complexType; see XML source
shortDescription (in fault)
This element contains the short description for this fault entry in the fault chain.
Type:
xsd:string
Content:
simple
Defined:
locally within faultChainFaultType complexType; see XML source
subject (in role)
Type:
subjectType
Content:
empty, 3 attributes
Defined:
locally within roleType complexType; see XML source
systemVersion (type systemVersionType)
Type:
systemVersionType
Content:
complex, 3 attributes, 3 elements
Defined:
locally within systemBaseType complexType; see XML source
version (in systemVersion)
Type:
anonymous complexType
Content:
complex, 4 attributes, 2 elements
Defined:
locally within systemVersionType complexType; see XML source
Includes:
definitions of 4 attributes, 2 elements
wsdl (in wsdlMap)
This element is used to specify the location of a WSDL file for this service.
Type:
anonymous complexType
Content:
complex, 1 attribute, elem. wildcard
Defined:
locally within wsdlMapType complexType; see XML source
Includes:
definitions of 1 attribute, elem. wildcard
wsdlMap (type wsdlMapType)
Type:
wsdlMapType
Content:
complex, 3 attributes, 3 elements
Defined:
locally within systemBaseType complexType; see XML source
wsil (in wsdlMap)
This element is used to specify the location of a WSIL file for this service.
Type:
anonymous complexType
Content:
complex, 1 attribute, elem. wildcard
Defined:
locally within wsdlMapType complexType; see XML source
Includes:
definitions of 1 attribute, elem. wildcard
Complex Type Summary
echoBackType
The echoBack header is a header element that applications can use to pass additional correlation data or out-of-band data between the request and the response recipients.
Content:
complex, elem. wildcard
Defined:
globally; see XML source
Includes:
definition of elem. wildcard
Used:
at 1 location
faultChainFaultType
This element provides details about a failure condition that was encountered during the processing of a .NET My Services message.
Content:
complex, 3 elements
Defined:
globally; see XML source
Includes:
definitions of 3 elements
Used:
at 1 location
faultChainType
Content:
complex, 1 element
Defined:
globally; see XML source
Includes:
definition of 1 element
Used:
at 1 location
faultDetailType
Content:
complex, 2 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
never
identityType
This element is a SOAP-SEC compliant license that identifies the sender of this message to the recipient.
Content:
complex, 1 element
Defined:
globally; see XML source
Includes:
definition of 1 element
Used:
at 1 location
methodMapType
This element defines the methodMap.
Content:
complex, 3 attributes, 1 element
Defined:
globally; see XML source
Includes:
definition of 1 element
Used:
at 1 location
requestType
The request header is used to specify request-specific arguments including the service being addressed, the method being accessed, the document being manipulated, how the response should be processed, and key information used to locate the document (including the PUID that owns the document, the document instance, and the cluster).
Content:
complex, 4 attributes, 1 element
Defined:
globally; see XML source
Includes:
definitions of 4 attributes, 1 element
Used:
at 1 location
responseType
This element contains information related to the response message.
Content:
empty, 1 attribute
Defined:
globally; see XML source
Includes:
definition of 1 attribute
Used:
at 1 location
roleListScopeType
Content:
complex, 3 attributes, 2 elements
Defined:
globally; see XML source
Used:
at 1 location
roleListType
This element encapsulates a roleList for the identity.
Content:
complex, 2 attributes, 2 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
never
roleMapType
This element encapsulates all the elements that make up a roleMap, which include document class relative roleTemplate, priority, name, method, and per-method scope.
Content:
complex, 3 attributes, 2 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
at 2 locations
roleType
This type defines a role record that defines a matching subject, an optional scope reference, the roleTemplate for this entry, and some maintenance information.
Content:
complex, 5 attributes, 4 elements, elem. wildcard
Defined:
globally; see XML source
Includes:
definitions of 2 attributes, 4 elements, elem. wildcard
Used:
at 1 location
schemaMapType
This element defines the various schemas that define the data structures and shape of information managed by this service.
Content:
complex, 3 attributes, 1 element
Defined:
globally; see XML source
Includes:
definition of 1 element
Used:
at 1 location
subjectType
This element encapsulates a subject that includes a userId, and a combined application and platformId.
Content:
empty, 3 attributes
Defined:
globally; see XML source
Includes:
definitions of 3 attributes
Used:
at 1 location
systemBaseType
Content:
complex, 5 elements
Defined:
globally; see XML source
Includes:
definitions of 5 elements
Used:
never
systemVersionType
This element defines version information describing this instance of the .NET service.
Content:
complex, 3 attributes, 3 elements
Defined:
globally; see XML source
Includes:
definitions of 3 elements
Used:
at 1 location
wsdlMapType
This element defines the wsdlMap for this service.
Content:
complex, 3 attributes, 3 elements
Defined:
globally; see XML source
Includes:
definitions of 3 elements
Used:
at 1 location
Simple Type Summary
authorizedRoleType
This element is a SOAP-SEC compliant license that does two things: When presented to a .NET service in a SOAP-SEC licenses tag during a .NET My Services request message, it specifies to the .NET service the authorized role of the sender of the message.
Defined:
globally; see XML source
Used:
at 1 location
XML Source
<xsd:schema elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/hs/2001/10/core" version="1.0" xmlns="http://schemas.microsoft.com/hs/2001/10/core" xmlns:xdb="urn:schemas-microsoft-com:xdb" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:annotation>
<xsd:documentation>
Schema for .NET My Services Infrastructure types including security related types,
system document, message headers, etc.
Copyright (c) 2001 Microsoft Corporation. All rights reserved.
</xsd:documentation>
<xsd:appinfo>
<xdb:namespaceMap>
<xdb:mapping alias="hs" uri="http://schemas.microsoft.com/hs/2001/10/core"/>
</xdb:namespaceMap>
</xsd:appinfo>
</xsd:annotation>
<!--
//
// subject
//
-->
<xsd:complexType name="subjectType">
<xsd:annotation>
<xsd:documentation>
This element encapsulates a subject that includes
a
<b>userId</b>
, and a combined application and
<b>platformId</b>
. The subject element
is matched against the incoming message to determine which role,
if any, is to be used to authorize and scope continued message processing. The
match algorithm is very simple. The
<b>userId</b>
in the message chooses the set of matching
subjects. Once this set of subjects is identified, a test for subjects containing
<b>credType</b>
attributes is done relative to the
<b>credType</b>
passed in the license. Matching subject
entries remain. If no subjects match, all subjects containing
<b>credType</b>
are discarded;
only those subjects that do not contain
<b>credType</b>
are kept. Then the combined platform ID and
application ID select a matching subject. Matching subject
entries remain. If no subjects match, all subjects containing
<b>appAndPlatformId</b>
attributes are
discarded; only those subjects that do not contain this attribute are kept. These remaining subjects
are considered to represent the set of possible roles to be used for the request. The referenced
<b>roleDefinitions</b>
are extracted from the
<b>roleMap</b>
and sorted; only the highest priority
<b>roleDefinition</b>
is kept.
</xsd:documentation>
</xsd:annotation>
<!--
//
// userId
//
-->
<xsd:attribute name="userId" type="puidType" use="required">
<xsd:annotation>
<xsd:documentation>
This ID represents an authenticated
<b>userId</b>
. It must always be specified.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<!--
//
// credType
//
-->
<xsd:attribute name="credType" type="string" use="optional">
<xsd:annotation>
<xsd:documentation>
This optional attribute
specifies a credential type value which represents the type of credential used
to authenticate the
<b>userId</b>
. During a match operation, this value may be used
to further qualify the set of subjects that match in the
<b>userId</b>
dimension.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<!--
//
// appAndPlatformId
//
-->
<xsd:attribute name="appAndPlatformId" type="puidType" use="optional">
<xsd:annotation>
<xsd:documentation>
This optional attribute specifies the authenticated ID of an application-platform
combination. For example, the PUID of calendar@microsoft.com represents the calendar application
at Microsoft. The PUID of office@windows represents the Office application running on the
Microsoft&#174; Windows&#174; platform.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
<!--
//
// role
//
-->
<xsd:complexType name="roleType">
<xsd:annotation>
<xsd:documentation>
This type defines a role record that defines a matching subject,
an optional scope reference, the roleTemplate for this entry, and some maintenance information.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:any maxOccurs="unbounded" minOccurs="0" namespace="##other" processContents="skip"/>
<!--
//
// categories this role belongs to
//
-->
<xsd:element maxOccurs="unbounded" minOccurs="0" name="cat" type="catType"/>
<!--
//
// notes
//
-->
<xsd:element maxOccurs="unbounded" minOccurs="0" name="notes" type="localizableString">
<xsd:annotation>
<xsd:documentation>
This element specifies optional notes that may be used to specify the reasoning
behind adding this role to the
<b>roleList</b>
.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<!--
//
// the subject of role
//
-->
<xsd:element maxOccurs="1" minOccurs="1" name="subject" type="subjectType"/>
<!--
//
// when the role is considerd no longer valid
//
-->
<xsd:element minOccurs="0" name="expiresAt" type="xsd:dateTime">
<xsd:annotation>
<xsd:documentation>
This optional element specifies a time after which the
subject entry is no longer considered valid for matching
purposes. If this element is missing, the subject entry
does not expire.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<!--
//
// the scopeRef for this role
//
-->
<xsd:attribute name="scopeRef" type="idRefType">
<xsd:annotation>
<xsd:documentation>
This attribute specifies the scope within this document
that is in effect for this matching
<b>authorizationEntry</b>
.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<!--
//
// the roleTemplate for this role
//
-->
<xsd:attribute name="roleTemplateRef" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
This item specifies the name of the
<b>roleTemplate</b>
in the service's roleMap
to which this role is bound.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attributeGroup ref="standardBlueAttributeGroup"/>
</xsd:complexType>
<!--
//
// roleList
//
-->
<xsd:complexType name="roleListType">
<xsd:annotation>
<xsd:documentation>
This element encapsulates a
<b>roleList</b>
for the identity. This is
a first-class root document type that specifies the sharing allowed
over the content document.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<!--
//
// scope
//
-->
<xsd:element maxOccurs="unbounded" minOccurs="0" name="scope" type="roleListScopeType"/>
<!--
//
// role entries
//
-->
<xsd:element maxOccurs="unbounded" minOccurs="0" name="role" type="roleType"/>
</xsd:sequence>
<xsd:attributeGroup ref="documentRootAttributeGroup"/>
</xsd:complexType>
<!--
//
// roleListScopeType
//
-->
<xsd:complexType name="roleListScopeType">
<xsd:complexContent>
<xsd:extension base="scopeType">
<xsd:attributeGroup ref="standardBlueAttributeGroup"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<!--
//
// roleMap element
//
-->
<xsd:element name="roleMap" type="roleMapType"/>
<!--
//
// roleMapType
//
-->
<xsd:complexType name="roleMapType">
<xsd:annotation>
<xsd:documentation>
This element encapsulates all the elements that make up a
<b>roleMap</b>
, which
include document class relative
<b>roleTemplate</b>
, priority, name, method, and per-method scope.
An individual
<b>roleTemplate</b>
defines the maximum scope of information and the methods
allowed to access that information for each request mapped into the template.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="scope">
<xsd:annotation>
<xsd:documentation>
This element defines a scope which may be referred to by roles within this
<b>roleMap</b>
to indicate what portions of the document are visible to this role for
the specified method.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base="scopeType">
<xsd:attribute name="id" type="idType"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="roleTemplate">
<xsd:annotation>
<xsd:documentation>
This element encapsulates the definition of a role. The attribute set for
this element includes the document class that this
<b>roleTemplate</b>
refers to,
the name of the
<b>roleTemplate</b>
, and the priority of the
<b>roleTemplate</b>
.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="fullDescription" type="localizableString">
<xsd:annotation>
<xsd:documentation>
This element contains a description of this
<b>roleTemplate</b>
that specifies the capabilities a caller will have
when accessing information through this role.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="method">
<xsd:annotation>
<xsd:documentation>
This element specifies the methods available within this
<b>roleTemplate</b>
by name
and by scope. When a subject maps to a
<b>roleTemplate</b>
, the method
in the request must match one of these elements for the message to continue
to flow. If the method exists, the data available to the method is a function
of the scope referenced by this method, combined with an optional
scope referenced by the role defined in the
<b>roleList</b>
.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="name" type="string" use="required">
<xsd:annotation>
<xsd:documentation>
This element specifies the name of the method.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="scopeRef" type="idRefType" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute specifies the scope within this document
that is in effect for this method.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="name" type="string" use="required">
<xsd:annotation>
<xsd:documentation>
This element specifies the name of the role.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<!--
<xsd:attribute
name="priority"
type="xsd:int"
use="required"
>
<xsd:annotation>
<xsd:documentation>
This element specifies the priority of the <b>roleTemplate</b> used to select that
actual <b>roleTemplate</b> when the role evaluation determines that the subject maps to multiple
<b>roleTemplates</b>.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
-->
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attributeGroup ref="standardBlueAttributeGroup"/>
</xsd:complexType>
<!--
//
// Message Types
//
-->
<!--
//
// identity element. //sgfix: this is necessary for our wsdls
//
-->
<xsd:element name="identity" type="identityType"/>
<!--
//
// identity license
//
-->
<xsd:complexType name="identityType">
<xsd:annotation>
<xsd:documentation>
This element is a SOAP-SEC compliant license that identifies the
sender of this message to the recipient. The contents are
encoded and encrypted using algorithms demonstrated and documented in
the .NET My Services client access runtime. This license includes
all elements needed to identify the sender of
the .NET My Services message. An identity license must be present in all .NET
service requests and is always contained within a SOAP-SEC licenses tag.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<!-- sgfix: made type an int until we turn on crypto -->
<xsd:element name="kerberos" type="xsd:int">
<xsd:annotation>
<xsd:documentation>
This element specifies the identity of the sender of the message in the form
of a Kerberos AP request:
<br/>
<br/>
<b>
{servicePrincipalName, [{Uk, Kx3, {A/Y, g}}Kh ]Kp , {T}Kx3, otherKerberosStuff }
</b>
<br/>
<br/>
which is easily transformed into:
<dl>
<dt>
<b>userId</b>
</dt>
<dd>
The user on whose behalf this message is being sent. The user can be
an actual user, or an identity representing an arbitrary user account.
This value is extractable as a Passport Unique ID (PUID).
</dd>
<dt>
<b>appAndPlatformId</b>
</dt>
<dd>
The PUID that represents the licenses granted to an application, and a platform
on which the application runs.
</dd>
</dl>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<!--
//
// authorizedRole element
//
-->
<xsd:element name="authorizedRole" type="authorizedRoleType"/>
<!--
//
// authorizedRole license
//
-->
<xsd:simpleType name="authorizedRoleType">
<xsd:annotation>
<xsd:documentation>
This element is a SOAP-SEC compliant license that does two things:
<ul>
<li>
When presented to a .NET service in a SOAP-SEC licenses tag during
a .NET My Services request message,
it specifies to the .NET service the authorized role of the sender
of the message. The .NET service is free to accept this license when
it regards the license as valid. If .NET My Services does not regard the license as valid,
it is free to ignore the license, perform its own role evaluation, and possibly
issue a new license in a response header.
<p/>
.NET services are the grantors of this
type of license and the content is totally opaque to the sender.
</li>
<li>
When this license appears in a SOAP-SEC licenses tag during a .NET My Services
response message, this license is considered issued to the recipient
for an undetermined amount of time. On a subsequent request, this license may be
presented and may allow accelerated processing of the request.
</li>
</ul>
</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string"/>
</xsd:simpleType>
<!--
//
// request element //sgfix: necessary for our wsdls
//
-->
<xsd:element name="request" type="requestType"/>
<!--
//
// request
//
-->
<xsd:complexType name="requestType">
<xsd:annotation>
<xsd:documentation>
The request header is used to specify request-specific arguments including the service being addressed,
the method being accessed, the document
being manipulated, how the response should be processed, and key information used to locate the document (including
the PUID that owns the document, the document instance, and the cluster). The request header must occur in each
request message.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="100" minOccurs="1" name="key">
<xsd:annotation>
<xsd:documentation>
This element specifies key information used to zoom in on the document being manipulated.
This information includes the PUID that owns the document, the instance ID of the document,
and the cluster or partition key used to locate the machine resources that hold the document.
<p/>
In certain situations, a client will want to send the same message to a number a instances of a particular
service. To do this, the client can repeat this element multiple times. The
<b>cluster</b>
attributes in all elements must match each other, but the
<b>puid</b>
and
<b>instance</b>
attributes may differ. A
unique response message is generated for each key specified.
<p/>
The entire contents of this element come from the .NET Services service.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="puid" type="puidType" use="required">
<xsd:annotation>
<xsd:documentation>
This element specifies the PUID of the entity that "owns" the service being accessed.
<!-- In
the case of a .NET Address service, this element is equivalent to the "my".-->
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="instance" type="string" use="required">
<xsd:annotation>
<xsd:documentation>
This element specifies the particular instance of the service for the ID being accessed.
For example, if a given ID is provisioned with multiple .NET Calendar documents on the same
cluster and in the same data center, the documents would differ only by this value.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="cluster" type="string" use="required">
<xsd:annotation>
<xsd:documentation>
This element specifies information used by the .NET My Services system to locate the document on
a particular back-end server or database. It is used as the virtual partition key for the
document being addressed. This technique is preferable to computing this partition key based
on some hash of the
<b>puid</b>
/
<b>instance</b>
.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="service" type="string" use="required">
<xsd:annotation>
<xsd:documentation>
This element contains the name of the service being accessed by this request message. For example,
to access the .NET Profile service, this attribute will have the value "myProfile".
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="document" use="required">
<xsd:annotation>
<xsd:documentation>
This element specifies the document class being accessed by this message. Valid values include:
<ul>
<li>content: the main content document</li>
<li>roleList: the authorization list document</li>
<li>system: the global system document</li>
<li>policy: TBD</li>
</ul>
</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="content"/>
<xsd:enumeration value="roleList"/>
<xsd:enumeration value="policy"/>
<xsd:enumeration value="system"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="method" type="string" use="required">
<xsd:annotation>
<xsd:documentation>
This element specifies the method being accessed within the service. For example, to
access one of the standard methods, valid values would include:
<ul>
<li>insertRequest</li>
<li>deleteRequest</li>
<li>replaceRequest</li>
<li>updateRequest</li>
<li>queryRequest</li>
</ul>
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="genResponse" use="required">
<xsd:annotation>
<xsd:documentation>
This element, coupled with
<b>rev</b>
/
<b>via</b>
, controls how a response to this request is generated
and delivered. Valid values include:
<dl>
<dt>
<b>always</b>
</dt>
<dd>
Always generate a response message and deliver to
<b>rev</b>
/
<b>via</b>
.
</dd>
<dt>
<b>never</b>
</dt>
<dd>
Never generate a response message.
</dd>
<dt>
<b>faultOnly</b>
</dt>
<dd>
Generate a response message, but only if the request message results in
a fault message.
</dd>
</dl>
</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="always"/>
<xsd:enumeration value="never"/>
<xsd:enumeration value="faultOnly"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
</xsd:complexType>
<!--
//
// response element //sgfix: required for our wsdls
//
-->
<xsd:element name="response" type="responseType"/>
<!--
//
// response
//
-->
<xsd:complexType name="responseType">
<xsd:annotation>
<xsd:documentation>
This element contains information related to the response message.
In current implementations, this information is limited to the role
that was computed for the sender, assuming the original request was formed
well enough to progress this far through the .NET My Services message-processing system.
This header element must be present in all response messages.
</xsd:documentation>
</xsd:annotation>
<xsd:attribute name="role" type="string" use="optional">
<xsd:annotation>
<xsd:documentation>
This optional attribute contains the role
that was computed for the sender. If the original request message was malformed
and did not make it far enough through the message processor to compute
a value for this element, the
<b>role</b>
attribute will be missing from the response header.
This situation typically occurs whenever the identity header is so malformed that the
basic set of sender identity PUIDs cannot be extracted from the service ticket.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
<!--
//
// echoBack element //sgfix: required for our wsdls
//
-->
<xsd:element name="echoBack" type="echoBackType"/>
<!--
//
// echoBack
//
-->
<xsd:complexType name="echoBackType">
<xsd:annotation>
<xsd:documentation>
The
<b>echoBack</b>
header is a header element that applications can use to pass additional correlation
data or out-of-band data between the request and the response recipients. It is considered bad form
to use this header during synchronous, piggy-backed responses (because in that situation, the call
stack should be all that is required to keep sufficient context), or during cases where responses
are not generated or are only generated during fault conditions. If the UUIDs in the
<b>path</b>
/
<b>id</b>
and
<b>path</b>
/
<b>relatesTo</b>
are insufficient to provide correlation data, the
<b>echoBack</b>
header can be
used to pass arbitrarily structured XML between the service requester and the recipient of the
associated .NET My Services response.
<p/>
.NET services make no attempt to process or inspect the contents of this header. They simply
transmit the header from the request message to the response message and treat it as an opaque body
of XML.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:any maxOccurs="unbounded" minOccurs="0" namespace="##other" processContents="skip"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="systemBaseType">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="systemVersion" type="systemVersionType"/>
<xsd:element maxOccurs="1" minOccurs="1" name="roleMap" type="roleMapType"/>
<xsd:element maxOccurs="1" minOccurs="1" name="methodMap" type="methodMapType"/>
<xsd:element maxOccurs="1" minOccurs="1" name="schemaMap" type="schemaMapType"/>
<xsd:element maxOccurs="1" minOccurs="1" name="wsdlMap" type="wsdlMapType"/>
<!--xsd:element
name="basicInformation"
type="basicInformationType"
minOccurs="1"
maxOccurs="1"
/-->
</xsd:sequence>
</xsd:complexType>
<!--
//
// systemVersionType
//
//
-->
<xsd:complexType name="systemVersionType">
<xsd:annotation>
<xsd:documentation>
This element defines version information describing this instance of the
.NET service.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<!--
//
// version tag
//
-->
<xsd:element maxOccurs="1" minOccurs="1" name="version">
<xsd:complexType>
<xsd:annotation>
<xsd:documentation>
This element defines major, minor, and build number version information.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="productReleaseName" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
This element defines the major product release string (for example, ".NET My Services Beta 1".)
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="1" name="productImplementationName" type="xsd:anyURI">
<xsd:annotation>
<xsd:documentation>
This element defines the class of the service to differentiate between
different implementations.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="majorVersion" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute specifies the major version number
of the .NET service.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="minorVersion" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute specifies the minor version number
of the .NET service.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="buildNumber" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute specifies the build number
of the .NET service.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="qfe" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute specifies the quick-fix engineering (QFE)
version number of the .NET service.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="1" name="buildDate" type="xsd:dateTime">
<xsd:annotation>
<xsd:documentation>
This element defines the date and time that the .NET My Services system was built.
The time is always in UTC (Z-relative) form.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="1" name="buildDetails">
<xsd:complexType>
<xsd:annotation>
<xsd:documentation>
This element defines details of the build, including
the machine that generated the build, the branch ID of the
software that contributed to the build, the type of build (
<b>chk</b>
/
<b>fre</b>
),
and whether the build was generated by an official build-release process.
</xsd:documentation>
</xsd:annotation>
<xsd:attribute name="machine" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute specifies the machine that generated
the build.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="branch" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute specifies the software branch ID for the source
code that contributed to this build.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="type" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute specifies the type of build. A value of
<b>chk</b>
indicates
that this is a checked or debug build. A value of
<b>fre</b>
indicates
that this is a retail build.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="official" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute indicates whether the build was produced
by an official build process (value of
<b>yes</b>
), or an
unofficial process (value of
<b>no</b>
).
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attributeGroup ref="standardBlueAttributeGroup"/>
</xsd:complexType>
<!--
//
// methodMapType
//
//
-->
<xsd:complexType name="methodMapType">
<xsd:annotation>
<xsd:documentation>
This element defines the
<b>methodMap</b>
. While it is true that, in most cases, the
<b>roleMap</b>
section contains a definitive list of methods, these methods are
likely to be scattered about the roleMap in various templates. This section
contains the definitive, non-duplicated list of methods available within the service.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="method">
<xsd:complexType>
<xsd:annotation>
<xsd:documentation>
This element defines a method that is available within this service.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:any maxOccurs="unbounded" minOccurs="0" namespace="##other" processContents="skip"/>
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute specifies the name of a method available within this service.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attributeGroup ref="standardBlueAttributeGroup"/>
</xsd:complexType>
<!--
//
// schemaMapType
//
// - schema (namespace, location, alias)
//
-->
<xsd:complexType name="schemaMapType">
<xsd:annotation>
<xsd:documentation>
This element defines the various schemas that define the data structures and shape
of information managed by this service. Each schema is defined by its namespace URI,
its location, and a preferred namespace alias.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="schema">
<xsd:complexType>
<xsd:annotation>
<xsd:documentation>
This element defines a schema that defines data structures and the
shape of information managed by this service. Multiple schema elements
exist for each service, one for each logical grouping of information exposed
by the service.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:any maxOccurs="unbounded" minOccurs="0" namespace="##other" processContents="skip"/>
</xsd:sequence>
<xsd:attribute name="namespace" type="xsd:anyURI" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute specifies the namespace URI of this schema.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="schemaLocation" type="xsd:anyURI" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute specifies the location (in the form of a URI) of the resource containing the schema. When
a schema is reachable through a variety of URIs, one schema element will exist for
each location.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="alias" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute specifies the preferred alias to be used, if possible, when
manipulating information covered by this schema in the context of this service.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attributeGroup ref="standardBlueAttributeGroup"/>
</xsd:complexType>
<!--
//
// wsdlMapType
//
// - wsdl (wsdlLocation)
// - disco (discoLocation)
// - wisl (wislLocation)
//
-->
<xsd:complexType name="wsdlMapType">
<xsd:annotation>
<xsd:documentation>
This element defines the
<b>wsdlMap</b>
for this service. This map includes
the location of WSDL documents, DISCO documents, and WSIL documents
for this Web service. These documents are used by applications to
understand the format of messages that may be sent to the various
services.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="wsdl">
<xsd:annotation>
<xsd:documentation>
This element is used to specify the location of a WSDL file for this service. Multiple
entries may exist pointing to the same file hosted in multiple locations, or to variations
on the content within the WSDL files.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:any maxOccurs="unbounded" minOccurs="0" namespace="##other" processContents="skip"/>
</xsd:sequence>
<xsd:attribute name="wsdlLocation" type="xsd:anyURI" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute is a URI that specifies the location of the WSDL file.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="disco">
<xsd:annotation>
<xsd:documentation>
This element is used to specify the location of a DISCO file for this service. Multiple
entries may exist pointing to the same file hosted in multiple locations, or to variations
on the content within the DISCO files.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:any maxOccurs="unbounded" minOccurs="0" namespace="##other" processContents="skip"/>
</xsd:sequence>
<xsd:attribute name="discoLocation" type="xsd:anyURI" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute is a URI that specifies the location of the DISCO file.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="wsil">
<xsd:annotation>
<xsd:documentation>
This element is used to specify the location of a WSIL file for this service. Multiple
entries may exist pointing to the same file hosted in multiple locations, or to variations
on the content within the WSIL files.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:any maxOccurs="unbounded" minOccurs="0" namespace="##other" processContents="skip"/>
</xsd:sequence>
<xsd:attribute name="wsilLocation" type="xsd:anyURI" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute is a URI that specifies the location of the WSIL file.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attributeGroup ref="standardBlueAttributeGroup"/>
</xsd:complexType>
<!--
//
//
// Fault information schema
//
//
-->
<xsd:complexType name="faultDetailType">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="faultResponseAction" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
This is the response action that is to be taken by the client upon
receiving this fault message. Contents of this element can be:
<p/>
<dl>
<dt>
<b>correct</b>
</dt>
<dd>
A correctable error was detected. The client should reform the
request message, correcting the noted error, and resubmit the message.
If the client is unable to correct the message, the client should accept
the failure condition and execute approriate recovery logic.
</dd>
<dt>
<b>retry</b>
</dt>
<dd>
A transient error has occured. The client should resubmit the message
(ensuring that a new message ID is used).
</dd>
<dt>
<b>giveUp</b>
</dt>
<dd>
An uncorrectable error was detected. The client should accept the failure
condition and execue appropriate recovery logic.
</dd>
</dl>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="1" name="faultChain" type="faultChainType">
<xsd:annotation>
<xsd:documentation>
When a request is being processed by a service, it may be traveling through multiple
sections of the service code. The
<b>faultChain</b>
element contains a list of errors if
there are multiple errors along the processing path of a message. Because a section
of the service or the server may overwrite the error code with a more general error,
this list gives a history of failures for this particular request.
<p/>
<b>faultChain</b>
contains multiple
<b>fault</b>
elements. Each
<b>fault</b>
element
contains details about an error condition which this request has caused to occur during
its processing.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="faultChainType">
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="1" name="fault" type="faultChainFaultType"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="faultChainFaultType">
<xsd:annotation>
<xsd:documentation>
This element provides details about a failure condition that was encountered during
the processing of a .NET My Services message.
<p/>
<b>code</b>
and
<b>shortDescription</b>
are two of the child elements this element can
have. These elements contain pairs defined by the error code documentation to help client
applications determine the reason for a failure of a message.
The
<b>longDescription</b>
element child of this element contains context-based information about
the error. For example, the
<b>shortDescription</b>
element may contain "Syntax Error", whereas this element
indicates what the real syntax error was.
<p/>
Users of services and client application developers should depend only on the
<b>code</b>
element
value within a fault to determine what happened. Descriptions are not a part of the contract.
<p/>
Order of fault elements may change and the order of a set of faults for a certain message is not a
part of the contract between a client and a .NET My Services server; only the recommended action to fix
the problem is. Application developers should consider the fact that the order of faults may
change from service to service, and from version to version; there is no requirement to keep
the order and descriptions. This is done on purpose, in order to simplify client application development.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="code" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
This element contains the hexadecimal error code for this fault
entry in the fault chain.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="1" name="shortDescription" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
This element contains the short description for this fault entry in the fault chain.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="1" name="longDescription" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
This element contains the long and context-sensitive description for
this fault entry in the fault chain.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>