Introduction to SharePoint Web Services

Introduction

Web services provide methods that you can use to work remotely with a deployment of Windows SharePoint Services. The following table lists and describes the available Web services.

All web services are accessible from the SharePoint site context using the following URL:

Web Service Methods

Admin Web Service

http://<AdminSite>/_vti_adm/Admin.asmx

Provides methods for managing a deployment of Microsoft Windows SharePoint Services, such as for creating or deleting site collections.

CreateSite
DeleteSite
GetLanguages
RefreshConfigCache

Alerts

http://<Site>/_vti_bin/Alerts.asmx

Provides methods for working with alerts for list items in a SharePoint site.

DeleteAlerts
GetAlerts

Authentication

http://<Site>/_vti_bin/Authentication.asmx

Login
Mode

Copy

http://<Site>/_vti_bin/Authentication.asmx

Provides methods for copying files to or from or within a SharePoint site.

CopyIntoItems
CopyIntoItemsLocal
GetItem

Document Workspace

http://<Site>/_vti_bin/Dws.asmx

Exposes methods for managing Document Workspace sites and the data they contain.

CanCreateDwsUrl
CreateDws
CreateFolder
DeleteDws
DeleteFolder
FindDwsDoc
GetDwsData
GetDwsMetaData
RemoveDwsUser
RenameDws
UpdateDwsData

Forms

http://<Site>/_vti_bin/Forms.asmx

Provides methods for returning forms that are used in the user interface when working with the contents of a list.

GetForm
GetFormCollection

Imaging

http://<Site>/_vti_bin/Imaging.asmx

Provides methods that enable you to create and manage picture libraries.

CheckSubwebAndList
CreateNewFolder
Delete
Download
Edit
GetItemsByIds
GetItemsXMLData
GetListItems
ListPictureLibrary
Rename
Upload

List Data Retrieval (StsAdapter)

http://<Site>/_vti_bin/DspSts.asmx

Represents the adapter service used to perform queries against sites and lists in Microsoft Windows SharePoint Services.

Query

Lists

http://<Site>/_vti_bin/Lists.asmx

Provides methods for working with lists and list data.

AddAttachment
AddDiscussionBoardItem
AddList
AddListFromFeature
ApplyContentTypeToList
CheckInFile
CheckOutFile
CreateContentType
DeleteAttachment
DeleteContentType
DeleteContentTypeXmlDocument
DeleteList
GetAttachmentCollection
GetList
GetListAndView
GetListCollection
GetListContentType
GetListContentTypes
GetListItemChanges
GetListItemChangesSinceToken
GetListItems
GetVersionCollection
UndoCheckOut
UpdateContentType
UpdateContentTypesXmlDocument
UpdateContentTypeXmlDocument
UpdateList
UpdateListItems

Meetings

http://<Site>/_vti_bin/Meetings.asmx

Enables you to create and manage Meeting Workspace sites.

AddMeeting
AddMeetingFromICal
CreateWorkspace
DeleteWorkspace
GetMeetingsInformation
GetMeetingWorkspaces
RemoveMeeting
RestoreMeeting
SetAttendeeResponse
SetWorkspaceTitle
UpdateMeeting
UpdateMeetingFromICal

People

http://<Site>/_vti_bin/People.asmx

ResolvePrincipals
SearchPrincipals

Permissions

http://<Site>/_vti_bin/Permissions.asmx

Provides methods for working with the permissions for a site or list.

AddPermission
AddPermissionCollection
GetPermissionCollection
RemovePermission
RemovePermissionCollection
UpdatePermission

Site Data

http://<Site>/_vti_bin/SiteData.asmx

Provides methods that return metadata or list data from sites or lists in Microsoft Windows SharePoint Services.

EnumerateFolder
GetAttachments
GetChanges
GetContent
GetList
GetListCollection
GetListItems
GetSite
GetSiteAndWeb
GetSiteUrl
GetURLSegments
GetWeb

