Windows-based Hosting::CreateCustomerSharePointSite

  • Article

The CreateCustomerSharePointSite procedure creates a Windows SharePoint site collection for a customer.

Arguments

The CreateCustomerSharePointSite procedure requires the following input parameters.

Input Argument Description

<org>

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

<target>

The URL of the Windows SharePoint administration site.

<siteName>

The site name which has to be unique within the org. Name of the pointer in step 2 below. It stores two values of target and site.

<site>

The absolute URL of the site to be created. This is the URL that a user would enter to access the site, for example: https://localhost/sites/sp, or https://spserver:81/sites/sp.

<title>

A string that contains the display name of the site collection.

<description>

A string that contains a description for the site collection.

<lcid>

An integer that specifies the locale identifier (LCID) for the site collection.

<owner>

Values can be:

  • <USERPRINCIPLENAME> - user@org.com, Site owners account.

  • <NAME> - The display name of the owner.

  • <EMAIL> - A string that contains the e-mail address of the owner.

<preferredDomainController>

The name of the preferred domain controller.

<webTemplate>

A string that contains the name of the site template to use for creating the site collection.

Output Arguments

The CreateCustomerSharePointSite procedure returns a string that contains the Unified Resource Locator (URL) of the new site collection.

Remarks

Security

The CreateCustomerSharePointSite procedure has the following security requirements:

  • The caller is impersonated.

  • The caller is tested for OrgCreator permissions.

Process Steps

The following steps occur when creating a Windows SharePoint site for a customer with the CreateCustomerSharePointSite procedure of the Managed Windows-based Hosting Namespace:

  • Validate Web site settings against plan and resource allocations.

  • Create the customer site by calling the Managed Windows SharePoint Hosting::CreateCustomerSharePointSite procedure.

Sample Code

Example XML Request

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

<request> 
        <procedure> 
                <execute namespace="Windows-based Hosting"  
                procedure="CreateCustomerSharepointSite" impersonate="1"> 
                        <executeData> 
                                <org>LDAP://ou=alpineskihouse,ou=consolidatedmessenger, 
                                ou=hosting,dc=fabrikam,dc=com</org> 
                                <preferredDomainController>AD01-wh.fabrikam.com 
                                </preferredDomainController> 
                                <target>https://WEB01-wh:8080</target> 
                                        <site>https://www.example4.com</site> 
                                        <title>Test site</title> 
                                        <siteName>example4</siteName> 
                                <owner> 
                                <userPrincipalName>WSS12@alpineskihouse.com 
                                </userPrincipalName> 
                                <email>WSS12@alpineskihouse.com</email> 
                                <name>Admin</name> 
                                </owner> 
                                <description>Testing create site</description> 
                                <LCID>1033</LCID> 
                                <webTemplate>sts#0</webTemplate> 
                        </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::DeleteCustomerSharePointSite