WSS 3.0 Web Service Quick Reference

November 24, 2006

Below is a list of all WSS 3.0 web services and their methods. This is not intended to be comprehensive documentation of each service and its methods. This is simply a quick list of web methods intended to simplify the process of finding a particular method.

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
Advertisements

7 Responses to “WSS 3.0 Web Service Quick Reference”

  1. Boss Says:

    Great work Glen,

    We tried the GetListItems method of the webservices lists.asmx,but we are not able to retrive all the items. there is a change in the method which takes 7 args in moss where as 6 args in wss2.0.could u please help us in retrieving all the items thro the above method with an example.

  2. glenc Says:

    To the best of my knowledge this method has some parameters that might effect this. First off, you can choose to specify a view and if you specify a view which filters the contents that would explain what’s happening.

    Second, there’s a query options parameter (I think that’s what it’s called) that lets you specify additional options. For example, if your list has folders, there is an option here to traverse all folders. Without providing that parameter you would not get any items in sub folders.

    Lastly, there’s an item limit parameter and I’m not positive about this but I believe if you pass null it will default to 100. Again – not sure about that one but you could try providing an insanely huge number and see if that fixes your problem.

  3. Sebastian Says:

    i discovered the problem that there is no access to the permissions of items/folders. Any ideas to this topic?


  4. […] 3.0 Web Service References Filed under: Office 12 — CJ @ 9:31 pm I found this on Glen’s site. Kudos to […]


  5. […] 3.0 Web Service Reference Guide Filed under: Office 12 — CJ @ 9:31 pm I found this on Glen’s site. Kudos to […]

  6. Paul Says:

    Hi,

    (WSS 3.0)

    I’m trying to use the Document Workslace.CreateFolder service.

    When I attempt to add a web reference to this in VS.NET 2005, I see the following error:
    The document at the url http://localhost:48386/_vti_bin/DWS.asmx was not recognized as a known document type.
    The error message from each known type may help you fix the problem:
    – Report from ‘DISCO Document’ is ‘Root element is missing.’.
    – Report from ‘http://localhost:48386/_vti_bin/DWS.asmx’ is ‘The document format is not recognized (the content type is ‘text/html; charset=utf-8′).’.
    – Report from ‘WSDL Document’ is ‘The document format is not recognized (the content type is ‘text/html; charset=utf-8′).’.
    – Report from ‘XML Schema’ is ‘The document format is not recognized (the content type is ‘text/html; charset=utf-8′).’.

    Any idea how to make this behave?

    I’m expecting to be able to add the web reference then use it as described in the SDK:
    string strResult = “”;
    strResult =
    dwsWebService.CreateFolder(“http://servername:34399/sites/S1/ERPODocs/RL34567”);
    if (IsDwsErrorResult(strResult))
    {
    int intErrorID = 0;
    string strErrorMsg = “”;
    ParseDwsErrorResult(strResult, out intErrorID, out strErrorMsg);
    MessageBox.Show
    (“A document workspace error occurred.\r\n” +
    “Error number: ” + intErrorID.ToString() + “\r\n” +
    “Error description: ” + strErrorMsg,
    “DWS Error”, MessageBoxButtons.OK, MessageBoxIcon.Error);
    }
    else
    {
    MessageBox.Show
    (“The folder was successfully created.”,
    “Create Folder”, MessageBoxButtons.OK,
    MessageBoxIcon.Information);
    }
    }
    catch (Exception exc)
    {
    MessageBox.Show(“An exception occurred.\r\n” +
    “Description: ” + exc.Message,
    “Exception”, MessageBoxButtons.OK, MessageBoxIcon.Error);
    }

    THanks in advance for any assistance,
    Paul

  7. Gala Says:

    I am trying to make AddPermission method of Permissions web service to work. My code creates Document Workspace (using DWS web service) and then it has to give permissions to two groups that exists on parent site. I am using masks that are marked on msdn as obsolete, maybe that’s why my code is working, but group appears with strange permission that says “Auto-generated …” and group’s users don’t have access to it.
    Have you worked with permissin web service? or possible know how to force document workspace created with DWS service to have inherited from parent site permissions.


Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: