Walkthrough: Creating a Custom Web Service
This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
This programming task provides an overview of how to create a custom Web service that operates within the context of Windows SharePoint Services 3.0. It steps through the process of creating a simple "Hello World" Web service and then shows how to modify the service so that it implements the Windows SharePoint Services 3.0 server-side object model to return site and list data.
Basic Steps for Creating a Web Service
Create an ASP.NET Web service in Microsoft Visual Studio 2005.
Create a class library within the Web service that defines the programming logic for the Web service.
Generate and edit a static discovery file and a Web Services Description Language (WSDL) file.
Deploy the Web service files to the _vti_bin directory.
Create a client application to consume the Web service.
Creating an ASP.NET Web Service in Visual Studio
The first step is to create an ASP.NET Web service Web site in Visual Studio 2005.
To create an ASP.NET Web service
In Visual Studio, click File, point to New, and then select Web Site.
In the Templates box of the New Web Site dialog box, select ASP.NET Web Service, select File System in the Location box, select a programming language and location for the project, and then click OK.
Within the new Web service solution, create a separate class library project to contain the Web service logic. To create the project, click File, point to New, and then select Project.
In the New Project dialog box, select a language in the Project types box, select Class Library in the Templates box, provide a name and location for the project, select Add to Solution in the Solution box, and then click OK.
Add a reference to the System.Web.Services namespace in the class library project. Right-click the project in Solution Explorer, click Add Reference, select System.Web.Services in the Add Reference dialog box, and then click OK.
Replace the default class file in the class library project with the default service class file that Visual Studio provides in the App_Code folder of the Web service.
To replace the class file with the service class file
In Solution Explorer, drag Service.cs or Service.vb to the top node in the class library project.
Delete the Class1.cs or Class1.vb file, and also delete the Service.cs or Service.vb file that remains in the App_Code folder.
Create a strong name for the class library:
In Solution Explorer, right-click the class library project, and then click Properties.
In the Properties dialog box, click Signing, select Sign the assembly, and then select <New> in the Choose a strong name key file list.
In the Create Strong Name Key dialog box, provide a file name for the key, clear the Protect my key file with a password check box, and then click OK.
To build only the class library project, right-click the project in Solution Explorer, and then click Build.
To add your assembly to the global assembly cache (GAC), you can either drag the assembly into the %windows%\assembly directory using 2 instances of Windows Explorer, or use the command line utility gacutil.exe that is installed with the Microsoft .NET Framework SDK 2.0.
To use gacutil.exe to copy the class library DLL into the GAC
To open the Visual Studio command prompt, click Start, point to All Programs, point to Microsoft Visual Studio 2005, point to Visual Studio Tools, and click Visual Studio 2005 Command Prompt.
At the command prompt type a command in the following form, and press ENTER:
gacutil.exe -if "<Full file system path to DLL>".
Now you are ready to modify the assembly information in the default Service.asmx file of the Web service with information for the DLL from the GAC. To get information from the GAC, open the %windows%\assembly directory in Windows Explorer, right-click your assembly, and click Properties.
To open Service.asmx in Solution Explorer, right-click the file and click Open.
Remove the CodeBehind attribute from the page directive in Service.asmx, and modify the contents of the Class attribute so that the directive matches the following format, where the assembly name "MyServiceAssembly" and the public key token are values specified in the Properties dialog box that you opened in step 10:
<%@ WebService Language="C#" Class="Service, MyServiceAssembly, Version=18.104.22.168, Culture=neutral, PublicKeyToken=8f2dca3c0f2d0131" %>
In Visual Basic include the namespace to identify the class, for example, Class="MyServiceNamespace.Service, MyServiceAssembly, Version=22.214.171.124, Culture=neutral, PublicKeyToken=8f2dca3c0f2d0131".
Rename your .asmx file appropriately, and then save your changes.
Generating and Modifying Static Discovery and WSDL Files
To provide discovery and description for your custom Web service, you must create a .disco file and a .wsdl file. Because Windows SharePoint Services virtualizes its URLs (for example, http://MyServer/MySite/MySubsite becomes http://MyServer), you cannot use the autogenerated .disco and .wsdl files generated by ASP.NET. Instead, you must create a .disco page and a .wsdl ASPX page that provide the necessary redirection and maintain virtualization.
You can use ASP.NET to generate the .disco and .wsdl files by temporarily hosting your Web service in a virtual directory, such as /_layouts, and then using the .NET Framework Web Service Discovery tool (Disco.exe) to obtain the generated files.
To generate the static discovery and WSDL files
In Windows Explorer, copy the .asmx file of your Web service to \\Program Files\Common Files\Microsoft Shared\web server extensions\12\TEMPLATE\LAYOUTS.
Run Disco.exe at the command prompt from the LAYOUTS directory to generate .disco and .wsdl files. Run a command in the following format to generate the files in \LAYOUTS:
To register namespaces of the Windows SharePoint Services object model, open both the .disco and .wsdl files and replace the opening XML processing instruction -- <?xml version="1.0" encoding="utf-8"?> -- with instructions such as the following:
<%@ Page Language="C#" Inherits="System.Web.UI.Page" %> <%@ Assembly Name="Microsoft.SharePoint, Version=126.96.36.199, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %> <%@ Import Namespace="Microsoft.SharePoint.Utilities" %> <%@ Import Namespace="Microsoft.SharePoint" %> <% Response.ContentType = "text/xml"; %>
In the .disco file, modify the contract reference and SOAP address tags to be like the following example, which replaces literal paths with code generated paths through use of the Microsoft.SharePoint.Utilities.SPHttpUtility class, and which replaces the method name that is specified in the binding attribute:
<contractRef ref=<% SPHttpUtility.AddQuote(SPHttpUtility.HtmlEncode(SPWeb.OriginalBaseUrl(Request) + "?wsdl"),Response.Output); %> docRef=<% SPHttpUtility.AddQuote(SPHttpUtility.HtmlEncode(SPWeb.OriginalBaseUrl(Request)),Response.Output); %> xmlns="http://schemas.xmlsoap.org/disco/scl/" /> <soap address=<% SPHttpUtility.AddQuote(SPHttpUtility.HtmlEncode(SPWeb.OriginalBaseUrl(Request)),Response.Output); %> xmlns:q1="http://tempuri.org/" binding="q1:HelloWorld" xmlns="http://schemas.xmlsoap.org/disco/soap/" /> <soap address=<% SPHttpUtility.AddQuote(SPHttpUtility.HtmlEncode(SPWeb.OriginalBaseUrl(Request)),Response.Output); %> xmlns:q2="http://tempuri.org/" binding="q2:ServiceSoap12" xmlns="http://schemas.xmlsoap.org/disco/soap/" />
In the .wsdl file, make the following similar substitution for the SOAP address that is specified:
<soap:address location=<% SPHttpUtility.AddQuote(SPHttpUtility.HtmlEncode(SPWeb.OriginalBaseUrl(Request)),Response.Output); %> />
Rename both files in the respective formats MyCustomWebServicedisco.aspx and MyCustomWebServicewsdl.aspx so that your service is discoverable through Windows SharePoint Services.
Copying the Web Service Files to the _vti_bin Directory
The _vti_bin virtual directory maps physically to the Local_Drive:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\ISAPI directory, which contains the default Web service files used in Windows SharePoint Services. Copy the new MyCustomWebServicewsdl.aspx and MyCustomWebServicedisco.aspx files, and also the MyCustomWebService.asmx file, to the ISAPI folder.
From the _vti_bin directory, a Web service offers its functionality to the site that is specified when adding a Web reference for the service.
To verify that your custom Web service is discoverable, navigate to http://MyServer/_vti_bin/MyCustomWebService.asmx.
List the New Web Service in spdisco.aspx
To make your Web service discoverable in Visual Studio as a Web service alongside the default Windows SharePoint Services Web services, open the spdisco.aspx file located in \Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\ISAPI and add the following code, specifying the .asmx file for your Web service.
<contractRef ref=<% SPHttpUtility.AddQuote(SPHttpUtility.HtmlEncode(spWeb.Url + "/_vti_bin/MyCustomWebService.asmx?wsdl"), Response.Output); %> docRef=<% SPHttpUtility.AddQuote(SPHttpUtility.HtmlEncode(spWeb.Url + "/_vti_bin/MyCustomWebService.asmx"), Response.Output); %> xmlns=" http://schemas.xmlsoap.org/disco/scl/ " /> <discoveryRef ref=<% SPHttpUtility.AddQuote(SPHttpUtility.HtmlEncode(spWeb.Url + "/_vti_bin/MyCustomWebService.asmx?disco"),Response.Output); %> xmlns="http://schemas.xmlsoap.org/disco/" />
Creating a Windows Application to Consume the Web Service
After you copy the Web services files to the _vti_bin directory, the next step is to create a Windows Application to consume the Web service.
To create a Windows Application that consumes the Web service
Open Visual Studio 2005, and on the File menu, point to New, and then click Project.
In the New Project dialog box, select Visual C# or Visual Basic, and then select the Windows Application template.
Type a name for the application in the Name box, specify a location for the project files in the Location box, and then click OK.
In Solution Explorer, right-click the project, and then click Add Web Reference.
In the address bar of the Add Web Reference browser, type the URL for the site to apply the service to, as follows, and then press ENTER:
Click Add Reference to download the service contract for the Web service.
Open Form1 in Design view, display the Toolbox, and then drag a button onto the form.
Double-click the Button1 control on Form1 to display the code-behind file in the code editor, and add the following code that calls your custom method.
Dim MyCustomService As New Web_Reference_Folder.MyServiceClass() MyCustomService.UseDefaultCredentials = True MessageBox.Show(MyCustomService.HelloWorld())
Web_Reference_Folder.MyServiceClass MyCustomService = new Web_Reference_Folder.MyServiceClass(); MyCustomService.UseDefaultCredentials = true; MessageBox.Show(MyCustomService.HelloWorld());
Press F5 to compile and run the project and see a message box that displays "Hello World".
Implementing the Windows SharePoint Services Object Model
Now you are ready to try out types and members of the Windows SharePoint Services object model in the class library of your Web service.
To implement the Windows SharePoint Services object model
Add a reference to the Microsoft.SharePoint assembly. Right-click the class library project in Solution Explorer, click Add Reference, select Windows SharePoint Services, and then click OK.
In your project Service.cs or Service.vb file, you must import the appropriate namespaces in the object model. For example, to use types and members of the Microsoft.SharePoint and Microsoft.SharePoint.Utilities namespaces, add the following directives:
Imports Microsoft.SharePoint Imports Microsoft.SharePoint.Utilities
using Microsoft.SharePoint; using Microsoft.SharePoint.Utilities;
Rename the method in Service.cs or Service.vb. For example, change the name from HelloWorld to GetSiteListCount.
Add the following code to display the name of the Web site and the number of lists that it contains.
Dim myWebSite As SPWeb = SPContext.Current.Web Dim lists As SPListCollection = myWebSite.Lists Return myWebSite.Title + " contains " + lists.Count.ToString() + " lists."
SPWeb myWebSite = SPContext.Current.Web; SPListCollection lists = myWebSite.Lists; return (myWebSite.Title + " contains " + lists.Count.ToString() + " lists.");
If your code modifies Windows SharePoint Services data in some way, you may need to allow unsafe updates on the Web site, which you can do by setting the AllowUnsafeUpdates property.
To rebuild the class library DLL and copy it to the GAC, repeat steps 8 and 9 in "To create an ASP.NET Web service."
Reset Internet Information Services (IIS) for changes in the DLL to take effect.
To generate new versions of the .disco and .wsdl files, repeat the steps in "To generate the static discovery and WSDL files," but change the method binding name in the .disco file as appropriate, for example, to GetSiteListCount.
Copy the new versions of the MyCustomWebServicedisco.aspx and MyCustomWebServicewsdl.aspx files to the ISAPI folder.
Open the Windows application you created previously, delete the previous Web service reference for the Hello World example, change the method name as appropriate, and add a new Web reference to the revised Web service.
Press F5 to compile and run the project and see a message box that displays the Web site name and the number of lists that it contains.