Windows-based Hosting::DeleteCustomerSharePointSite

  • Article

The DeleteCustomerSharePointSite procedure deletes a Windows SharePoint site collection for a customer.

Arguments

The DeleteCustomerSharePointSite procedure requires the following input parameters.

Input Argument Description

<org>

The Lightweight Directory Access Protocol (LDAP) path of the organization that owns the site.

<siteName>

The site name which is unique within org and is a pointer site and title. You can also use the <site> node for this parameter.

<site>

The absolute URL of the site to be deleted. This is the URL that a user enters to access the site, for example: https://localhost/sites/sp, or https://bucky:90/sites/sp.

<preferredDomainController>

The name of the preferred domain controller.

Output Arguments

The DeleteCustomerSharePointSite procedure has no return values and does not support rollback.

Remarks

Security

The DeleteCustomerSharePointSite procedure has the following security requirements:

  • The caller is impersonated.

  • The caller is tested for OrgCreator permissions.

Process Steps

The following step occurs when deleting a customer SharePoint site with the DeleteCustomerSharePointSite procedure of the Managed Windows-based Hosting Namespace:

  • Delete the site and Active Directory pointers by calling Managed Windows SharePoint Namespace::DeleteCustomerSite.

Sample Code

Example XML Request

The following is an example of an XML request for the DeleteCustomerSharePointSite procedure of the Managed Windows-based Hosting Namespace:

<request> 
        <procedure> 
                <execute namespace="Windows-based Hosting"  
                procedure="DeleteCustomerSharepointSite" impersonate="1"> 
                        <executeData> 
                        <org>LDAP://ou=alpineskihouse,ou=consolidatedmessenger, 
                        ou=hosting,dc=fabrikam,dc=com</org> 
                        <preferredDomainController>AD01-wh.fabrikam.com 
                        </preferredDomainController> 
                        <site>https://www.org5.com</site> 
                        <siteName>wh01-Site6</siteName> 
                        </executeData> 
                </execute> 
        </procedure> 
</request>

Applies To

Managed Windows-based Hosting Namespace API for:

  • Hosted Messaging and Collaboration version 3.5

  • Hosted Messaging and Collaboration version 3.0

  • Windows-based Hosting version 4.5

  • Windows-based Hosting version 4.0

  • Windows-based Hosting version 3.5

  • Windows-based Hosting for Applications version 1.0

See also

Tasks

Windows-based Hosting::CreateCustomerSharePointSite