SharePoint Web Services | List of all Web Services available with WSS 3.0/MOSS 2007

 

To develop and customize SharePoint applications, we need to interact with SharePoint components like Web Applications, Site Collections, Sites, Custom Lists, Documents Libraries, Permissions, Users, etc. To accomplish this, either we can use SharePoint Object Model or SharePoint Web Services.

SharePoint Object Model is a .Net based Application Programming Interface to interact with SharePoint components. But all the applications written using SharePoint Object Model require to be run on the SharePoint Server itself. It is not possible to use it to work remotely with a SharePoint Server.

SharePoint Web Services provides the capability to work with SharePoint server remotely. But SharePoint Web Services are not as much as rich as SharePoint Object Model and all SharePoint features and components are not accessible through Web Services. But it includes Web Services to interact with most commonly used SharePoint features and components. If out-of-the-box SharePoint Web Services doesn’t fit on our requirements, we can also build custom web service on top of SharePoint leveraging the SharePoint Object Model API.

I had prepared a concise list of SharePoint Web Services for my own reference which I am sharing with you:

1) Administration Web Service (http://<site>/_vti_bin/Admin.asmx):

The Administration Web service provides methods that can beused to manage Windows SharePoint Services such as creating or deleting site collections. Following are the main methods provided by this service:

• CreateSite
• DeleteSite
• GetLanguages
• RefreshConfigCache

2) Alerts Web Service (http://<Site>/_vti_bin/Alerts.asmx):

The alerts web service provides methods for working with alert subscriptions for the listitems in a SharePoint site remotely. Alert subscriptions specify when and how notifications are sent to users when changes are made to content stored on the server. Following are the two main methods provided by this service:

• GetAlerts
• DeleteAlerts

3) Copy Web Service (http://<Site>/_vti_bin/Copy.asmx):

This web service provides capability to move files from one list to another within a SharePoint site or between different SharePoint sites. Following are the main methods provided by this service:

• GetItem
• CopyIntoItems
• CopyIntoItemsLocal

4) Document Workspace Web Service (http://<Site>/_vti_bin/Dws.asmx):

This web service provides methods for managing Document Workspace sites and the data they contain. Following are the main methods provided by this service:

a) Managing Document Workspace sites

• CanCreateDwsUrl
• CreateDws
• RenameDws
• DeleteDws

b) Managing data for the Document Workspace site

• GetDwsData
• GetDwsMetaData
• UpdateDwsData

c) Managing folders in the Document Workspace site

• CreateFolder
• DeleteFolder

d) Managing documents in the Document Workspace site

• FindDwsDoc

e) Managing site users for the Document Workspace site

• RemoveDwsUser

