2.2.3.4 List

  • Article

This element returns the information about the contents of a list. It is defined as follows:

   <xs:element name="List">
     <xs:complexType>
       <xs:choice>
         <xs:element ref="tns:Error"/>
         <xs:choice>
           <xs:element name="NoChanges" type="xs:string"/>
           <xs:sequence>
             <xs:sequence>
               <xs:element ref="tns:ID"/>
               <xs:choice>
                 <xs:element ref="tns:Error" minOccurs="0"/>
                 <xs:sequence>
                   <xs:any minOccurs="0" maxOccurs="unbounded" namespace="##other" processContents='skip'/>
                 </xs:sequence>
               </xs:choice>
             </xs:sequence>
           </xs:sequence>
         </xs:choice>
       </xs:choice>
       <xs:attribute name="Name" type="tns:ListType" use="required"/>
     </xs:complexType>
   </xs:element>

NoChanges: This element MUST be returned when the protocol client has provided a LastUpdate parameter and the specified document has not changed since the value in LastUpdate. This element MUST be empty.

ID: Contains a GUID that corresponds to a document on the protocol server.

Name: Describes the list contents. The list is identified by the Name attribute in the List element. The following table shows restrictions on the rest of the structure based on the Name attribute.

Name

Description

Tasks

The list of tasks associated with this workspace. The list contains a sequence of XML elements with information about the tasks.

Documents

The list of documents associated with this workspace. The list contains a sequence of z:row elements with information about the documents.

Links

The list of external links associated with this workspace. It contains a sequence of XML elements with information about the links contained in the list.

Error: Specifies that an error occurred while accessing the list data. The error codes are described in the following table.

Error code

Description

ServerFailure

The protocol server encountered an unspecified error.

NoAccess

The authenticated user does not have sufficient permissions to access list information for the Document Workspace.

ListNotFound

The specified list does not exist in the Document Workspace.

TooManyItems

The number of lists exceeds an implementation-specific size<1>.

The List element can contain an array of z:row elements in any of its elements. In a z:row element, the z is equal to #RowsetSchema in the ActiveX Data Objects (ADO) XML Persistence format (see [MS-PRSTFR]). Each z:row element describes a single list item. The names of the attributes of this element correspond to the names of fields in the list. (For more details, see [MS-WSSFO2].)