Share via

3.1.4.4.2.1 Document

  • Article

This element describes a crawled item as part of the search results.

 <s:element name="Document">
   <s:complexType>
     <s:sequence>
       <s:element name="Title" type="s:string" minOccurs="0"/>
       <s:element name="Action">
         <s:complexType>
           <s:sequence>
             <s:element name="LinkUrl">
               <s:complexType>
                 <s:simpleContent>
                   <s:extension base="s:string">
                     <s:attribute name="size" type="s:unsignedInt" use="optional"/>
                     <s:attribute name="fileExt" type="s:string" use="optional"/>
                   </s:extension>
                 </s:simpleContent>
               </s:complexType>
             </s:element>
           </s:sequence>
         </s:complexType>
       </s:element>
       <s:choice>
         <s:sequence>
           <s:element name="Description" type="s:string"/>
           <s:element name="Date" type="s:dateTime"/>
         </s:sequence>
         <s:element name="Properties">
           <s:complexType>
             <s:sequence>
               <s:element name="Property" minOccurs="0" maxOccurs="unbounded">
                 <s:complexType>
                   <s:sequence>
                     <s:element name="Name" type="s:string"/>
                     <s:element name="Type" type="d:PropertyType"/>
                     <s:element name="Value" type="s:string"/>
                   </s:sequence>
                 </s:complexType>
               </s:element>
             </s:sequence>
           </s:complexType>
         </s:element>
       </s:choice>
     </s:sequence>
     <s:attribute name="relevance" type="s:double"/>
   </s:complexType>
 </s:element>

relevance: Relevance of the crawled item. A higher value means a higher relevance.

Title: Title of the crawled item. This element MUST only be present if the QueryPacket element of the request did not have a Query.Properties child element.

Action: Action to take when the crawled item is selected by the user from the list of search results.

Action.LinkUrl: URL of the crawled item.

Action.LinkUrl.size: Size of the crawled item. If present, it MUST contain the size of the crawled item in bytes. If the QueryPacket element of the request contains a Query.Properties child element, this attribute MUST be absent; otherwise this attribute MUST be present.

Action.LinkUrl.fileExt: The file extension of the crawled item. This attribute MUST be present if the protocol server is able to determine a meaningful file extension for the crawled item; the attribute MUST NOT be present otherwise.

Description: The description of the crawled item. Some crawled items don't have a description available. In those cases, the content of this element can be empty. This element MUST only be present if the QueryPacket element of the request does not have a Query.Properties child element.

Date: The date the crawled item was last modified. This element MUST only be present if the QueryPacket element of the request does not have a Query.Properties child element.

Properties: The property values for the crawled item. This element MUST only be present if the request's QueryPacket element contained a Query.Properties child element. It MUST only contain the property values for the properties which were specified in the request's QueryPacket.Query.Properties element. If QueryPacket.Query.Properties has no child elements, the protocol server will return the default properties as specified in section 2.2.3.1.

Properties.Property: The information for a property of the crawled item. Note that not all crawled items have non-empty values for every property. If an item has an empty value in a requested property for an item in the search results, the protocol server SHOULD NOT generate a corresponding Properties.Property element.

Properties.Property.Name: The name of the property.

Properties.Property.Type: The type of the property. See section 3.1.4.4.4.1 for possible values<32>.

Properties.Property.Value: The property value for this crawled item. The values MUST be encoded according to their type. Refer to section 3.1.4.4.4.1 for details about the encoding.