5) Forms Web Service (http://<Site>/_vti_bin/Forms.asmx):
The Forms service provides methods for returning forms that are used in the user interface when working with the contents of a list. There are following two methods available:

• GetForm 
• GetFormCollection

6) Imaging Web Service (http://<Site>/_vti_bin/Imaging.asmx): The Imaging service provides methods that enable you to create and manage picture libraries. There are following methods that can be utilized with the imaging web service:

• CheckSubwebAndList
• CreateNewFolder
• Delete
• Download
• Edit
• GetItemsByIds
• GetItemsXMLData
• GetListItems
• ListPictureLibrary
• Rename
• Upload 

7) Lists Web Service (http://<site>/_vti_bin/Lists.asmx):

The Lists Web service provides methods for working with SharePoint lists, content types, list items, and files. There are following methods that can be utilized with the Lists web service:

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

8) Meetings Web Service (http://<Site>/_vti_bin/Meetings.asmx):

This web service enables you to create and manage Meeting Workspace sites. Following are the main methods available in the web service:

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

9) People Web Service (http://<Site>/_vti_bin/People.asmx):
This service provides methods that can be used to associate user identifiers (IDs) with security groups for SharePoint Web site permissions. It contains following methods:

• GetPrincipalsInGroup
• ResolvePrincipals
• SearchPrincipals

10) Permissions Web Service (http://<site>/_vti_bin/Permissions.asmx):

Permissions Web service provides methods for working with SharePoint list and site permissions. Following are the various methods available in this service:

• AddPermission
• AddPermissionCollection
• GetListItemPermissionsByUser
• GetListPermissionsByUser
• GetPermissionCollection
• GetPermissionsByToken
• GetPermissionsByUser
• RemovePermission
• RemovePermissionCollection
• UpdatePermission

11) SharePoint Directory Management Service (http://<Site>/_vti_bin/sharepointemailws.asmx):
This service provides methods for managing Active Directory e-mail distribution groups and their membership. It provides following main methods:

• CreateContact
• DeleteContact
• ModifyContact
• CreateDistributionGroup
• DeleteDistributionGroup
• ModifyDistributionGroup
• RenameDistributionGroup
• ChangeContactsMembershipInDistributionGroup
• ChangeUsersMembershipInDistributionGroup 

12) Site Data Web Service (http://<Site>/_vti_bin/SiteData.asmx):
The Site Data service provides methods that return metadata or list data from sites or lists in Microsoft Windows SharePoint Services. This web service is read only. Following are the main methods provided by this service:

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

13) Sites Web Service (http://<Site>/_vti_bin/Sites.asmx):
The Sites service provides a method for returning information about the collection of site templates on the virtual server. Following are the main methods provided by this service:

• ExportWeb
• ImportWeb
• GetSiteTemplates
• GetUpdatedFormDigest

14) Search Web Service (http://<site>/_vti_bin/search.asmx):
The QueryService can be used to query the search indexes in the same way that you would search from the home page of a SharePoint site. Main methods available in this service are as below:

• Query
• QueryEx
• GetPortalSearchInfo
• GetSearchMetadata
• Registration
• Status 

15) Users and Groups Web Service (http://<Site>/_vti_bin/usergroup.asmx):
The Users and Groups Web service provides methods for working with users, role definitions, and groups. It provides huge number of methods which are listed below:

• AddGroup
• AddGroupToRole
• AddRole
• AddRoleDef
• AddUserCollectionToGroup
• AddUserCollectionToRole
• AddUserToGroup
• AddUserToRole
• GenerateXmlMappings 
• GetAllUserCollectionFromWeb
• GetGroupCollection
• GetGroupCollectionFromRole
• GetGroupCollectionFromSite
• GetGroupCollectionFromUser
• GetGroupCollectionFromWeb
• GetGroupInfo
• GetHashCode 
• GetLifetimeService 
• 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 

16) Versions Web Service (http://<site>/_vti_bin/Versions.asmx):
Versions Web service provides methods for working with file versions in SharePoint document libraries. Methods included in this service:

• DeleteAllVersions 
• DeleteVersion 
• GetVersions 
• RestoreVersion 

17) Views Web Service (http://<site>/_vti_bin/Views.asmx):
Views Web service provides methods for creating, deleting, or updating list views. Methods included in this service are as below:

• AddView
• DeleteView
• GetView 
• GetViewCollection 
• GetViewHtml 
• UpdateView 
• UpdateViewHtml

18) Web Part Pages Web Service (http://<Site>/_vti_bin/WebPartPages.asmx):
Web Part Pages service provides methods for working with Web Parts. Following are the various methods provided by this service:

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

19) Webs Web Service (http://<Site>/_vti_bin/Webs.asmx):
Webs service provides methods for working with sites and subsites. Following are the various methods provided by this service:

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

To get the full details of above SharePoint Web Services and their respective Methods please visit SharePoint Web Services MSDN Page @ http://msdn.microsoft.com/en-us/library/ms479390.aspx

Fixed header and footer

Fixed header and footer (part of fixed positioning)

Code

<!-- IE in quirks mode -->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<title>Fixed header and footer</title>
<style type="text/css">
 body{
  margin:0;
  padding:header-<length> 0 footer-<length> 0;
 }
 div#header{
  position:absolute;
  top:0;
  left:0;
  width:100%;
  height:header-<length>;
 }
 div#footer{
  position:absolute;
  bottom:0;
  left:0;
  width:100%;
  height:footer-<length>;
 }
 @media screen{
  body>div#header{
   position:fixed;
  }
  body>div#footer{
   position:fixed;
  }
 }
 * html body{
  overflow:hidden;
 } 
 * html div#content{
  height:100%;
  overflow:auto;
 }
