Share via

2.2.4.1 Results

  • Article

The Results complex type provides the details about all versions of a specified file that the user can access.

The DeleteAllVersions, DeleteVersion, GetVersions, and RestoreVersion methods return the Results complex type.

 <s:complexType name="Results">
   <s:sequence>
     <s:element name="list" maxOccurs="1" minOccurs="1">
       <s:complexType>
         <s:attribute name="id" type="s:string" use="required" />
       </s:complexType>
     </s:element>
     <s:element name="versioning" maxOccurs="1" minOccurs="1">
       <s:complexType>
         <s:attribute name="enabled" type="s:unsignedByte" use="required" />
       </s:complexType>
     </s:element>
     <s:element name="settings" maxOccurs="1" minOccurs="1">
       <s:complexType>
         <s:attribute name="url" type="s:string" use="required" />
       </s:complexType>
     </s:element>
     <s:element name="result" maxOccurs="unbounded" minOccurs="1" type="tns:VersionData"/>
   </s:sequence>
 </s:complexType>

list: Contains information about the document library that is represented by this list.

list.id: Specifies the GUID of the document library in which the file resides.

versioning: Contains version-related information about the file.

versioning.enabled: Specifies whether versioning is enabled on the file. The value of this attribute MUST be "0" or "1". A value of "0" indicates that versioning is disabled; a value of "1" indicates that versioning is enabled.

settings: Contains information about how versioning operates for the file.

settings.url: Specifies the URL to the webpage of versioning-related settings for the document library in which the file resides.

result: Specifies details about a version of the file on the protocol server. A separate result element MUST exist for each version of the file that the user can access. For details about the type of this element, see section 2.2.4.3.