Sites

http://<Site>/_vti_bin/Sites.asmx

Provides a method for returning information about the collection of site templates on the virtual server.

ExportWeb
GetSiteTemplates
GetUpdatedFormDigest
ImportWeb

Search

http://<Site>/_vti_bin/spsearch.asmx

The QueryService class is the entry point for calling the Search in Microsoft Windows SharePoint Services Query web service.

GetPortalSearchInfo (MOSS only)
GetSearchMetadata (MOSS only)
Query
QueryEx
RecordClick (MOSS only)
Registration
Status

Users and Groups

http://<Site>/_vti_bin/usergroup.asmx

Provides methods for working with users, role definitions, and groups.

AddGroup
AddGroupToRole
AddRole
AddRoleDef
AddUserCollectionToGroup
AddUserCollectionToRole
AddUserToGroup
AddUserToRole
GetAllUserCollectionFromWeb
GetGroupCollection
GetGroupCollectionFromRole
GetGroupCollectionFromSite
GetGroupCollectionFromUser
GetGroupCollectionFromWeb
GetGroupInfo
GetRoleCollection
GetRoleCollectionFromGroup
GetRoleCollectionFromUser
GetRoleCollectionFromWeb
GetRoleInfo
GetRolesAndPermissionsForCurrentUser
GetRolesAndPermissionsForSite
GetUserCollection
GetUserCollectionFromGroup
GetUserCollectionFromRole
GetUserCollectionFromSite
GetUserCollectionFromWeb
GetUserInfo
GetUserLoginFromEmail
RemoveGroup
RemoveGroupFromRole
RemoveRole
RemoveUserCollectionFromGroup
RemoveUserCollectionFromRole
RemoveUserCollectionFromSite
RemoveUserFromGroup
RemoveUserFromRole
RemoveUserFromSite
RemoveUserFromWeb
UpdateGroupInfo
UpdateRoleDefInfo
UpdateRoleInfo
UpdateUserInfo

Versions

http://<Site>/_vti_bin/Versions.asmx

Provides methods for working with file versions.

DeleteAllVersions
DeleteVersion
GetVersions
RestoreVersion

Views

http://<Site>/_vti_bin/Views.asmx

Provides methods for working with views of lists.

AddView
DeleteView
GetView
GetViewCollection
GetViewHtml
UpdateView
UpdateViewHtml
UpdateViewHtml2

Web Part Pages

http://<Site>/_vti_bin/WebPartPages.asmx

Provides methods for working with Web Parts.

AddWebPart
AddWebPartToZone
AssociateWorkflowMarkup
ConvertWebPartFormat
DeleteWebPart
ExecuteProxyUpdates
FetchLegalWorkflowActions
GetAssemblyMetaData
GetBindingResourceData
GetCustomControlList
GetDataFromDataSourceControl
GetFormCapabilityFromDataSourceControl
GetSafeAssemblyInfo
GetWebPart
GetWebPart2
GetWebPartCrossPageCompatibility
GetWebPartPage
GetWebPartPageConnectionInfo
GetWebPartPageDocument
GetWebPartProperties
GetWebPartProperties2
GetXmlDataFromDataSource
RemoveWorkflowAssociation
RenderWebPartForEdit
SaveWebPart
SaveWebPart2
ValidateWorkflowMarkupAndCreateSupportObjects

Webs

http://<Site>/_vti_bin/Webs.asmx

Provides methods for working with sites and subsites.

CreateContentType
CustomizeCss
DeleteContentType
GetActivatedFeatures
GetAllSubWebCollection
GetColumns
GetContentType
GetContentTypes
GetCustomizedPageStatus
GetListTemplates
GetWeb
GetWebCollection
RemoveContentTypeXmlDocument
RevertAllFileContentStreams
RevertCss
RevertFileContentStream
UpdateColumns
UpdateContentType
UpdateContentTypeXmlDocument
WebUrlFromPageUrl