SharePoint SOAP API Reference

FDN » SharePoint » SharePoint SOAP API Reference

SharePoint SOAP API Reference

SharePoint Team Services exposes SOAP-based web services for remote administration and data access. These services are accessible at http://site/_vti_bin/.

Available Web Services

ServiceURLPurpose
Lists/_vti_bin/Lists.asmxCRUD operations on lists and list items
Views/_vti_bin/Views.asmxManage list views
Webs/_vti_bin/Webs.asmxSite and subsite management
UserGroup/_vti_bin/UserGroup.asmxUser and group management
Imaging/_vti_bin/Imaging.asmxPicture library operations
SiteData/_vti_bin/SiteData.asmxSite content retrieval (used by search crawlers)

Lists.asmx Key Methods

MethodDescription
GetListReturns schema and properties of a list
GetListItemsReturns items from a list (supports CAML query)
UpdateListItemsInsert, update, or delete list items
AddListCreate a new list
DeleteListDelete a list
GetListCollectionReturns all lists in the site

CAML Query Example

The GetListItems method accepts a CAML (Collaborative Application Markup Language) query to filter and sort results:

<Query>
  <Where>
    <And>
      <Eq>
        <FieldRef Name="Status" />
        <Value Type="Choice">Active</Value>
      </Eq>
      <Geq>
        <FieldRef Name="DueDate" />
        <Value Type="DateTime">2001-01-01T00:00:00Z</Value>
      </Geq>
    </And>
  </Where>
  <OrderBy>
    <FieldRef Name="DueDate" Ascending="TRUE" />
  </OrderBy>
</Query>

SOAP Envelope Structure

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetListItems xmlns="http://schemas.microsoft.com/sharepoint/soap/">
      <listName>Tasks</listName>
      <query>
        <Query><Where>...</Where></Query>
      </query>
      <rowLimit>100</rowLimit>
    </GetListItems>
  </soap:Body>
</soap:Envelope>
« Developer Network ‹ SharePoint Document Libraries Automating SharePoint with VBScript ›