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
|
<html dir="ltr"><head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<META HTTP-EQUIV="assetid" CONTENT="HV01087690"><META NAME="lcid" CONTENT="1033"><title>Microsoft.Search.Response.Document 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.Document Schema Documentation</h1><p>This topic contains documentation for the Microsoft.Search.Response.Document schema. For the text of the schema, see <a href="rsxsdResponseDocument.htm" id="HV01084528" lcid=" ">Microsoft.Search.Response.Document Schema</a>.</p><h2>Documentation for the urn:Microsoft.Search.Response.Document schema</h2><p>Defines a document, which typically consists of a title, description, and link.</p><h2>Basic Schema Attributes</h2><table><tr><th>Attribute</th><th>Value</th></tr><tr><td>targetNamespace</td><td>urn:Microsoft.Search.Response.Document</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.Document</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></table><h2>Overview</h2><p><a href="#Document">
<Document>
</a></p><p> <a href="#Document_Title">
<Title/>
</a></p><p>
<a href="#Document_Action"><Action>
</a></p><p> <a href="#ActionType_LinkUrl"><LinkUrl/>
</a></p><p> </Action></p><p>
<a href="#Document_DisplayUrl"><DisplayUrl/>
</a></p><p> <a href="#Document_DestinationUrl">
<DestinationUrl/>
</a></p><p>
<a href="#Document_Description"><Description/>
</a></p><p> <a href="#Document_Date">
<Date/>
</a></p><p> <a href="#Document_Media">
<Media>
</a></p><p>
<a href="#MediaType_SrcUrl"><SrcUrl/>
</a></p><p> <a href="#MediaType_LinkUrl">
<LinkUrl/>
</a></p><p> <a href="#MediaType_AltText">
<AltText/>
</a></p><p> </Media></p><p> <a href="#Document_Any">
<Any/>
</a></p><p></Document></p><h2>Top-Level Elements</h2><p><a id="Document" name="Document">
<b class="bterm">Element:
Document</b></a></p><p>Defines a document, which typically consists of a title, description, and link.</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>Document</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: type</b></p><p>Arbitrary type that defines the type of document. Not currently used by Microsoft® Office 2003.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>name</td><td>type</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: relevance</b></p><p>Relevance information, with 1 being the highest. Not currently used by Office 2003.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>name</td><td>relevance</td></tr><tr><td>type</td><td>xsd:double</td></tr><tr><td>use</td><td>optional</td></tr></table></li><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: rtl</b></p><p>If set to <b class="bterm">true</b>, the document is displayed right-to-left. If set to <b class="bterm">false</b>, the document is displayed left-to-right. If unspecified, the system will choose.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>name</td><td>rtl</td></tr><tr><td>type</td><td>xsd:boolean</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="Document_Title" name="Document_Title">
<b class="bterm">Element:
Title</b></a></p><p>Title of the document. If not specified, a default will be provided.</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>Title</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td><a href="#TitleType">TitleType</a></td></tr></table></li><li><p><a id="Document_Action" name="Document_Action">
<b class="bterm">Element:
Action</b></a></p><p>The URL to be launched.</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>Action</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td><a href="#ActionType">ActionType</a></td></tr></table></li><li><p><a id="Document_DisplayUrl" name="Document_DisplayUrl">
<b class="bterm">Element:
DisplayUrl</b></a></p><p>The friendly name for the link that will display in the results.</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>DisplayUrl</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="Document_DestinationUrl" name="Document_DestinationUrl">
<b class="bterm">Element:
DestinationUrl</b></a></p><p>This is the URL where the user will finally end up after all the possible redirections. Used for removal of duplications.</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>DestinationUrl</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td>xsd:anyURI</td></tr></table></li><li><p><a id="Document_Description" name="Document_Description">
<b class="bterm">Element:
Description</b></a></p><p>Document description</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>Description</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td><a href="#DescriptionType">DescriptionType</a></td></tr></table></li><li><p><a id="Document_Date" name="Document_Date">
<b class="bterm">Element:
Date</b></a></p><p>This date could have a different connotation depending on the context. It could mean last crawled date, last updated date, or expiration date (for news). It's up to the server and client to decide its usage. Office does not currently use this date.</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>Date</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td>xsd:dateTime</td></tr></table></li><li><p><a id="Document_Media" name="Document_Media">
<b class="bterm">Element:
Media</b></a></p><p>Collection of media elements related to the result. The <b class="bterm">type</b> attribute defines whether the media is an image, audio, or video link.</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>Media</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td><a href="#MediaType">MediaType</a></td></tr></table></li><li><p><a id="Document_Any" name="Document_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="TitleType" name="TitleType">
<b class="bterm">Complex Type: TitleType</b></a></p><p>Defines the title of a document.</p><p><b class="bterm">Attributes</b></p><ul><li><p><b class="bterm">Attribute: rtl</b></p><p>If set to <b class="bterm">true</b>, the text is displayed right-to-left. If set to <b class="bterm">false</b>, the text is displayed left-to-right.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>name</td><td>rtl</td></tr><tr><td>type</td><td>xsd:boolean</td></tr><tr><td>use</td><td>optional</td></tr></table></li></ul><p><b class="bterm">Simple Content</b></p><p><b class="bterm">Base</b></p><table><tr><td>base</td><td><a href="rsxsdTypes.htm" id="HV010845191033" lcid=" ">t:String2048</a></td></tr></table></li><li><p><a id="ActionType" name="ActionType">
<b class="bterm">Complex Type: ActionType</b></a></p><p>Defines the URL to be launched and the requery context to be sent.</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="ActionType_LinkUrl" name="ActionType_LinkUrl">
<b class="bterm">Element:
LinkUrl</b></a></p><p>The URL that the user goes to initially. The user might be redirected from this URL to another location.</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>LinkUrl</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: fileExt</b></p><p>The file extension for the file. Used to generate an icon for the file.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>name</td><td>fileExt</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: size</b></p><p>The size of the file in bytes.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>name</td><td>size</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: forPay</b></p><p>If set to <b class="bterm">true</b>, it indicates that the link takes the user to paid content through a special currency icon.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>default</td><td>false</td></tr><tr><td>name</td><td>forPay</td></tr><tr><td>type</td><td>xsd:boolean</td></tr><tr><td>use</td><td>optional</td></tr></table></li></ul><p><b class="bterm">Simple Content</b></p><p><b class="bterm">Base</b></p><table><tr><td>base</td><td>xsd:anyURI</td></tr></table></li></ul></li><li><p><a id="DescriptionType" name="DescriptionType">
<b class="bterm">Complex Type: DescriptionType</b></a></p><p>Defines a document's description.</p><p><b class="bterm">Attributes</b></p><ul><li><p><b class="bterm">Attribute: rtl</b></p><p>If set to <b class="bterm">true</b>, the text is displayed right-to-left. If set to <b class="bterm">false</b>, the text is displayed left-to-right.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>name</td><td>rtl</td></tr><tr><td>type</td><td>xsd:boolean</td></tr><tr><td>use</td><td>optional</td></tr></table></li></ul><p><b class="bterm">Simple Content</b></p><p><b class="bterm">Base</b></p><table><tr><td>base</td><td>xsd:string</td></tr></table></li><li><p><a id="MediaType" name="MediaType">
<b class="bterm">Complex Type: MediaType</b></a></p><p>A media element related to the result. The <b class="bterm">type</b> attribute defines whether the media is an image, audio clip, or video clip. Office itself handles only images; other applications handle audio and video clips.</p><p><b class="bterm">Attributes</b></p><ul><li><p><b class="bterm">Attribute: type</b></p><p>The type of media. Office can handle only the image type.</p><table><tr><th>Property</th><th>Value</th></tr><tr><td>name</td><td>type</td></tr><tr><td>type</td><td>simpleType</td></tr><tr><td>use</td><td>required</td></tr></table><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>IMAGE</p><p>AUDIO</p><p>VIDEO</p></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="MediaType_SrcUrl" name="MediaType_SrcUrl">
<b class="bterm">Element:
SrcUrl</b></a></p><p>This is the source of the media clip.</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>SrcUrl</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td>xsd:anyURI</td></tr></table></li><li><p><a id="MediaType_LinkUrl" name="MediaType_LinkUrl">
<b class="bterm">Element:
LinkUrl</b></a></p><p>This is the URL associated with images. Office does not currently support 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>1 <i>(default)</i></td></tr><tr><td>name</td><td>LinkUrl</td></tr><tr><td>nillable</td><td>false <i>(default)</i></td></tr><tr><td>type</td><td>xsd:anyURI</td></tr></table></li><li><p><a id="MediaType_AltText" name="MediaType_AltText">
<b class="bterm">Element:
AltText</b></a></p><p>Alternative text associated with the image. Used by accessibility tools.</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>AltText</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></ul></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>
|