Monday, January 19

SharePoint Web Services

1. Introduction

SharePoint web services allow remote applications to get and modify SharePoint sites and content.

• Windows SharePoint Services v3 comes with 16 web services.
• Microsoft Office SharePoint Services supports 5 additional web services.
• These services can be used from any web-service aware programming language such as Visual Basic .NET, C#, C++, VBA, Java, and so on.

We can add reference to SharePoint web service using visual studio IDE. The SharePoint web services are implemented in ASP.NET web services. So its extension is .ASMX.

• Physical files for most of these web services are saved in the "Microsoft Shared" directory under "web server extensions\12\ISAPI" typically located at "C:\Program Files\Common Files\Microsoft Shared\web server extensions\12\ISAPI".

• The admin web service for the Central Administration tool is located in the ADMISAPI folder for which the central administration console contains a virtual directory named "_vti_adm".

When a SharePoint site is created it will contain a virtual directory named “_vti_bin” that points to the location of “_vti_adm”.
IIS does not have any information about any virtual directory, however IIS contain mapping to the “_vti_bin” through SharePoint metadata and HttpModules.
For each service there is a *.wsdl.aspx file; that generates the service WSDL (Web Services Description Language), a *.disco.aspx providing the service discovery implementation, and the actual *.asmx endpoint files, most of which simply contain a page directive referencing the SharePoint assembly and type containing the actual implementation for the service.



2. List of All Web Services

Web Services found in WSS v3.

1. Administration Web Service
2. Alerts Web Service
3. Document Workspace Web Service
4. Forms Web Service
5. Imaging Web Service
6. List Data Retrieval Web Service
7. Lists Web Service
8. Meetings Web Service
9. Permissions Web Service
10. Site Data Web Services
11. Sites Web Services
12. Users and Group Web Services
13. Versions Web Services
14. Views Web Services
15. Web Part Pages Web Services
16. Webs Web Services

Web Services found in MOSS 2007.

1. Authentication Web Service
2. Copy Web Service
3. People Web Service
4. SharePoint Directory Management Service
5. Search Web Service

3. Brief Description about the Web Services

WSS v3 Web Services

1. Administration Service (Admin.asmx)

The Administration service provides methods for managing a deployment of Microsoft Windows SharePoint Services, such as for creating or deleting site collections.

Requirements

Namespace: Microsoft.SharePoint.SoapServer
Assembly: Windows SharePoint Services Web Service (in STSSOAP.dll)
Web Reference: http://Server_Name:Port_Number/_vti_adm/Admin.asmx

2. Alerts Service (Alerts.asmx)

The Alerts service provides methods for working with alerts for list items in a SharePoint site.

Requirements

Namespace: Microsoft.SharePoint.SoapServer
Assembly: Windows SharePoint Services Web Service (in STSSOAP.dll)
Web Reference: http://Server_Name/[sites/][Site_Name/]_vti_bin/Alerts.asmx

3. Document Workspace Service (Dws.asmx)

The Document Workspace Web service exposes methods for managing Document Workspace sites and the data they contain. The Document Workspace service is used by Microsoft Office Outlook 2003 in the context of its Shared Attachments feature.

Requirements

Namespace: Microsoft.SharePoint.SoapServer
Assembly: Windows SharePoint Services Web Service (in STSSOAP.dll)
Web Reference: http://Server_Name/_vti_bin/Dws.asmx

