4.3 GetListItems

  • Article

In this scenario, there is a site addressed by the URL http://fabrikam on the protocol server. The site fabrikam contains a document library identified by GUID "8AC68D3D-8A09-4403-8860-D0E494BBE894". The document library contains multiple documents that have a PDF file name extension. All documents in a document library are also list items. The DocIcon attribute, as specified in [MS-WSSTS] section 2.4.3, contains the file extension of the document. In this case the DocIcon attribute value is "pdf". The following occurs:

  1. The client calls the GetListItems operation to get all the information about at most 10 documents (list items) whose DocIcon attribute is "pdf". The protocol client sends the following SOAP message to the protocol server to call GetListItems.

     <GetListItems xmlns="http://schemas.microsoft.com/sharepoint/soap/">
   <strListName>{8AC68D3D-8A09-4403-8860-D0E494BBE894}</strListName>
   <strQuery>&lt;Where&gt;&lt;Eq&gt;&lt;FieldRef Name="DocIcon"/&gt;&lt;Value Type="Text"&gt;pdf&lt;/Value&gt;&lt;/Eq&gt;&lt;/Where&gt;</strQuery>
   <strViewFields></strViewFields>
   <uRowLimit>10</uRowLimit>
 </GetListItems>

  2. The protocol client sends the HTTP POST to the protocol server: http://fabrikam. The POST URL is /_vti_bin/Sitedata.asmx. The header specifies the following SOAP action.

     http://schemas.microsoft.com/sharepoint/soap/GetListItems

  3. The protocol server returns the information about the matching pdf documents in a response SOAP message as defined in section 3.1.4.8.2.2.

  4. The protocol client parses the response and collects information about all the documents in the response.