</style>
<div id="header"> header </div>
<div id="footer"> footer </div>
<div id="content"> content </div>

Connecting to SharePoint 2007 Web Services

Connecting to SharePoint 2007 Web Services using a Service Reference in Visual Studio 2008

22 April, 2009 2 Comments

When using Service References to consume SharePoint web services, there are a few additional configuration changes that you need to make. The service model configuration that Visual Studio generates is not sufficient when consuming SharePoint web services. This is mainly what we will cover in this post.
You may have noticed in Visual Studio 2008 that Web References are no longer the default option when you wish to reference a Web Service. Instead, you now have an option called “Add Service Reference….”

So what’s the difference between a Web Reference and a Service Reference? Well basically, a Web Reference is a wrapper over wsdl.exe and a Service Reference is a wrapper over svcutil.exe. Service references also have some additional configuration options and are a good choice when planning to consume WCF services.
1. First step, create a new project in Visual Studio. I have created a new Windows Forms Application and targeted it at .NET 3.5.
2. Right click on “References” in the solution explorer and select “Add Service Reference”
3. I am going to connect to the Lists service on my local SharePoint instance. My web application URL is http://localhost:120/ so the Address for Lists Web Service will be http://localhost:120/_vti_bin/Lists.asmx. 

Enter the URL in the Address section and click Go. Make sure you give the service reference a Namespace. I have used “ListReference” for this demo.
4. Next, let’s create a button and combo box on the form. We will use the button to execute a method that gets a list of SharePoint lists on the site and display them in the combo box.

5. Double click the button and we will add some code to the “click” event to invoke the web service method and get the list of Lists.

1: private void button1_Click(object sender, EventArgs e)
2: {
3:     ListsSoapClient client = null;
4:
5:     try
6:     {
7:         client = new ListsSoapClient();
8:
9:         // Open the connection to the web service
10:         client.Open();
11:
12:         // Write some code to query the web service and get a list of 
13:         // Lists.
14:
15:
16:     }
17:     catch (Exception ex)
18:     {
19:         MessageBox.Show(ex.Message, "An error has occured", MessageBoxButtons.OK, MessageBoxIcon.Error);
20:     }
21:     finally
22:     {
23:         client.Close();
24:     }
25: }

6. Next things get interesting. We will need to make some changes to the app.config file (or web.config if you in Web Application) as the automatically generated service binding configuration doesn’t work for a SharePoint service. The main changes we will make are around security as we need to enable impersonation and ensure the connection is made using Windows Authentication.
First change we need to make is in the binding configuration security element. The automatically generated code produces the following configuration settings:

1: <security mode="None">
2:      <transport clientCredentialType="None" proxyCredentialType="None" realm="" />
3:      <message clientCredentialType="UserName" algorithmSuite="Default" />
4: </security>

we will need to change it to the following:

1: <security mode="TransportCredentialOnly">
2:   <transport clientCredentialType="Ntlm" proxyCredentialType="Ntlm"/>
3: </security>

Next, we will need to add a service behaviour. By default, no service behaviours are generated. This behaviour will enable impersonation.

1: <behaviors>
2:   <endpointBehaviors>
3:     <behavior name="ListServiceBehavior">
4:       <clientCredentials>
5:         <windows allowedImpersonationLevel="Impersonation"/>
6:       </clientCredentials>
7:     </behavior>
8:   </endpointBehaviors>
9: </behaviors>

And add a reference to this Behaviour in the endpoint configuration:

