complexType "requestType"
Namespace:
http://schemas.microsoft.com/hs/2001/10/core
Content:
complex, 4 attributes, 1 element
Defined:
globally in hsinfra.xsd; see XML source
Includes:
definitions of 4 attributes, 1 element
Used:
at 1 location
XML Representation Summary
<...
   
 = 
("content" | "roleList" | "policy" | "system")
 = 
("always" | "never" | "faultOnly")
 = 
xsd:string
 = 
xsd:string
   
>
   
Content: 
key[1..100]
</...>
Content Model Elements (1):
key (in request)
All Direct / Indirect Based Elements (1):
request
Known Usage Locations
Annotation
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.
XML Source (see within schema source)
<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>
Attribute Detail (all declarations; 4/4)
document
Type:
anonymous simpleType (restriction of xsd:string)
Use:
required
Defined:
locally within (this) requestType complexType
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>
Anonymous simpleType
Derivation:
restriction of xsd:string
XML Source (see within schema source)
<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>
genResponse
Type:
anonymous simpleType (restriction of xsd:string)
Use:
required
Defined:
locally within (this) requestType complexType
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>
Anonymous simpleType
Derivation:
restriction of xsd:string
XML Source (see within schema source)
<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>
method
Type:
string
Use:
required
Defined:
locally within (this) requestType complexType
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>
XML Source (see within schema source)
<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>
service
Type:
string
Use:
required
Defined:
locally within (this) requestType complexType
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".
XML Source (see within schema source)
<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>
Content Element Detail (all declarations; 1/1)
key
Type:
anonymous complexType, empty content
Defined:
locally within (this) requestType complexType
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.
XML Source (see within schema source)
<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>