1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
<html dir="ltr"><head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<META HTTP-EQUIV="assetid" CONTENT="HV01087693"><META NAME="lcid" CONTENT="1033"><title>Microsoft.Search.Response Schema Documentation</title><link rel="stylesheet" type="text/css" href="office10.css"><script type="text/javascript" language="Javascript" src="ExpCollapse.js"></script><script type="text/javascript" language="JavaScript" src="inline.js"></script></head><body><h1>Microsoft.Search.Response Schema Documentation</h1><p>This topic contains documentation for the Microsoft.Search.Response schema. For the schema itself, see <a href="rsxsdResponse.htm" id="HV01084530" lcid=" ">Microsoft.Search.Response Schema</a>.</p><h2>Documentation for the urn:Microsoft.Search.Response schema</h2><p>Defines a response packet from a service provider, which can in turn contain several individual responses corresponding to each of the provider's services.</p><h2>Basic Schema Attributes</h2><table><tr><th>Attribute</th><th>Value</th></tr><tr><td>targetNamespace</td><td>urn:Microsoft.Search.Response</td></tr><tr><td>elementFormDefault</td><td>qualified</td></tr><tr><td>attributeFormDefault</td><td>unqualified <i>(default)</i></td></tr></table><h2>Declared Namespaces</h2><table><tr><th>Namespace</th><th>Prefix</th></tr><tr><td>urn:Microsoft.Search.Types</td><td>t:
</td></tr><tr><td>urn:Microsoft.Search.Response</td><td><i>(default)</i></td></tr><tr><td>http://www.w3.org/2001/XMLSchema</td><td>xsd:
</td></tr><tr><td>http://www.w3.org/XML/1998/namespace</td><td>xml:
</td></tr></table><h2>Imported Schemas</h2><table><tr><th>namespace</th><th>id</th><th>schemaLocation</th></tr><tr><td>urn:Microsoft.Search.Types</td><td><i>(none)</i></td><td><a href="rsxsdTypes.htm" id="HV010845191033" lcid=" ">Microsoft.Search.Types.xsd</a></td></tr><tr><td>urn:Microsoft.Search.Response.Document</td><td><i>(none)</i></td><td><a href="rsxsdResponseDocument.htm" id="HV01084528" lcid=" ">Microsoft.Search.Response.Document.xsd</a></td></tr><tr><td>urn:Microsoft.Search.Response.Form</td><td><i>(none)</i></td><td><a href="rsxsdResponseForm.htm" id="HV01084529" lcid=" ">Microsoft.Search.Response.Form.xsd</a></td></tr><tr><td>urn:Microsoft.Search.Response.Content</td><td><i>(none)</i></td><td><a href="rsxsdResponseContent.htm" id="HV01084527" lcid=" ">Microsoft.Search.Response.Content.xsd</a></td></tr></table><h2>Overview</h2><p><a href="#ResponsePacket">
<ResponsePacket>
</a></p><p> <a href="#ResponsePacket_Response">
<Response>
</a></p><p> <a href="#ResponseType_QueryId">
<QueryId/>
</a></p><p> <a href="#ResponseType_Copyright">
<Copyright/>
</a></p><p> <a href="#ResponseType_OriginatorContext">
<OriginatorContext>
</a></p><p> <a href="#OriginatorContextType_Any">
<Any/>
</a></p><p> </OriginatorContext></p><p> <a href="#ResponseType_RequeryContext">
<RequeryContext>
</a></p><p> <a href="#RequeryContextType_Any">
<Any/>
</a></p><p> </RequeryContext></p><p> <a href="#ResponseType_Range">
<Range>
</a></p><p> <a href="#RangeType_ResultType">
<ResultType/>
</a></p><p> <a href="#RangeType_StartAt">
<StartAt/>
</a></p><p> <a href="#RangeType_Count">
<Count/>
</a></p><p> <a href="#RangeType_MustDisplayCount">
<MustDisplayCount/>
</a></p><p> <a href="#RangeType_TotalAvailable">
<TotalAvailable/>
</a></p><p> <a href="#RangeType_Results">
<Results>
</a></p><p> <a href="#ResultCollectionType_Any">
<Any/>
</a></p><p> </Results></p><p> <a href="#RangeType_Any">
<Any/>
</a></p><p> </Range></p><p> <a href="#ResponseType_Status">
<Status/>
</a></p><p> <a href="#ResponseType_DebugErrorMessage">
<DebugErrorMessage/>
</a></p><p> <a href="#ResponseType_Any">
<Any/>
</a></p><p> </Response></p><p> <a href="#ResponsePacket_Any">
<Any/>
</a></p><p></ResponsePacket></p><h2>Top-Level Elements</h2><p><a id="ResponsePacket" name="ResponsePacket">
<b class="bterm">Element:
ResponsePacket</b></a></p><p>A response from a service provider to a query. The response may contain several individual responses corresponding to the services offered by the provider.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>abstract</td><td>false <i>(default)</i></td></tr><tr><td>name</td><td>ResponsePacket</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td>complexType</td></tr></table><p><b class="bterm">Attributes</b></p><ul><li><p><b class="bterm">Attribute: revision</b></p><p>Unsigned integer indicating the revision of the schema used in the response.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>name</td><td>revision</td></tr><tr><td>type</td><td>xsd:unsignedInt</td></tr><tr><td>use</td><td>optional</td></tr></table></li><li><p><b class="bterm">Attribute: build</b></p><p>The build of the component used to generate the response.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>name</td><td>build</td></tr><tr><td>type</td><td><a href="rsxsdTypes.htm" id="HV010845191033" lcid=" ">t:String255</a></td></tr><tr><td>use</td><td>optional</td></tr></table></li><li><p><b class="bterm">Attribute: providerRevision</b></p><p>Current revision of the provider. If the revision is different from the one the client has stored, Microsoft® Office 2003 will prompt the user to update the service.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>name</td><td>providerRevision</td></tr><tr><td>type</td><td>xsd:unsignedInt</td></tr><tr><td>use</td><td>optional</td></tr></table></li></ul><p><b class="bterm">Subelements: Sequence</b></p><p>Elements must appear in the specified order.</p><ul><li><p><a id="ResponsePacket_Response" name="ResponsePacket_Response">
<b class="bterm">Element:
Response</b></a></p><p>An individual response from a service to a query.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>abstract</td><td>false <i>(default)</i></td></tr><tr><td>minOccurs</td><td>1</td></tr><tr><td>maxOccurs</td><td>unbounded</td></tr><tr><td>name</td><td>Response</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td><a href="#ResponseType">ResponseType</a></td></tr></table></li><li><p><a id="ResponsePacket_Any" name="ResponsePacket_Any"><b class="bterm">Any</b></a></p><p>Any element in another namespace. Can be used for extensibility in the future.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>namespace</td><td>##other</td></tr><tr><td>processContents</td><td>skip</td></tr><tr><td>minOccurs</td><td>0</td></tr><tr><td>maxOccurs</td><td>unbounded</td></tr></table></li></ul><h2>Top-Level Types and Groups</h2><ul><li><p><a id="ResponseType" name="ResponseType">
<b class="bterm">Complex Type: ResponseType</b></a></p><p>Defines an individual response from a service to a query.</p><p><b class="bterm">Attributes</b></p><ul><li><p><b class="bterm">Attribute: domain</b></p><p>A unique domain identifier for the service handling the query. The value should match the domain of one of the query elements in the QueryPacket corresponding to this ResponsePacket.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>name</td><td>domain</td></tr><tr><td>type</td><td><a href="rsxsdTypes.htm" id="HV010845191033" lcid=" ">t:String255</a></td></tr><tr><td>use</td><td>optional</td></tr></table></li></ul><p><b class="bterm">Subelements: Sequence</b></p><p>Elements must appear in the specified order.</p><ul><li><p><a id="ResponseType_QueryId" name="ResponseType_QueryId">
<b class="bterm">Element:
QueryId</b></a></p><p>Unique string that identifies the query for tracking purposes. Office always uses a globally unique identifier (GUID).</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>abstract</td><td>false <i>(default)</i></td></tr><tr><td>minOccurs</td><td>0</td></tr><tr><td>maxOccurs</td><td>1 <i>(default)</i></td></tr><tr><td>name</td><td>QueryId</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td><a href="rsxsdTypes.htm" id="HV010845191033" lcid=" ">t:String255</a></td></tr></table></li><li><p><a id="ResponseType_Copyright" name="ResponseType_Copyright">
<b class="bterm">Element:
Copyright</b></a></p><p>The result can contain a copyright notice if the provider is concerned about misuse of the results. This is not displayed to the user in Office 2003.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>abstract</td><td>false <i>(default)</i></td></tr><tr><td>minOccurs</td><td>0</td></tr><tr><td>maxOccurs</td><td>1 <i>(default)</i></td></tr><tr><td>name</td><td>Copyright</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td>xsd:string</td></tr></table></li><li><p><a id="ResponseType_OriginatorContext" name="ResponseType_OriginatorContext">
<b class="bterm">Element:
OriginatorContext</b></a></p><p>Client data that is being round-tripped through the service. The data is passed by the client to the server inside the <b class="bterm">QueryPacket\Query\Context\OriginatorContext</b> element.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>abstract</td><td>false <i>(default)</i></td></tr><tr><td>minOccurs</td><td>0</td></tr><tr><td>maxOccurs</td><td>1 <i>(default)</i></td></tr><tr><td>name</td><td>OriginatorContext</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td><a href="#OriginatorContextType">OriginatorContextType</a></td></tr></table></li><li><p><a id="ResponseType_RequeryContext" name="ResponseType_RequeryContext">
<b class="bterm">Element:
RequeryContext</b></a></p><p>Service data being round-tripped through the client.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>abstract</td><td>false <i>(default)</i></td></tr><tr><td>minOccurs</td><td>0</td></tr><tr><td>maxOccurs</td><td>1 <i>(default)</i></td></tr><tr><td>name</td><td>RequeryContext</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td><a href="#RequeryContextType">RequeryContextType</a></td></tr></table></li><li><p><a id="ResponseType_Range" name="ResponseType_Range">
<b class="bterm">Element:
Range</b></a></p><p>The same number of ranges are returned as were queried for, no more, no less. Office will never request more than one range.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>abstract</td><td>false <i>(default)</i></td></tr><tr><td>minOccurs</td><td>0</td></tr><tr><td>maxOccurs</td><td>unbounded</td></tr><tr><td>name</td><td>Range</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td><a href="#RangeType">RangeType</a></td></tr></table></li><li><p><a id="ResponseType_Status" name="ResponseType_Status">
<b class="bterm">Element:
Status</b></a></p><p>Status of the query. It indicates whether the query was successful.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>abstract</td><td>false <i>(default)</i></td></tr><tr><td>minOccurs</td><td>1</td></tr><tr><td>maxOccurs</td><td>1 <i>(default)</i></td></tr><tr><td>name</td><td>Status</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td><a href="#StatusType">StatusType</a></td></tr></table></li><li><p><a id="ResponseType_DebugErrorMessage" name="ResponseType_DebugErrorMessage">
<b class="bterm">Element:
DebugErrorMessage</b></a></p><p>If Status != SUCCESS, the error message in English is returned here for debugging purposes. This is not displayed to the user in Office.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>abstract</td><td>false <i>(default)</i></td></tr><tr><td>minOccurs</td><td>0</td></tr><tr><td>maxOccurs</td><td>1 <i>(default)</i></td></tr><tr><td>name</td><td>DebugErrorMessage</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td><a href="rsxsdTypes.htm" id="HV010845191033" lcid=" ">t:String2048</a></td></tr></table></li><li><p><a id="ResponseType_Any" name="ResponseType_Any"><b class="bterm">Any</b></a></p><p>Any element in another namespace. Can be used for extensibility in the future.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>namespace</td><td>##other</td></tr><tr><td>processContents</td><td>skip</td></tr><tr><td>minOccurs</td><td>0</td></tr><tr><td>maxOccurs</td><td>unbounded</td></tr></table></li></ul></li><li><p><a id="OriginatorContextType" name="OriginatorContextType">
<b class="bterm">Complex Type: OriginatorContextType</b></a></p><p>Defines context data from the client to be round-tripped through the service.</p><p><b class="bterm">Attributes</b></p><p>None</p><p><b class="bterm">Subelements: Sequence</b></p><p>Elements must appear in the specified order.</p><ul><li><p><a id="OriginatorContextType_Any" name="OriginatorContextType_Any"><b class="bterm">Any</b></a></p><p>Any element in another namespace. This is an XML island the client passed to the service for round-tripping.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>namespace</td><td>##other</td></tr><tr><td>processContents</td><td>skip</td></tr><tr><td>minOccurs</td><td>1 <i>(default)</i></td></tr><tr><td>maxOccurs</td><td>unbounded</td></tr></table></li></ul></li><li><p><a id="RequeryContextType" name="RequeryContextType">
<b class="bterm">Complex Type: RequeryContextType</b></a></p><p>Defines the requery context that a service can have the client pass back, during a requery only. It is an arbitrary XML data island.</p><p><b class="bterm">Attributes</b></p><p>None</p><p><b class="bterm">Subelements: Sequence</b></p><p>Elements must appear in the specified order.</p><ul><li><p><a id="RequeryContextType_Any" name="RequeryContextType_Any"><b class="bterm">Any</b></a></p><p>Any element in another namespace. This is an XML island the service is passing to the client for round-tripping.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>namespace</td><td>##other</td></tr><tr><td>processContents</td><td>skip</td></tr><tr><td>minOccurs</td><td>1 <i>(default)</i></td></tr><tr><td>maxOccurs</td><td>unbounded</td></tr></table></li></ul></li><li><p><a id="RangeType" name="RangeType">
<b class="bterm">Complex Type: RangeType</b></a></p><p>Defines the <b class="bterm">Range</b> element containing the results and information about them.</p><p><b class="bterm">Attributes</b></p><ul><li><p><b class="bterm">Attribute: id</b></p><p>A unique ID for the <b class="bterm">Range</b> element.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>name</td><td>id</td></tr><tr><td>type</td><td>xsd:string</td></tr><tr><td>use</td><td>optional</td></tr></table></li></ul><p><b class="bterm">Subelements: Sequence</b></p><p>Elements must appear in the specified order.</p><ul><li><p><a id="RangeType_ResultType" name="RangeType_ResultType">
<b class="bterm">Element:
ResultType</b></a></p><p>Optional string describing the type of result. Office will not use the value of this element.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>abstract</td><td>false <i>(default)</i></td></tr><tr><td>minOccurs</td><td>0</td></tr><tr><td>maxOccurs</td><td>unbounded</td></tr><tr><td>name</td><td>ResultType</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td><a href="rsxsdTypes.htm" id="HV010845191033" lcid=" ">t:String2048</a></td></tr></table></li><li><p><a id="RangeType_StartAt" name="RangeType_StartAt">
<b class="bterm">Element:
StartAt</b></a></p><p>The index of the initial result, based on "1" as the lowest result index.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>abstract</td><td>false <i>(default)</i></td></tr><tr><td>default</td><td>1</td></tr><tr><td>minOccurs</td><td>0</td></tr><tr><td>maxOccurs</td><td>1 <i>(default)</i></td></tr><tr><td>name</td><td>StartAt</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td><a href="rsxsdTypes.htm" id="HV010845191033" lcid=" ">t:StartAtType</a></td></tr></table></li><li><p><a id="RangeType_Count" name="RangeType_Count">
<b class="bterm">Element:
Count</b></a></p><p>Total results of this type to return. Note that fewer than this number may be returned if there are not enough results, and more than this number may be returned due to policy restrictions. If more results are returned, the client should display them all. Absence of <b class="bterm">Count</b> implies provider discretion.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>abstract</td><td>false <i>(default)</i></td></tr><tr><td>minOccurs</td><td>0</td></tr><tr><td>maxOccurs</td><td>1 <i>(default)</i></td></tr><tr><td>name</td><td>Count</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td>xsd:unsignedInt</td></tr></table></li><li><p><a id="RangeType_MustDisplayCount" name="RangeType_MustDisplayCount">
<b class="bterm">Element:
MustDisplayCount</b></a></p><p>Minimum number of results that should be displayed.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>abstract</td><td>false <i>(default)</i></td></tr><tr><td>minOccurs</td><td>0</td></tr><tr><td>maxOccurs</td><td>1 <i>(default)</i></td></tr><tr><td>name</td><td>MustDisplayCount</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td>xsd:unsignedInt</td></tr></table></li><li><p><a id="RangeType_TotalAvailable" name="RangeType_TotalAvailable">
<b class="bterm">Element:
TotalAvailable</b></a></p><p>The total number available. This number may not be 100% accurate and all these results may not be accessible.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>abstract</td><td>false <i>(default)</i></td></tr><tr><td>minOccurs</td><td>0</td></tr><tr><td>maxOccurs</td><td>1 <i>(default)</i></td></tr><tr><td>name</td><td>TotalAvailable</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td>xsd:unsignedInt</td></tr></table></li><li><p><a id="RangeType_Results" name="RangeType_Results">
<b class="bterm">Element:
Results</b></a></p><p>Results can come back in all formats that are specified as supported and the results are returned in the server's preferred order to display. This element is nonexistent if no results are returned.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>abstract</td><td>false <i>(default)</i></td></tr><tr><td>minOccurs</td><td>0</td></tr><tr><td>maxOccurs</td><td>1 <i>(default)</i></td></tr><tr><td>name</td><td>Results</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td><a href="#ResultCollectionType">ResultCollectionType</a></td></tr></table></li><li><p><a id="RangeType_Any" name="RangeType_Any"><b class="bterm">Any</b></a></p><p>Any element in another namespace. Can be used for extensibility in the future.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>namespace</td><td>##other</td></tr><tr><td>processContents</td><td>skip</td></tr><tr><td>minOccurs</td><td>0</td></tr><tr><td>maxOccurs</td><td>unbounded</td></tr></table></li></ul></li><li><p><a id="ResultCollectionType" name="ResultCollectionType">
<b class="bterm">Complex Type: ResultCollectionType</b></a></p><p>Defines a set of results, in any format supported.</p><p><b class="bterm">Attributes</b></p><p>None</p><p><b class="bterm">Subelements: Choice</b></p><p>Only one element can be chosen.</p><p>The maximum number of occurrences <i>(maxOccurs)</i> for the choice is unbounded.</p><ul><li><p><a id="ResultCollectionType_Any" name="ResultCollectionType_Any"><b class="bterm">Any</b></a></p><p>Any element in another namespace. Elements here will be in any results format supported by the client. Office will support the Form, Document, and Content results types.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>namespace</td><td>##other</td></tr><tr><td>processContents</td><td>strict <i>(default)</i></td></tr><tr><td>minOccurs</td><td>1 <i>(default)</i></td></tr><tr><td>minOccurs</td><td>1 <i>(default)</i></td></tr></table></li></ul></li><li><p><a id="StatusType" name="StatusType">
<b class="bterm">simpleType: StatusType</b></a></p><p>Defines the status of the search.</p><p><b class="bterm">Base</b></p><table><tr><td>base</td><td>xsd:string</td></tr></table><p><b class="bterm">Restrictions</b></p><table><tr><th>Restriction</th><th>Value</th></tr><tr><td>enumeration</td><td><p>SUCCESS</p><p>ERROR</p><p>ERROR_SERVER_TRANSIENT</p><p>ERROR_SERVER</p><p>ERROR_NO_RESPONSE</p><p>ERROR_BAD_RESULTS</p><p>ERROR_NO_RESULTS_FOUND</p><p>ERROR_OUT_OF_ORDER</p><p>ERROR_NO_CONNECTION</p><p>ERROR_NO_AUTHENTICATION</p><p>ERROR_NO_AUTHORIZATION</p></td></tr></table></li></ul><center><a href="XMLSchemaCopyright_HV01147162.htm">©2003-2004 Microsoft Corporation. All rights reserved.</a>
Permission to copy, display and distribute this document is available at: <a
href="http://r.office.microsoft.com/r/rlidAWSContentRedir?AssetID=XT010988631033&CTT=11&Origin=HV011232471033"
target="_new">http://msdn.microsoft.com/library/en-us/odcXMLRef/html/odcXMLRefLegalNotice.asp</a></center></body></html>
|