1: <endpoint address="http://localhost:120/_vti_bin/Lists.asmx"
2:     binding="basicHttpBinding" bindingConfiguration="ListsSoap"
3:     contract="ListReference.ListsSoap" name="ListsSoap"
4:     behaviorConfiguration="ListsServiceBehavior"/>

OK. That’s the service binding configuration sorted. Now back to our code….
7.  In the button click method, add the following code in the try{..} block after we open the connection to the service.

1: var response = client.GetListCollection();
2: foreach (XmlNode listNode in response.ChildNodes)
3: {
4:     comboBox1.Items.Add(listNode.Attributes.GetNamedItem("Title").Value);
5: }

And there you have it. Run your application, click the button and you should get a list of Lists!

jQuery and Sharepoint Web Services: GetListItems with queries

jQuery and Sharepoint Web Services: GetListItems with queries

// November 23rd, 2010 // Uncategorized

I recently did another post, detailing deleting a list through the use of Sharepoint Web Services. In this post ill give you a codesample on how to query a list using the item ID and the list name.
The business case for this, was to add a context menu item based on an item property, in my case, document status. Manipulating context menu items is a long winded process, one which is best read in posts such as this post or another post here
Essentially this method was called just before the item is added to the context menu item, it is intercepted at the Custom_AddListMenuItems method which allows you to add list menu items. In the method below, i use the local ID of the conext menu item clicked, together with the list guid (ctx.listname) and i query the list for the document status of that item.
I only add the menu item when docstatus is not equal to published. Another interesting note is the ajax call is done synchronously which forces the program halt execution until the ajax call has received a response from the web service.

 function ShowModerationHistory(currentItemID, r, t, m, v, y) {
<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>

function ShowModerationHistory(currentItemID, r, t, m, v, y) {
	var returnValue = false;
	var soapEnv =
	"<soapenv:Envelope xmlns:soapenv='http://schemas.xmlsoap.org/soap/envelope/'> \
	$.ajax({
	url: SP.PageContextInfo.get_webServerRelativeUrl() + "/_vti_bin/lists.asmx",
	type: "POST",
	dataType: "xml",
	data: soapEnv,
	async: false,
	complete: function (xData, status) {
	var docStatus = $(xData.responseXML).find("z\\:row:eq(0)").attr("ows_DocumentStatus");
	if (docStatus != null && docStatus != undefined) {
	if (docStatus.toUpperCase() != "PUBLISHED") {
	x = CIMOpt(r, t, m, v, null, y);
	}
	}
	},
	beforeSend: function (xhr) {
	xhr.setRequestHeader('SOAPAction', 'http://schemas.microsoft.com/sharepoint/soap/GetListItems');
	},
	contentType: "text/xml; charset=\"utf-8\""
	});

Dynamic Listbox using JavaScript

Dynamic combobox-listbox-drop-down using javascript

Want to populate dynamically combobox-listbox-drop-down using javascript? Let us see a very simple script to do this. First let us see createElement() of document object in javascript.

?

1 2 3 4 5 6 7 8

//Create a table element dynamically var table = document.createElement("table");    //Create a select element dynamically var select = document.createElement("select");    //Create a option element dynamically var option = document.createElement("option");

Thus, createElement method takes a parameter which is the string that specifies the name for the element node and returns the element node.
Let us see how can we populate a dropdown or combobox using this method. Following is the html file of our example:

?

01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16

<HTML>     <HEAD>         <TITLE>Dynamically populating drop down, combobox, list box using JavaScript</TITLE>         <SCRIPT language="javascript" src="config.js"></SCRIPT>     </HEAD>     <BODY style="font-family: sans-serif">            <fieldset>             <legend>Combo box</legend>             Add to Combo: <input type="text" name="txtCombo" id="txtCombo"/>             <input type="button" value="Add" onclick="addCombo()">             <br/>             Combobox: <select name="combo" id="combo"></select>         </fieldset>     </BODY> </HTML>

And following is the javascript file:

?

01 02 03 04 05 06 07 08 09 10 11 12 13 14

