This document provides the details of the application
programming interface (API) for the SharePoint2007Provider
namespace included with the Microsoft Provisioning System (MPS) in
the Microsoft Hosted Solutions. Contained herein are descriptions
of the procedures of this namespace along with method input
parameters and return values. In addition, example Extensible
Markup Language (XML) requests are provided along with a typical
XML response that the provisioning system returns after a request
is submitted to MPS and tasks are completed. Developers should use
this API document as a reference when creating XML requests that
initiate the provisioning of Microsoft Office SharePoint 2007
services or as a basis for review of the SharePoint 2007 named
procedures that are implemented in the Web Service.
| Public Method |
Description |
| SharePoint2007Provider::AddGroup
|
Adds a cross-site group to WSS. Fails if the group already
exists. Rollback deletes the group. |
| SharePoint2007Provider::AddGroupToRole
|
Adds a cross-site group to the specified role (site group).
This method implements rollback. |
| SharePoint2007Provider::AddQuotaTemplate
|
Creates a new quota template and adds it to the global list of
quota templates. |
| SharePoint2007Provider::AddRole
|
Adds a site group to the WSS site. Rollback deletes the site
group. |
| SharePoint2007Provider::AddUsersToGroup
|
Adds one or more user accounts to the specified cross-site
group. This call implements rollback. |
| SharePoint2007Provider::AddUsersToRole
|
Adds one or more user accounts to the specified site group.
This call implements rollback. |
| SharePoint2007Provider::CreateSite
|
Creates and enables a Microsoft SharePoint site on the
specified server. |
| SharePoint2007Provider::CreateSubSite
|
Creates a sub site of the specified parent Sharepoint
site. |
| SharePoint2007Provider::DeleteQuotaTemplate
|
Deletes an existing quota template from the global quota
template list. |
| SharePoint2007Provider::DeleteSite
|
Removes a Microsoft SharePoint site of the type create with
CreateSite. |
| SharePoint2007Provider::DeleteSubSite
|
Deletes the specified Sharepoint sub site. |
| SharePoint2007Provider::EnumerateFolder
|
Returns information about the files and folders within a folder
on a SharePoint site. |
| SharePoint2007Provider::GetAllSubWebs
|
Returns the titles and URLs of all sites within the current
site collection. |
| SharePoint2007Provider::GetAllUsersFromWeb
|
Returns information about the collection of users for the
current site. |
| SharePoint2007Provider::GetAttachments
|
Returns the URLs for all attachments to a specified item in a
SharePoint list. |
| SharePoint2007Provider::GetGroupInfo
|
Returns information about one or more specified cross-site
groups in the current site collection. |
| SharePoint2007Provider::GetGroupsFromRole
|
Returns information about the collection of cross-site groups
assigned to the specified site group. |
| SharePoint2007Provider::GetGroupsFromSite
|
Returns information about the collection of cross-site groups
for the current site collection. |
| SharePoint2007Provider::GetGroupsFromUser
|
Returns information about the collection of cross-site groups
of which the specified user is a member. |
| SharePoint2007Provider::GetGroupsFromWeb
|
Returns information about the collection of cross-site groups
for the current site. |
| SharePoint2007Provider::GetLanguages
|
Returns information about the languages used in the deployment
of Microsoft Windows SharePoint Services |
| SharePoint2007Provider::GetList
|
Returns metadata from the specified SharePoint list. |
| SharePoint2007Provider::GetLists
|
Returns information about all the lists in the current
SharePoint site. |
| SharePoint2007Provider::GetListTemplates
|
Returns the collection of list template definitions for the
current site. |
| SharePoint2007Provider::GetPermissions
|
Returns the collection of permissions for a site or list. |
| SharePoint2007Provider::GetQuotaTemplates
|
Gets the specified quota template or, if none is specified,
gets them all. |
| SharePoint2007Provider::GetRoleInfo
|
Returns information about the specified collection of groups
for the current site. |
| SharePoint2007Provider::GetRolesFromGroup
|
Returns information about the collection of site groups of
which the specified cross-site group is a member. |
| SharePoint2007Provider::GetRolesFromUser
|
Returns information about the collection of site groups of
which the specified user is a member. |
| SharePoint2007Provider::GetRolesFromWeb
|
Returns information about the collection of site groups for the
current site. |
| SharePoint2007Provider::GetServiceAccountDirectoryPaths
|
Retrieves the service Account Directory paths of web
applications on a target server. |
| SharePoint2007Provider::GetSite
|
Returns site metadata, information about the subsites in the
current site collection, and information about the cross-site
groups on the site and about the users who are members of each
group. |
| SharePoint2007Provider::GetSiteAndWeb
|
Returns the absolute URL of a subsite and the absolute URL of
its top-level parent site based on the specified site URL. |
| SharePoint2007Provider::GetSiteQuota
|
Gets the quota for the specified SharePoint site
collection. |
| SharePoint2007Provider::GetSiteTemplates
|
Returns information about the collection of site definitions
and site templates on the virtual server. |
| SharePoint2007Provider::GetSiteTypeAndGUIDs
|
Returns information about the site collection type and the
GUIDs of site collection and subsite. |
| SharePoint2007Provider::GetUserInfo
|
Returns information about a collection of one or more users
based on the specified user names. |
| SharePoint2007Provider::GetUserLoginFromEmail
|
Returns one or more user names based on the specified e-mail
address. |
| SharePoint2007Provider::GetUsersFromRole
|
Returns information about the collection of users in the
specified site group. |
| SharePoint2007Provider::GetUsersFromSite
|
Returns information about the collection of users for the
current site collection. |
| SharePoint2007Provider::GetUsersFromWeb
|
Returns information about the collection of users for the
current site. |
| SharePoint2007Provider::GetWeb
|
Returns site and list metadata, as well as information about
the users and site groups for the current SharePoint site. |
| SharePoint2007Provider::GetWebs
|
Returns properties of a collection of sites (for example, name,
description, and theme). |
| SharePoint2007Provider::ModifyCustomerSite
|
Modifies site properties (Title, Description, Owner,
UserAccountDirectoryPath, and root administrator user container).
It supports rollback. |
| SharePoint2007Provider::ModifyQuotaTemplate
|
Updates an existing quota template with the specified
values. |
|
SharePoint2007Provider::ModifyServiceAccountDirectoryPaths
|
Modifies the service Account Directory paths of all web
applications on a target server. |
| SharePoint2007Provider::ModifySiteQuota
|
Modifies an existing site collection quota. |
| SharePoint2007Provider::QueryListItems
|
Performs a query against the specified SharePoint list. |
| SharePoint2007Provider::RefreshConfigCache
|
Refreshes the configuration cache for the virtual server. |
| SharePoint2007Provider::RemoveGroup
|
Removes the specified cross-site group from the current site
collection. |
| SharePoint2007Provider::RemoveGroupFromRole
|
Removes a cross-site group from the specified site group. This
method implements rollback. |
| SharePoint2007Provider::RemoveRole
|
Removes the specified role from the current site |
| SharePoint2007Provider::RemoveUsersFromGroup
|
Removes the users with the specified user names from the
cross-site group. This call implements rollback. |
| SharePoint2007Provider::RemoveUsersFromRole
|
Removes the users with the specified user names from the
specified site group. This call implements rollback. |
| SharePoint2007Provider::RemoveUsersFromSite
|
Removes the specified users from the current site collection.
This call does not implement rollback. Use RemoveUserFromGroup or
RemoveUserFromRole instead. |
| SharePoint2007Provider::RemoveUserFromWeb
|
Removes the specified user from the current site. This call
does not implement rollback. Use RemoveUserFromGroup or
RemoveUserFromRole instead. |
| SharePoint2007Provider::SetListPermissions
|
Adds, modifies, or removes permissions to the list for the
specified collection of existing users, site groups, and/or
cross-site groups. |
| SharePoint2007Provider::SetSiteQuota
|
Sets a quota on a site collection that limits the system
resources allocated to users. |
| SharePoint2007Provider::UpdateGroupInfo
|
Updates information for the specified cross-site group. The
underlying WSS API does not provide a mechanism for updating any
subset of these parameters, so all of them must be supplied. This
method supports rollback. |
| SharePoint2007Provider::UpdateRoleInfo
|
Updates information for the specified site group. The
underlying WSS API does not provide a mechanism for updating any
subset of these parameters, so all of them must be supplied. This
method supports rollback. |
| SharePoint2007Provider::UpdateUserInfo
|
Updates information for the specified user. The underlying WSS
API does not provide a mechanism for updating any subset of these
parameters, so all of them must be supplied. This method supports
rollback. |
| SharePoint2007Provider::UpdateWebPermissions
|
Modifies site-level permissions for the specified collection of
existing site groups. |
| SharePoint2007Provider::WebUrlFromPageUrl
|
Returns the URL of the parent site for the specified page
URL. |
Applies
To