SharePoint Front-End Protocols

The Microsoft SharePoint Products and Technologies protocol documentation provides detailed technical specifications for Microsoft proprietary protocols (including extensions to industry-standard or other published protocols) that are used by SharePoint Products and Technologies software (namely Microsoft Office SharePoint Server 2007 with Service Pack 1 applied and Windows SharePoint Services 3.0 with Service Pack 1 applied) to communicate with other Microsoft products.

This section includes a set of companion overview and reference documents pertaining to protocols where SharePoint Products and Technologies implement only one of the protocol endpoints. These protocols are intended for interoperability between SharePoint Products and Technologies and external applications. The documents supplement the technical specifications with conceptual background, overviews of inter-protocol relationships and interactions, and technical reference information.

Audience

The Microsoft SharePoint Products and Technologies protocol documentation is intended for use in conjunction with publicly available standard specifications, and network programming art. It assumes that the reader either is familiar with this material or has immediate access to it.

The technical documentation provides the following levels of audience support:

• Implementer: Sufficient conceptual and reference information for a successful implementation of one or more protocol specifications for a given task or scenario.

• Reviewer: A definitive resource for readers who want to evaluate or understand one or more protocols.

Protocol	Description
[MS-ADMINS]: Administration Web Service Protocol Specification	The [MS-ADMINS]: Administration Web Service protocol specification describes the Administration Web Services protocol. This protocol allows a protocol client to create and delete Web sites and to retrieve information about which languages are supported by a Web site.
[MS-ADMWS]: Search Service Administration Web Service Protocol Specification	The [MS-ADMWS]: Search Service Administration Web Service Protocol specification specifies a protocol that enables the protocol client to configure and control the crawling function of the search subsystem.
[MS-ALERTSS]: Alerts Service Protocol Specification	The [MS-ALERTSS]: Alerts Service protocol specification describes the Alerts Service protocol. This protocol allows the remote enumeration and management of alerts on a SharePoint server.
[MS-AUTHWS]: Authentication Web Service Protocol Specification	The [MS-AUTHWS]: Authentication Web Service protocol specification describes the Authentication Web services protocol, which enables a protocol client to specify a proxy that provides user authentication for Web sites that use forms-based authentication.
[MS-BDCDP]: Business Data Catalog Data Web Service Protocol Specification	The [MS-BDCDP]: Business Data Catalog Data Web Service Protocol specification describes the BDC Data Web Service Protocol. Enterprises have a variety of data stored in various line-of-business systems (LOB systems). It is desirable to be able to provide a uniform selection or pick a user experience to access such data that works against all types of LOB systems. This protocol enables such an experience to be built by describing LOB systems in terms of Models of LobSystem objects, LobSystem instances and the business data types they store as entities. It also specifies how the selection process functions between protocol client and protocol server.
[MS-BDCMP]: Business Data Catalog Metadata Web Service Protocol Specification	[MS-BDCMP]: Business Data Catalog Metadata Web Service Protocol specification desciribes the protocol that enables the clients to query the business data stored on the server side business data catalog.
[MS-CDEPLOY]: Content Deployment Remote Import Web Service Protocol Specification	[MS-CDEPLOY]: Content Deployment Remote Import Web Service Protocol specification specifies a protocol that enables a protocol client to remotely manage the import of a set of content, previous exported from an export server, to a protocol server.
[MS-CONATB]: Content Area Toolbox Web Service Protocol Specification	The [MS-CONATB]: Content Area Toolbox Web Service Protocol specification describes the Content Area Toolbox Web Service protocol that enables a protocol client to enumerate the Web controls available for use on a Web page stored on a protocol server. A typical scenario is a Web page editing application that queries the protocol server for Web controls to display them to the user for insertion into a Web page.
[MS-COPYS]: Copy Web Service Protocol Specification	The [MS-COPYS]: Copy Web Service Protocol specification describes a method of copying files along with its associated properties such as creation date, author, to one or more locations inside a single server or between different servers.
[MS-DOCTRANS]: Document Transforms Service Protocol Specification	The [MS-DOCTRANS]: Document Transforms Service Protocol specification describes a protocol that grants a protocol client the ability to call a file conversion service which converts a file from one format to another.
[MS-DSPSTSS]: Data-Source Adapter SharePoint Team Services Service Protocol Specification	The [MS-DSPSTSS]: Data-Source Adapter SharePoint Team Services Web Service Protocol specification describes the MS-DSPSTSS protocol that provides access to list data and site data by using a Web service.
[MS-DWSS]: Document Workspace Web Service Protocol Specification	The [MS-DWSS]: Document Workspace Web Service Protocol specification specifies the Document Workspace Web service protocol. This protocol allows the remote manipulation of Document Workspace sites created on a server running Microsoft SharePoint Products and Technologies.
[MS-EAWF]: Group Approval Web Services Protocol Specification	The [MS-EAWF]: Group Approval Web Service Protocol specification describes the Group Approval Web service protocol. This protocol enables the protocol client to specify and retreive data required to submit or approve Group Approval documents.
[MS-ESP]: Excel Web Services Protocol Specification	The [MS-ESP]: Excel Web Services Protocol specification specifies how to read from, and perform basic operations on spreadsheets hosted on a server.
[MS-ESURL]: Excel Services Publishing Protocol Specification	The [MS-ESURL]: Excel Services Publishing Protocol specification specifies how the protocol client should form the URL to the protocol server in order to display the contents of a published workbook in the browser.
[MS-EXSPWS]: Excel Calculation Web Service Protocol Specification	The [MS-EXSPWS]: Excel Calculation Web Service Protocol specification describes the protocol that enables communication between a protocol client that displays spreadsheets for viewing and interacting with a protocol server that loads and calculates spreadsheets.
[MS-FORMS]: Forms Service Protocol Specification	The [MS-FORMS]: Forms Service Protocol specification specifies the communication sequences used by a protocol client to get a list of forms from a protocol server, and to get individual forms from that list.
[MS-FSDAP]: Forms Services Design and Activation Web Service Protocol Specification	The [MS-FSDAP]: Forms Services Design and Activation Web Service Protocol specification describes a protocol that specifies methods for transforming an electronic form into a format that can be rendered in a Web browser, and for retrieving a list of issues that would prevent this transformation (if any).
[MS-FSFDP]: Forms Services Feature Detection Protocol Specification	The [MS-FSFDP]: Forms Services Feature Detection Protocol specification specifies methods to determine if a server supports rendering electronic forms in a Web browser, and to construct URLs used to render forms in a Web browser.
[MS-FSPP]: Forms Services Proxy Web Service Protocol Specification	The [MS-FSPP]: Forms Services Proxy Web Service Protocol specification specifies a method by which a protocol server can act as a proxy to forward a SOAP request from a client to a Web service.
[MS-GLOADWS]: Global Admin Web Service Protocol Specification	The [MS-GLOADWS]: Global Admin Web Service Protocol specification specifies the Search Global Administration Web Service Protocol. The Search Global Administration Web Service Protocol enables remote administration of the search application.
[MS-IMAGS]: Imaging Service Protocol Specification	The [MS-IMAGS]: Imaging Service Protocol specification describes the protocol that specifies a set of methods for a client to retrieve, upload and organize images on a protocol server.
[MS-IPFF]: InfoPath Form Template Format Structure Specification	The [MS-IPFF]: InfoPath Form Template Format Structure specification defines the file format for InfoPath form template (.xsn) files, which contain the visualization, schema, and editing behaviors for a form.
[MS-IPFFX]: InfoPath Form File Format Specification	The [MS-IPFFX]: InfoPath Form File Format specification describes the file format for InfoPath form files (XML) used to store a filled-out form.
[MS-LISTSWS]: Lists Web Service Protocol Specification	The [MS-LISTSWS]: Lists Web Service Protocol specification defines the protocol that enables a protocol client to perform tasks related to list based content on a protocol server.
[MS-MEETS]: Meetings Web Services Protocol Specification	The [MS-MEETS]: Meetings Web Services Protocol specification describes the protocol that provides methods to create and update Meeting Workspace sites.
[MS-METAWEB]: MetaWeblog Extensions Protocol Specification	The [MS-METAWEB]: MetaWeblog Extensions Protocol specification defines a set of extensions to the MetaWeblog API to allow for more secure authentication mechanisms.
[MS-MOSSUAN]: SQL Usage Analytics Protocol Specification	The [MS-MOSSUAN]: SQL Usage Analytics Protocol specification describes the protocol that specifies methods for accessing and interacting with historical usage information collected by Microsoft Office SharePoint Server.
[MS-OFBA]: Office Forms-Based Authentication Protocol Specification	The [MS-OFBA]: Office Forms-Based Authentication Protocol Specification provides support for Forms based authentication (FBA) in Microsoft Office over the HTTP Protocol (for more information, see [RFC2616]) in addition to other standard authentication mechanisms. This provides the benefits of forms based authentication for Microsoft Office when other authentication mechanisms (as as specified in [RFC4559] and [RFC2617]) are not available.
[MS-OFFICIALFILE]: Official File Web Service Protocol Specification	The [MS-OFFICIALFILE]: Official File Web Service Protocol specification describes the protocol that enables the submission of files to a repository.
[MS-OSALER]: Alerts Interop Protocol Specification	The [MS-OSALER]: Alerts Interop Protocol specification defines how to identify and interpret alert email messages sent by Microsoft SharePoint Products and Technologies, including embedded metadata and the usage of that metadata.
[MS-OUTSPS]: Lists Client Sync Protocol Specification	The [MS-OUTSPS]: Lists Client Sync Protocol Specification describes the Lists Client Sync Protocol. Clients can use this protocol to transfer data to and from a server that implements the Lists Web service.
[MS-PEOPS]: People Web Service Protocol Specification	The [MS-PEOPS]: People Web Service Protocol specification describes the People Web Services protocol that enables a protocol client to resolve and find principals. The protocol allows the protocol client to pass criteria, which consist of a list of keys and the principal type, to the protocol server and to receive back a list of resolved principals.
[MS-PERMS]: Permissions Web Service Protocol Specification	The [MS-PERMS]: Permissions Web Service Protocol specification specifies the Permissions Service Protocol which enables clients to manage permissions to server items.
[MS-PLSP]: Published Links Web Service Protocol Specification	The [MS-PLSP]: Published Links Web Service Protocol specification describes the protocol that allows an application to retrieve a list of URLs that may be useful from the server.
[MS-PRIMEPF]: Deployment Package Format Specification	The [MS-PRIMEPF]: Deployment Package Format specification describes a file format that can be used to transfer or store the structure and content of Web sites.
[MS-PRSTFR]: ADO XML Persistence Format Protocol Specification	The [MS-PRSTFR]: ADO XML Persistence Format Protocol specification specifies the subset of the ADO XML Persistence Format used by some communication protocols to represent the tabular data retrieved from relational databases.
[MS-PUBWS]: Publishing Web Service Protocol Specification	The [MS-PUBWS]: Publishing Web Service Protocol specification describes the protocol that enables a protocol client to perform tasks related to template-based published content on a protocol server.
[MS-SEARCH]: Search Protocol Specification	The [MS-SEARCH]: Search Protocol specification describes the query interface for the search functionality in Microsoft Office SharePoint Server and Windows SharePoint Services.
[MS-SITED3S]: Site Data 2003 Web Service Protocol Specification	The [MS-SITED3S]: Site Data 2003 Web Service Protocol specification describes the protocol is used for building the site content index.
[MS-SITEDATS]: Site Data Web Service Protocol Specification	The [MS-SITEDATS]: Site Data Web Service Protocol specification describes the protocol that is used for full and incremental indexing of the site content.
[MS-SITESS]: Sites Web Service Protocol Specification	The [MS-SITESS]: Sites Web Service Protocol specification describes the Sites Web service protocol This protocol enables a protocol client to execute tasks on a site.
[MS-SLIDELI]: Slide Library Web Service Protocol Specification	The [MS-SLIDELI]: Slide Library Web Service Protocol specification describes the Slide Library Web service protocol that enables protocol clients to obtain information about slides in a slide library on protocol server.
[MS-SPEMAWS]: SharePoint E-Mail Web Service Protocol Specification	The [MS-SPEMAWS]: SharePoint E-Mail Web Service Protocol specification describes a SOAP-based protocol that enables contact and distribution group management in the Microsoft Active Directory directory services from a server running Microsoft SharePoint Products and Technologies.
[MS-SPLCHK]: SpellCheck Web Service Protocol Specification	The [MS-SPLCHK]: SpellCheck Web Service Protocol specification specifies the SpellCheck Web service protocol. This protocol enables a protocol client to check the spelling of a set of words. The protocol allows the protocol client to pass a set of text to the protocol server and to receive back from the protocol server a set of words identified as containing errors and suggestions for correcting those errors.
[MS-SPRSS]: RSS 2.0 Format Extensions Specification	The [MS-SPRSS]: RSS 2.0 Format Extensions specification specifies extensions to the Really Simple Syndication (RSS) 2.0 Format.
[MS-SPSCRWL]: SPSCrawl Web Service Protocol Specification	The [MS-SPSCRWL]: SPSCrawl Web Service Protocol specification describes the SPSCrawl Web service that allows clients to read the value of item properties for any items on the server.
[MS-SQP]: MSSearch Query Protocol Specification	The [MS-SQP]: MSSearch Query Protocol specification specifies the MS Search Query protocol that enables protocol client to communicate with the protocol server hosting a search service to issue queries.
[MS-SSP]: Single Sign-On Protocol Specification	The [MS-SSP]: Single Sign-On Protocol specification describes the Single Sign-On Service Protocol, which is used by protocol clients of [MS-SSOSP] to obtain a master secret from a master secret server.
[MS-STSSYN]: StsSync Structure Specification	The [MS-STSSYN]: StsSync Structure specification specifies a structure for encoding parameters necessary to connect to a remote list.
[MS-UGS]: UserGroup Web Service Protocol Specification	The [MS-UGS]: UserGroup Web Service Protocol specification describes the UserGroup Web service protocol. This protocol enables the protocol client to define, modify, and retrieve information about users or groups and the role definitions to which they are assigned in a particular site or site collection.
[MS-USPSWS]: User Profile Service Web Service Protocol Specification	The [MS-USPSWS]: User Profile Service Web Service Protocol specification specifies a Web service to retrieve user profile data and data in common among users, as well as to manage user profile properties, links, group memberships, and colleagues.
[MS-USRPCH]: User Profile Change Log Web Service Protocol Specification	The [MS-USPSWS]: User Profile Service Web Service Protocol specification specifies a Web service to retrieve user profile data and data in common among users, as well as to manage user profile properties, links, group memberships, and colleagues.
[MS-VERSS]: Versions Web Service Protocol Specification	The [MS-VERSS]: Versions Web Service Protocol Specification specifies the Versions Web service protocol that enables the protocol client to view and manage the versions of files on the server.
[MS-VIEWSS]: Views Web Service Protocol Specification	The [MS-VIEWSS]: Views Web Service Protocol specification describes the Views Web service protocol that enables a protocol client to manage a list view.
[MS-WDVMODUU]: Office Document Update Utility Extensions Protocol Specification	The [MS-WDVMODUU]: Office Document Update Utility Extensions Protocol secification describes extended protocol for synchronization management between a WebDAV client and a Document Workspace site on a WebDAV server.
[MS-WEBDAVE]: Web Distributed Authoring and Versioning Error Extensions Protocol Specification	The [MS-WEBDAVE]: Web Distributed Authoring and Versioning Error Extensions Protocol specification specifies the currently implemented extended error codes between WebDAV servers and WebDAV clients.
[MS-WEBSS]: Webs Web Service Protocol Specification	The [MS-WEBSS]: Webs Web Service Protocol specification describes the Webs Web service protocol. This protocol provides methods for modifying sites in the site collection.
[MS-WPPS]: Web Part Pages Web Service Protocol Specification	The [MS-WPPS]: Web Part Pages Web Service Protocol specification describes the Web Part Pages Web service. This protocol enables a client to gather the information necessary to create browsable Web pages and that use server resources as well as to create execution logic that reacts to changes in the server state.
[MS-WSSCAML]: Collaborative Application Markup Language (CAML) Structure Specification	The [MS-WSSCAML]: Collaborative Application Markup Language (CAML) Structure specification specifies XML-based formats for queries, lists, and content types in Windows SharePoint Services, as used by other protocols.
[MS-WSSCAP]: Windows SharePoint Services Collaborative Application Protocol Specification	The [MS-WSSCAP]: Windows SharePoint Services Collaborative Application Protocol specification specifies the communication between the client and front-end Web server to get and manipulate lists, list views, and Web discussions on the server. The protocol allows the client to manage the schema and properties of the lists, create, and modify fields, and render list views. It also allows for retrieving the schemas of sites on the server.
[MS-WSSHP]: HTTP Windows SharePoint Services Headers Protocol Specification	The [MS-WSSHP]: HTTP Windows SharePoint Services Headers Protocol specification extends the Hypertext Transfer Protocol (HTTP) mechanisms specified in [RFC2616] to include new headers and messages that enable previously undefined behaviors, such as authenticating client connections, communicating error conditions, sending complex data, interacting with information rights management systems, interacting with antivirus systems, and interacting with crawlers.
[MS-WSSTS]: Windows SharePoint Services: Technical Specification	The [MS-WSSTS]: Windows SharePoint Services: Technical specification provides an overview of abstract data structures, and specifies fields, field types, and lists used by protocols used in Microsoft SharePoint Products and Technologies.
[MS-WWSP]: Workflow Web Service Protocol Specification	The [MS-WWSP]: Workflow Web Service Protocol specification specifies the communication sequences used to query, start, and manipulate workflows on a document.