function addCombo() {     var textb = document.getElementById("txtCombo");     var combo = document.getElementById("combo");        var option = document.createElement("option");     option.text = textb.value;     option.value = textb.value;     try {         combo.add(option, null); //Standard     }catch(error) {         combo.add(option); // IE only     }     textb.value = ""; }

Thus, when we provide a value in text box and click the Add button, a new option element is created using document.createElement method. The attributes of the option element are set using the method .setAttribute(). And finally the option is added to combo using .add() method.

 

Get user collection from web using SPServices for SharePoint

<script type="text/javascript" src="/SRC/SRCjQuery/jquery-1.4.2.min.js"></script>
<script language="javascript" type="text/javascript" src="/SRC/SRCjQuery/jquery.SPServices-0.5.4.min.js"></script>
<script type="text/javascript">
/* place code right before the matching closing tag </asp:Content> for <asp:Content ContentPlaceHolderId="PlaceHolderMain" runat="server">*/
  $(document).ready(function() {
    $().SPServices({
      operation: "GetGroupCollectionFromUser",
      userLoginName: $().SPServices.SPGetCurrentUser(),
      async: false,
      completefunc: function(xData, Status) {
        if($(xData.responseXML).find("Group[Name='GroupName']").length == 1) {
          $("#zz9_ID_PersonalizePage").remove();
          /*   zz5_ID_LoginAsDifferentUser
               zz6_ID_RequestAccess
               zz7_ID_Logout
               zz8_MSOMenu_ChangePassword
               zz9_ID_PersonalizePage   */
        }
      }
   }); /*close().SPServices({ */
}); /* close (document).ready(function() { */
</script>

GetAllUserCollectionFromWeb
$().SPServices({
    operation: "GetAllUserCollectionFromWeb",
    webUrl: "http://url/s",
    completefunc: function (xData, Status) {
    $(xData.responseXML).find("User").each(function() {
       var perms =$(this).attr("RoleName");
        var liHtml = "<li>" + $(this).attr("ows_Title") + "</li>";
       i=1;
       if(i==1)
       {
      alert(liHtml );
     
      }
      i=i +1;
});
     }
});

Using jQuery to return all users of a group in SharePoint

Using jQuery to return all members / users of a group in SharePoint

Determine if a user is within a particular group in SharePoint and act upon the output.
Luckily the standard SharePoint web services allow to query for this information utilising the User Group service at location: http://<server>/_vti_bin/usergroup.asmx.
In particular the method GetUserCollectionFromGroup will provide the complete list including the Windows SAMAccountName (login name) as part of the return.
However, in this instance I was caught a little by a permissions problem.  Although I could query the web service, it kept returning a status of “parsererror” and an output of “Access Denied”.
This was resolved by changing the group settings to allow “Everyone” to read the membership of the group.

Code Example
The following code utilises jQuery to access the web service:

 1 <script type='text/javascript'>
 2 
 3 _spBodyOnLoadFunctionNames.push("getUserCollectionFromGroup");
 4 
 5 function getUserCollectionFromGroup() {
 6  var soapEnv =
 7       "<soap:Envelope xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:soap='http://schemas.xmlsoap.org/soap/envelope/'> \
 8       <soap:Body> \
 9         <GetUserCollectionFromGroup xmlns='http://schemas.microsoft.com/sharepoint/soap/directory/'> \
10           <groupName>Group Name Here</groupName> \
11         </GetUserCollectionFromGroup> \
12       </soap:Body> \
13     </soap:Envelope>";
14  $.ajax({
15          url: "/_vti_bin/usergroup.asmx",
16          type: "POST",
17          dataType: "xml",
18          data: soapEnv,
19          complete: getUserCollectionFromGroupReturn,
20          contentType: "text/xml; charset=\"utf-8\""
21      });
22 }
23 function getUserCollectionFromGroupReturn(xData, status) {
24  alert("Status: " + status);
25  alert("Output: " + xData.responseText);
26 }
27 </script>
28