4. Forms Service (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.

Requirements

Namespace: Microsoft.SharePoint.SoapServer
Assembly: Windows SharePoint Services Web Service (in STSSOAP.dll)
Web Reference: http://Server_Name/[sites/][Site_Name/]_vti_bin/Forms.asmx

5. Imaging Service (Imaging.asmx)

The Imaging service provides methods that enable to create and manage picture libraries.

Requirements

Namespace: Microsoft.SharePoint.SoapServer
Assembly: Windows SharePoint Services Web Service (in STSSOAP.dll)
Web Reference: http://Server_Name/[sites/][Site_Name/]_vti_bin/Imaging.asmx

6. List Data Retrieval Service (DspSts.asmx)

The List Data Retrieval Service provides a method for performing queries against lists in Microsoft Windows SharePoint Services.

Requirements

Namespace: Microsoft.SharePoint.Dsp.Sts
Assembly: Microsoft.SharePoint.Dsp.Sts (in Microsoft.SharePoint.Dsp.Sts.dll)
Web Reference: http://Server_Name/[sites/][Site_Name/]_vti_bin/DspSts.asmx

7. Lists Service (Lists.asmx)

The Lists service provides methods for working with lists and list data.

Requirements

Namespace: Microsoft.SharePoint.SoapServer
Assembly: Windows SharePoint Services Web Service (in STSSOAP.dll)
Web Reference: http://Server_Name/[sites/][Site_Name/]_vti_bin/Lists.asmx

8. Meetings Service (Meetings.asmx)

The Meetings service provides methods that enable to create and manage Meeting Workspace sites.

Requirements

Namespace: Microsoft.SharePoint.SoapServer
Assembly: Windows SharePoint Services Web Service (in STSSOAP.dll)
Web Reference: http://Server_Name/[sites/][Site_Name/]_vti_bin/Meetings.asmx

9. Permissions Service (Permissions.asmx)

The Permissions service provides methods for working with the permissions for a site or list.

Requirements

Namespace: Microsoft.SharePoint.SoapServer
Assembly: Windows SharePoint Services Web Service (in STSSOAP.dll)
Web Reference: http://Server_Name/[sites/][Site_Name/]_vti_bin/Permissions.asmx
10. Site Data Service (SiteData.asmx)

The Site Data service provides methods that return metadata or list data from sites or lists in Microsoft Windows SharePoint Services.

Requirements

Namespace: Microsoft.SharePoint.SoapServer
Assembly: Windows SharePoint Services Web Service (in STSSOAP.dll)
Web Reference: http://Server_Name/[sites/][Site_Name/]_vti_bin/SiteData.asmx

11. Sites Service (Sites.asmx)

The Sites service provides a method for returning information about the collection of site templates on the virtual server.

Requirements

Namespace: Microsoft.SharePoint.SoapServer
Assembly: Windows SharePoint Services Web Service (in STSSOAP.dll)
Web Reference: http://Server_Name/[sites/][Site_Name/]_vti_bin/Sites.asmx

12. Users and Groups Service (UserGroup.asmx)

The Users and Groups service provides methods for working with users, site groups, and cross-site groups.

Requirements

Namespace: Microsoft.SharePoint.SoapServer
Assembly: Windows SharePoint Services Web Service (in STSSOAP.dll)
Web Reference: http://Server_Name/[sites/][Site_Name/]_vti_bin/UserGroup.asmx

13. Versions Service (Versions.asmx)

The Versions service provides methods for working with file versions.

Requirements

Namespace: Microsoft.SharePoint.SoapServer
Assembly: Windows SharePoint Services Web Service (in STSSOAP.dll)
Web Reference: http://Server_Name/[sites/][Site_Name/]_vti_bin/Versions.asmx

14. Views Service (Views.asmx)

The Views service provides methods for working with views of lists.

Requirements

Namespace: Microsoft.SharePoint.SoapServer
Assembly: Windows SharePoint Services Web Service (in STSSOAP.dll)
Web Reference: http://Server_Name/[sites/][Site_Name/]_vti_bin/Views.asmx

15. Web Part Pages Service (WebPartPages.asmx)

The Web Part Pages service provides methods to send information to and retrieve information from XML Web services.

Requirements

Namespace: Microsoft.SharePoint.SoapServer
Assembly: Windows SharePoint Services (in Microsoft.SharePoint.dll)
Web Reference: http://Server_Name[sites/][Site_Name/]/_vti_bin/WebPartPages.asmx

16 .Webs Service (Webs.asmx)

The Webs service provides methods for working with sites and sub sites.

Requirements

Namespace: Microsoft.SharePoint.SoapServer
Assembly: Windows SharePoint Services Web Service (in STSSOAP.dll)
Web Reference: http://Server_Name/[sites/][Site_Name/]_vti_bin/Webs.asmx

MOSS 2007 Web Services

1. Authentication Web Service (Authentication.asmx):Provides classes for logging on to a SharePoint site that is using forms-based authentication.

2. Copy Web Service (Copy.asmx): Provides services for copying files within a SharePoint site and between SharePoint sites.
Web Reference: http:///_vti_bin/Copy.asmx

3. People Web Service (People.asmx): Provides classes that can be used to associate user identifiers (IDs) with security groups for Windows SharePoint Services Web site permissions.

User IDs are validated against Active Directory Domain Services (ADDS) as well as various role or membership providers. SPGroup security information may also be stored in a collection of cross-site groups for the site collection.
Web Reference: http:///_vti_bin/People.asmx

4. SharePoint Directory Management Service (SharePointemailws.asmx)
Provides classes that enable requests for various management operations for e-mail distribution groups.
5. Search Web Service (Search.asmx)
Enterprise Search in Microsoft Office SharePoint Server 2007 exposes its search functionalities through the Query Web service. This allows you to access Enterprise Search results from client applications and Web applications outside of the context of a SharePoint site.
Web reference: http://[site]/_vti_bin/search.asmx.


4. List of Web Methods of all the Web Services

















2 comments:

Anonymous said...

Hello your web-site url: http://www.blogger.
com/comment.g?blogID=7644135159775309828&postID=130666191183858205 appears to be redirecting to a completely different internet site when I click the
home-page link. You may want to have this looked at.


Here is my website :: parkour pc games

vapcguy said...

This is for beginners? How is anyone supposed to use the names of these services to build a connection to them and get data? This is just a list of services names, what they do, and their location. Great reference for advanced users, but has nothing about how to use any of this programmatically in an application. You ought to change the title of this blog, or add that information - or at least link to it.