WES for Windows-based Hosting API

The Well-Enabled Service (WES) for Windows-based Hosting contains several methods for various categories of methods for interacting with the service, such as provisioning, health, and discovery. Provisioning methods of this WES are a one-to-one mapping with the public procedures of the Windows-based Hosting MPS Namespace. For more information regarding usage of these provisioning methods, refer to the Windows-based Hosting Namespace API.

Methods

Provisioning

The Provisioning category contains the following public procedures for the provisioning of Windows-based Hosting Services

AddPlansToCustomer

Adds valid service plans to a customer organizational unit and reserves any resources as necessary.

Syntax

public AddPlansToCustomerResponse AddPlansToCustomer(AddPlansToCustomerRequest request) {
}

Parameters

request

The AddPlansToCustomerRequest contains the data used in execution of AddPlansToCustomer.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document AddPlansToCustomerRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<AddPlansToCustomerRequest>
  <Data>
	<org>xs:string</org>
	<plans>
	<planName>xs:string</planName>
	</plans>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</AddPlansToCustomerRequest>

XML Message Elements and Attributes

Return Value

The AddPlansToCustomerResponse class contains the data returned after execution of AddPlansToCustomer.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document AddPlansToCustomerResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<AddPlansToCustomerResponse>
  <Data>xs:string</Data>
</AddPlansToCustomerResponse>

XML Message Elements and Attributes

AddUsersToSharepointSiteRole

Add a user to a WSS site role.

Syntax

public AddUsersToSharepointSiteRoleResponse AddUsersToSharepointSiteRole(AddUsersToSharepointSiteRoleRequest request) {
}

Parameters

request

The AddUsersToSharepointSiteRoleRequest contains the data used in execution of AddUsersToSharepointSiteRole.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document AddUsersToSharepointSiteRoleRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<AddUsersToSharepointSiteRoleRequest>
  <Data>
	<org>xs:string</org>
	<siteName>xs:string</siteName>
	<target>xs:string</target>
	<roleName>xs:string</roleName>
	<users>
	<user>
		<userPrincipal>xs:string</userPrincipal>
		<name>xs:string</name>
		<email>xs:string</email>
		<notes>xs:string</notes>
	</user>
	</users>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</AddUsersToSharepointSiteRoleRequest>

XML Message Elements and Attributes

Return Value

The AddUsersToSharepointSiteRoleResponse class contains the data returned after execution of AddUsersToSharepointSiteRole.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document AddUsersToSharepointSiteRoleResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<AddUsersToSharepointSiteRoleResponse>
  <Data>xs:string</Data>
</AddUsersToSharepointSiteRoleResponse>

XML Message Elements and Attributes

ChangeCustomerPlan

Changes customer's service plan.

Syntax

public ChangeCustomerPlanResponse ChangeCustomerPlan(ChangeCustomerPlanRequest request) {
}

Parameters

request

The ChangeCustomerPlanRequest contains the data used in execution of ChangeCustomerPlan.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document ChangeCustomerPlanRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<ChangeCustomerPlanRequest>
  <Data>
	<org>xs:string</org>
	<planName>xs:string</planName>
	<oldPlanName>xs:string</oldPlanName>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</ChangeCustomerPlanRequest>

XML Message Elements and Attributes

Return Value

The ChangeCustomerPlanResponse class contains the data returned after execution of ChangeCustomerPlan.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document ChangeCustomerPlanResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<ChangeCustomerPlanResponse>
  <Data>xs:string</Data>
</ChangeCustomerPlanResponse>

XML Message Elements and Attributes

ControlCustomerWebSite

Start, stop, or pause a specified Web Site.

Syntax

public ControlCustomerWebSiteResponse ControlCustomerWebSite(ControlCustomerWebSiteRequest request) {
}

Parameters

request

The ControlCustomerWebSiteRequest contains the data used in execution of ControlCustomerWebSite.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document ControlCustomerWebSiteRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<ControlCustomerWebSiteRequest>
  <Data>
	<org>xs:string</org>
	<webSiteName>xs:string</webSiteName>
	<serverState>xs:string</serverState>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</ControlCustomerWebSiteRequest>

XML Message Elements and Attributes

Return Value

The ControlCustomerWebSiteResponse class contains the data returned after execution of ControlCustomerWebSite.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document ControlCustomerWebSiteResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<ControlCustomerWebSiteResponse>
  <Data>xs:string</Data>
</ControlCustomerWebSiteResponse>

XML Message Elements and Attributes

CreateCustomerDatabase

Creates a new database for the specified customer.

Syntax

public CreateCustomerDatabaseResponse CreateCustomerDatabase(CreateCustomerDatabaseRequest request) {
}

Parameters

request

The CreateCustomerDatabaseRequest contains the data used in execution of CreateCustomerDatabase.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document CreateCustomerDatabaseRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<CreateCustomerDatabaseRequest>
  <Data>
	<org>xs:string</org>
	<databaseName>xs:string</databaseName>
	<dataRootShare serviceAcct="..">xs:string</dataRootShare>
	<dataRootPath>xs:string</dataRootPath>
	<algorithm>xs:string</algorithm>
	<preferredDomainController>xs:string</preferredDomainController>
	<megabytes>xs:int</megabytes>
	<serverName>xs:string</serverName>
	<sqlUserName>xs:string</sqlUserName>
	<sqlUserPass>xs:string</sqlUserPass>
	<dataFile>
	<logicalName>xs:string</logicalName>
	<fileGrowth>xs:string</fileGrowth>
	</dataFile>
	<logFile>
	<logicalName>xs:string</logicalName>
	<fileGrowth>xs:string</fileGrowth>
	</logFile>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</CreateCustomerDatabaseRequest>

XML Message Elements and Attributes

Data - (minOccurs=1, maxOccurs=1). The root data node
- org - (minOccurs=1, maxOccurs=1). The LDAP path of the organization that will own the website
- databaseName - (minOccurs=1, maxOccurs=1). The name of the database to be created.
- dataRootShare - (minOccurs=1, maxOccurs=1). The name of the network share where the new database files will be created
  - @serviceAcct - (minOccurs=0, maxOccurs=1). This attribute is the sAMAccountName of the service account that the SQL server runs as. This is required to provide file permission rights to the account for the customer's data and log files.
- dataRootPath - (minOccurs=1, maxOccurs=1). The local path to the root directory where customer data (mdf) and logfiles are store (ldf). dataRootShare has to be passed if dataRootPath is being passed. Note that dataFile and logFile parameters will be ignored if you do not provide the dataRootShare and dataRootPath parameters.
- algorithm - (minOccurs=1, maxOccurs=1). Defines the server candidate selection behavior. The allowed values (case sensitive) are: tightPack, level, minSeverCount
- preferredDomainController - (minOccurs=1, maxOccurs=1). The name of the preferred domain controller.
- megabytes - (minOccurs=1, maxOccurs=1). The size to be allocated to the resource.
- serverName - (minOccurs=0, maxOccurs=1). A string representing the name of the server. This can be a NetBIOS name. Overrides automatic selection behavior. However the specified server is still evaluated to see if it has been added to Resource Manager, whether it has the necessary resources to satisfy the request, and if it is a member of the specified server class.
- sqlUserName - (minOccurs=0, maxOccurs=1). The user name for connecting to the SQL server via SQL Authentication. If this node is present, the connection will be made via SQL Authentication rather than Windows Authentication. The existence of this node also requires that the sqlUserPass/ node exist.
- sqlUserPass - (minOccurs=0, maxOccurs=1). The password for connecting to the SQL server via SQL Authentication, using the username indicated by sqlUserName/. If the sqlUserName/ node is not present, this node is ignored.
- dataFile - (minOccurs=0, maxOccurs=1). The logical name for the file. If you intend to supply any of the optional dataFile parameters, you must set the logical name of the data file.
  - logicalName - (minOccurs=1, maxOccurs=1). The logical name of the database dataFile.
  - fileGrowth - (minOccurs=0, maxOccurs=1). Designates a growth increment in KB, MB, GB, terabyte, or percentage (you must specify the unit). The default is 10 percent and the minimum value is 64 KB. Requires that the dataFile/logicalName node exist and be non-null.
- logFile - (minOccurs=0, maxOccurs=1). The logical name for the file. If you intend to supply any of the optional logFile parameters, you must set the logical name of the log file.
  - logicalName - (minOccurs=1, maxOccurs=1). The logical name of the database dataFile.
  - fileGrowth - (minOccurs=0, maxOccurs=1). Designates a growth increment in KB, MB, GB, terabyte, or percentage (you must specify the unit). The default is 10 percent and the minimum value is 64 KB. Requires that the dataFile/logicalName node exist and be non-null.
Username - (minOccurs=1, maxOccurs=1). The user name credential to use for the operation.
Password - (minOccurs=1, maxOccurs=1). The password credential to use for the operation.

Return Value

The CreateCustomerDatabaseResponse class contains the data returned after execution of CreateCustomerDatabase.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document CreateCustomerDatabaseResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<CreateCustomerDatabaseResponse>
  <Data>xs:string</Data>
</CreateCustomerDatabaseResponse>

XML Message Elements and Attributes

CreateCustomerOrganization

Creates a customer organization according to the policy name passed.

Syntax

public CreateCustomerOrganizationResponse CreateCustomerOrganization(CreateCustomerOrganizationRequest request) {
}

Parameters

request

The CreateCustomerOrganizationRequest contains the data used in execution of CreateCustomerOrganization.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document CreateCustomerOrganizationRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<CreateCustomerOrganizationRequest>
  <Data>
	<name>xs:string</name>
	<container>xs:string</container>
	<preferredDomainController>xs:string</preferredDomainController>
	<description>xs:string</description>
	<properties>
	<property name="..">
		<value>xs:string</value>
	</property>
	</properties>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</CreateCustomerOrganizationRequest>

XML Message Elements and Attributes

Return Value

The CreateCustomerOrganizationResponse class contains the data returned after execution of CreateCustomerOrganization.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document CreateCustomerOrganizationResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<CreateCustomerOrganizationResponse>
  <Data>
	<org path=".." name="..">xs:string</org>
  </Data>
</CreateCustomerOrganizationResponse>

XML Message Elements and Attributes

CreateCustomerSharepointSite

Create a customer Sharepoint site and content directories.

Syntax

public CreateCustomerSharepointSiteResponse CreateCustomerSharepointSite(CreateCustomerSharepointSiteRequest request) {
}

Parameters

request

The CreateCustomerSharepointSiteRequest contains the data used in execution of CreateCustomerSharepointSite.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document CreateCustomerSharepointSiteRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<CreateCustomerSharepointSiteRequest>
  <Data>
	<org>xs:string</org>
	<target>xs:string</target>
	<siteName>xs:string</siteName>
	<site>xs:string</site>
	<title>xs:string</title>
	<description>xs:string</description>
	<lcid>xs:string</lcid>
	<owner>
	<userPrincipalName>xs:string</userPrincipalName>
	<email>xs:string</email>
	<name>xs:string</name>
	</owner>
	<preferredDomainController>xs:string</preferredDomainController>
	<webTemplate>xs:string</webTemplate>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</CreateCustomerSharepointSiteRequest>

XML Message Elements and Attributes

Data - (minOccurs=1, maxOccurs=1). The root data node
- org - (minOccurs=1, maxOccurs=1). The LDAP path of the organization that will own the website
- target - (minOccurs=1, maxOccurs=1). The SharePoint administrative URL
- siteName - (minOccurs=1, maxOccurs=1). The site name which is unique within the organization and stored in the pointer. You can also use the target node described below.
- site - (minOccurs=1, maxOccurs=1). The absolute URL of the site to be created. This is the URL that a user would enter to access the site, for example: http://localhost/sites/sp, or http://spserver:81/sites/sp.
- title - (minOccurs=1, maxOccurs=1). A string that contains the display name of the site collection.
- description - (minOccurs=0, maxOccurs=1). A description of the site collection
- lcid - (minOccurs=1, maxOccurs=1). Specifies the locale identifier (LCID) for the site collection.
- owner - (minOccurs=1, maxOccurs=1). Container elements for owner settings
  - userPrincipalName - (minOccurs=1, maxOccurs=1). The user principal name (UPN) of the user. Typically this will be user@SMTPDomain to enable a UPN login to the e-mail account with the user's e-mail address. You cannot use the userPrincipalName parameter to create the HostingAdmin user in the OU=Hosting container as follows: userPrincipalNameHostingAdmin@Hosting/userPrincipalName. However, you can create the HostingAdmin user with the CreateUser procedure of the Managed Active Directory Namespace (or ASP.NET Web Service) by using policyNameHosting/policyName and then calling the GroupAdd procedure to add the user to the Admins group in the Hosting container.
  - email - (minOccurs=1, maxOccurs=1). String that contains the e-mail address of the user.
  - name - (minOccurs=1, maxOccurs=1). The name of the user
- preferredDomainController - (minOccurs=1, maxOccurs=1). The name of the preferred domain controller.
- webTemplate - (minOccurs=1, maxOccurs=1). A string that contains the name of the site template to use for creating the site collection.
Username - (minOccurs=1, maxOccurs=1). The user name credential to use for the operation.
Password - (minOccurs=1, maxOccurs=1). The password credential to use for the operation.

Return Value

The CreateCustomerSharepointSiteResponse class contains the data returned after execution of CreateCustomerSharepointSite.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document CreateCustomerSharepointSiteResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<CreateCustomerSharepointSiteResponse>
  <Data>xs:string</Data>
</CreateCustomerSharepointSiteResponse>

XML Message Elements and Attributes

CreateCustomerWebSite

Create a customer web site and content directories.

Syntax

public CreateCustomerWebSiteResponse CreateCustomerWebSite(CreateCustomerWebSiteRequest request) {
}

Parameters

request

The CreateCustomerWebSiteRequest contains the data used in execution of CreateCustomerWebSite.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document CreateCustomerWebSiteRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<CreateCustomerWebSiteRequest>
  <Data>
	<preferredDomainController>xs:string</preferredDomainController>
	<org>xs:string</org>
	<webServerName>xs:string</webServerName>
	<webRootShare>xs:string</webRootShare>
	<webRootPath>xs:string</webRootPath>
	<webSiteName>xs:string</webSiteName>
	<ftpSiteName>xs:string</ftpSiteName>
	<anonymousUserPass>xs:string</anonymousUserPass>
	<frontpageExtendWeb>xs:boolean</frontpageExtendWeb>
	<serverAutoStart>xs:boolean</serverAutoStart>
	<serverBindings>
	<binding port=".." ipAddress=".." hostHeader="..">xs:string</binding>
	</serverBindings>
	<allowChangeToLogFiles>xs:boolean</allowChangeToLogFiles>
	<properties>
	<property name="..">xs:string</property>
	</properties>
	<algorithm>xs:string</algorithm>
	<megabytes>xs:int</megabytes>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</CreateCustomerWebSiteRequest>

XML Message Elements and Attributes

Data - (minOccurs=1, maxOccurs=1). The root data node
- preferredDomainController - (minOccurs=1, maxOccurs=1). The name of the preferred domain controller.
- org - (minOccurs=1, maxOccurs=1). The LDAP path of the organization that will own the website
- webServerName - (minOccurs=0, maxOccurs=1). The netbios name of the web server
- webRootShare - (minOccurs=1, maxOccurs=1). The name of the web server file share
- webRootPath - (minOccurs=1, maxOccurs=1). The local path of the web server file share
- webSiteName - (minOccurs=1, maxOccurs=1). The unique web site name that was established when the site was created, or use the IIS metabase path.
- ftpSiteName - (minOccurs=1, maxOccurs=1). The name of the FTP site for customer access to web site files
- anonymousUserPass - (minOccurs=0, maxOccurs=1). The password for the automatically generated anonymous user
- frontpageExtendWeb - (minOccurs=0, maxOccurs=1). Allowed values are "1", which will install Frontpage extensions, or "0" which won't install the extensions. If "1" is specified and extensions are already installed an exception will be thrown. If "0" is specified and extensions are not installed, an exception will be thrown
- serverAutoStart - (minOccurs=1, maxOccurs=1). Auto start the new site
- serverBindings - (minOccurs=1, maxOccurs=1). The container for one or more instances of a <binding> element
  - binding - (minOccurs=1, maxOccurs=unbounded). insert documentation for this item here...
    - @port - (minOccurs=0, maxOccurs=1). insert documentation for this item here...
    - @ipAddress - (minOccurs=0, maxOccurs=1). insert documentation for this item here...
    - @hostHeader - (minOccurs=0, maxOccurs=1). insert documentation for this item here...
- allowChangeToLogFiles - (minOccurs=0, maxOccurs=1). Set security to allow customer to change their own IIS log files
- properties - (minOccurs=0, maxOccurs=1). Valid properties for a IIS site
  - property - (minOccurs=0, maxOccurs=unbounded). Valid property or IIS web site
    - @name - (minOccurs=0, maxOccurs=1). Name of the object.
- algorithm - (minOccurs=1, maxOccurs=1). Defines the server candidate selection behavior. The allowed values (case sensitive) are: tightPack, level, minSeverCount
- megabytes - (minOccurs=1, maxOccurs=1). The size to be allocated to the resource.
Username - (minOccurs=1, maxOccurs=1). The user name credential to use for the operation.
Password - (minOccurs=1, maxOccurs=1). The password credential to use for the operation.

Return Value

The CreateCustomerWebSiteResponse class contains the data returned after execution of CreateCustomerWebSite.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document CreateCustomerWebSiteResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<CreateCustomerWebSiteResponse>
  <Data>xs:string</Data>
</CreateCustomerWebSiteResponse>

XML Message Elements and Attributes

CreateDNSZone

The CreateDNSZone method allows you to create a requested zone on a specified server. This method does not update any secondary servers.

Syntax

public CreateDNSZoneResponse CreateDNSZone(CreateDNSZoneRequest request) {
}

Parameters

request

The CreateDNSZoneRequest contains the data used in execution of CreateDNSZone.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document CreateDNSZoneRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<CreateDNSZoneRequest>
  <Data>
	<userName>xs:string</userName>
	<password>xs:string</password>
	<serverIdentifier>xs:string</serverIdentifier>
	<zoneName>xs:string</zoneName>
	<zoneType>xs:string</zoneType>
	<org>xs:string</org>
	<preferredDomainController>xs:string</preferredDomainController>
	<commitFlag>xs:string</commitFlag>
	<adminEmail>xs:string</adminEmail>
	<debugLevel logging="..">xs:string</debugLevel>
	<properties>
	<property name="..">xs:string</property>
	</properties>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</CreateDNSZoneRequest>

XML Message Elements and Attributes

Return Value

The CreateDNSZoneResponse class contains the data returned after execution of CreateDNSZone.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document CreateDNSZoneResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<CreateDNSZoneResponse>
  <Data>xs:string</Data>
</CreateDNSZoneResponse>

XML Message Elements and Attributes

CreatePlan

Create a service plan

Syntax

public CreatePlanResponse CreatePlan(CreatePlanRequest request) {
}

Parameters

request

The CreatePlanRequest contains the data used in execution of CreatePlan.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document CreatePlanRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<CreatePlanRequest>
  <Data>
	<preferredDomainController>xs:string</preferredDomainController>
	<planName>xs:string</planName>
	<planTypeName>xs:string</planTypeName>
	<planDescription>xs:string</planDescription>
	<planCategories>
	<category>
		<categoryName>xs:string</categoryName>
	</category>
	</planCategories>
	<planFeatures>
	<feature>
		<featureName>xs:string</featureName>
		<featureDescription>xs:string</featureDescription>
		<featureValue>xs:string</featureValue>
		<unitDescription>xs:string</unitDescription>
	</feature>
	</planFeatures>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</CreatePlanRequest>

XML Message Elements and Attributes

Return Value

The CreatePlanResponse class contains the data returned after execution of CreatePlan.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document CreatePlanResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<CreatePlanResponse>
  <Data>xs:string</Data>
</CreatePlanResponse>

XML Message Elements and Attributes

CreateResellerOrganization

Creates a reseller organization according to the policy name passed.

Syntax

public CreateResellerOrganizationResponse CreateResellerOrganization(CreateResellerOrganizationRequest request) {
}

Parameters

request

The CreateResellerOrganizationRequest contains the data used in execution of CreateResellerOrganization.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document CreateResellerOrganizationRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<CreateResellerOrganizationRequest>
  <Data>
	<name>xs:string</name>
	<container>xs:string</container>
	<preferredDomainController>xs:string</preferredDomainController>
	<description>xs:string</description>
	<properties>
	<property name="..">
		<value>xs:string</value>
	</property>
	</properties>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</CreateResellerOrganizationRequest>

XML Message Elements and Attributes

Return Value

The CreateResellerOrganizationResponse class contains the data returned after execution of CreateResellerOrganization.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document CreateResellerOrganizationResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<CreateResellerOrganizationResponse>
  <Data>
	<org path=".." name="..">xs:string</org>
  </Data>
</CreateResellerOrganizationResponse>

XML Message Elements and Attributes

CreateResourceRecord

Allows you to create an RR on a specified server regardless of whether it is primary for the zone.

Syntax

public CreateResourceRecordResponse CreateResourceRecord(CreateResourceRecordRequest request) {
}

Parameters

request

The CreateResourceRecordRequest contains the data used in execution of CreateResourceRecord.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document CreateResourceRecordRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<CreateResourceRecordRequest>
  <Data>
	<userName>xs:string</userName>
	<password>xs:string</password>
	<org>xs:string</org>
	<preferredDomainController>xs:string</preferredDomainController>
	<serverIdentifier>xs:string</serverIdentifier>
	<zoneName>xs:string</zoneName>
	<rrType>xs:string</rrType>
	<properties>
	<property name="..">xs:string</property>
	</properties>
	<debugLevel logging="..">xs:string</debugLevel>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</CreateResourceRecordRequest>

XML Message Elements and Attributes

Return Value

The CreateResourceRecordResponse class contains the data returned after execution of CreateResourceRecord.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document CreateResourceRecordResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<CreateResourceRecordResponse>
  <Data>xs:string</Data>
</CreateResourceRecordResponse>

XML Message Elements and Attributes

CreateUser

Creates a new user within a specified organization according to the policy name passed.

Syntax

public CreateUserResponse CreateUser(CreateUserRequest request) {
}

Parameters

request

The CreateUserRequest contains the data used in execution of CreateUser.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document CreateUserRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<CreateUserRequest>
  <Data>
	<container>xs:string</container>
	<userPrincipalName>xs:string</userPrincipalName>
	<displayName>xs:string</displayName>
	<givenName>xs:string</givenName>
	<middleName>xs:string</middleName>
	<sn>xs:string</sn>
	<initials>xs:string</initials>
	<newPassword do-not-log="..">xs:string</newPassword>
	<description>xs:string</description>
	<planName>xs:string</planName>
	<isAdmin>xs:boolean</isAdmin>
	<properties>
	<property name="..">
		<value>xs:string</value>
	</property>
	</properties>
	<preferredDomainController>xs:string</preferredDomainController>
	<sAMAccountName>xs:string</sAMAccountName>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</CreateUserRequest>

XML Message Elements and Attributes

Return Value

The CreateUserResponse class contains the data returned after execution of CreateUser.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document CreateUserResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<CreateUserResponse>
  <Data>
	<user path=".." name="..">
	<memberOfGroup name="..">xs:string</memberOfGroup>
	</user>
  </Data>
</CreateUserResponse>

XML Message Elements and Attributes

DeleteCustomerDatabase

Deletes a customer's database.

Syntax

public DeleteCustomerDatabaseResponse DeleteCustomerDatabase(DeleteCustomerDatabaseRequest request) {
}

Parameters

request

The DeleteCustomerDatabaseRequest contains the data used in execution of DeleteCustomerDatabase.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document DeleteCustomerDatabaseRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<DeleteCustomerDatabaseRequest>
  <Data>
	<org>xs:string</org>
	<databaseName>xs:string</databaseName>
	<preferredDomainController>xs:string</preferredDomainController>
	<sqlUserName>xs:string</sqlUserName>
	<sqlUserPass>xs:string</sqlUserPass>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</DeleteCustomerDatabaseRequest>

XML Message Elements and Attributes

Return Value

The DeleteCustomerDatabaseResponse class contains the data returned after execution of DeleteCustomerDatabase.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document DeleteCustomerDatabaseResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<DeleteCustomerDatabaseResponse>
  <Data>xs:string</Data>
</DeleteCustomerDatabaseResponse>

XML Message Elements and Attributes

DeleteCustomerSharepointSite

Delete a customer Sharepoint site and content directories.

Syntax

public DeleteCustomerSharepointSiteResponse DeleteCustomerSharepointSite(DeleteCustomerSharepointSiteRequest request) {
}

Parameters

request

The DeleteCustomerSharepointSiteRequest contains the data used in execution of DeleteCustomerSharepointSite.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document DeleteCustomerSharepointSiteRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<DeleteCustomerSharepointSiteRequest>
  <Data>
	<org>xs:string</org>
	<siteName>xs:string</siteName>
	<site>xs:string</site>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</DeleteCustomerSharepointSiteRequest>

XML Message Elements and Attributes

Return Value

The DeleteCustomerSharepointSiteResponse class contains the data returned after execution of DeleteCustomerSharepointSite.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document DeleteCustomerSharepointSiteResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<DeleteCustomerSharepointSiteResponse>
  <Data>xs:string</Data>
</DeleteCustomerSharepointSiteResponse>

XML Message Elements and Attributes

DeleteCustomerWebSite

Delete a customer web site and content directories.

Syntax

public DeleteCustomerWebSiteResponse DeleteCustomerWebSite(DeleteCustomerWebSiteRequest request) {
}

Parameters

request

The DeleteCustomerWebSiteRequest contains the data used in execution of DeleteCustomerWebSite.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document DeleteCustomerWebSiteRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<DeleteCustomerWebSiteRequest>
  <Data>
	<org>xs:string</org>
	<webSiteName>xs:string</webSiteName>
	<location>xs:string</location>
	<preferredDomainController>xs:string</preferredDomainController>
	<archiveShare>xs:string</archiveShare>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</DeleteCustomerWebSiteRequest>

XML Message Elements and Attributes

Return Value

The DeleteCustomerWebSiteResponse class contains the data returned after execution of DeleteCustomerWebSite.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document DeleteCustomerWebSiteResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<DeleteCustomerWebSiteResponse>
  <Data>xs:string</Data>
</DeleteCustomerWebSiteResponse>

XML Message Elements and Attributes

DeleteDNSZone

Delete a requested zone on a specified server.

Syntax

public DeleteDNSZoneResponse DeleteDNSZone(DeleteDNSZoneRequest request) {
}

Parameters

request

The DeleteDNSZoneRequest contains the data used in execution of DeleteDNSZone.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document DeleteDNSZoneRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<DeleteDNSZoneRequest>
  <Data>
	<userName>xs:string</userName>
	<password>xs:string</password>
	<serverIdentifier>xs:string</serverIdentifier>
	<zoneName>xs:string</zoneName>
	<org>xs:string</org>
	<preferredDomainController>xs:string</preferredDomainController>
	<debugLevel logging="..">xs:string</debugLevel>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</DeleteDNSZoneRequest>

XML Message Elements and Attributes

Return Value

The DeleteDNSZoneResponse class contains the data returned after execution of DeleteDNSZone.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document DeleteDNSZoneResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<DeleteDNSZoneResponse>
  <Data>xs:string</Data>
</DeleteDNSZoneResponse>

XML Message Elements and Attributes

DeleteOrganization

Delete a business organization or reseller.

Syntax

public DeleteOrganizationResponse DeleteOrganization(DeleteOrganizationRequest request) {
}

Parameters

request

The DeleteOrganizationRequest contains the data used in execution of DeleteOrganization.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document DeleteOrganizationRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<DeleteOrganizationRequest>
  <Data>
	<org>xs:string</org>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</DeleteOrganizationRequest>

XML Message Elements and Attributes

Return Value

The DeleteOrganizationResponse class contains the data returned after execution of DeleteOrganization.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document DeleteOrganizationResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<DeleteOrganizationResponse>
  <Data>xs:string</Data>
</DeleteOrganizationResponse>

XML Message Elements and Attributes

DeleteResourceRecord

Removes a specified and existing RR from a zone.

Syntax

public DeleteResourceRecordResponse DeleteResourceRecord(DeleteResourceRecordRequest request) {
}

Parameters

request

The DeleteResourceRecordRequest contains the data used in execution of DeleteResourceRecord.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document DeleteResourceRecordRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<DeleteResourceRecordRequest>
  <Data>
	<org>xs:string</org>
	<preferredDomainController>xs:string</preferredDomainController>
	<userName>xs:string</userName>
	<password>xs:string</password>
	<serverIdentifier>xs:string</serverIdentifier>
	<zoneName>xs:string</zoneName>
	<rrType>xs:string</rrType>
	<debugLevel logging="..">xs:string</debugLevel>
	<properties>
	<property name="..">xs:string</property>
	</properties>
	<rrName>xs:string</rrName>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</DeleteResourceRecordRequest>

XML Message Elements and Attributes

Return Value

The DeleteResourceRecordResponse class contains the data returned after execution of DeleteResourceRecord.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document DeleteResourceRecordResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<DeleteResourceRecordResponse>
  <Data>xs:string</Data>
</DeleteResourceRecordResponse>

XML Message Elements and Attributes

DeleteUser

Deletes a user from within a specified organization.

Syntax

public DeleteUserResponse DeleteUser(DeleteUserRequest request) {
}

Parameters

request

The DeleteUserRequest contains the data used in execution of DeleteUser.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document DeleteUserRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<DeleteUserRequest>
  <Data>
	<path>xs:string</path>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</DeleteUserRequest>

XML Message Elements and Attributes

Return Value

The DeleteUserResponse class contains the data returned after execution of DeleteUser.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document DeleteUserResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<DeleteUserResponse>
  <Data>xs:string</Data>
</DeleteUserResponse>

XML Message Elements and Attributes

DisablePlan

Disables a valid service plan.

Syntax

public DisablePlanResponse DisablePlan(DisablePlanRequest request) {
}

Parameters

request

The DisablePlanRequest contains the data used in execution of DisablePlan.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document DisablePlanRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<DisablePlanRequest>
  <Data>
	<preferredDomainController>xs:string</preferredDomainController>
	<planName>xs:string</planName>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</DisablePlanRequest>

XML Message Elements and Attributes

Return Value

The DisablePlanResponse class contains the data returned after execution of DisablePlan.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document DisablePlanResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<DisablePlanResponse>
  <Data>xs:string</Data>
</DisablePlanResponse>

XML Message Elements and Attributes

EnablePlan

Enables a valid service plan.

Syntax

public EnablePlanResponse EnablePlan(EnablePlanRequest request) {
}

Parameters

request

The EnablePlanRequest contains the data used in execution of EnablePlan.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document EnablePlanRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<EnablePlanRequest>
  <Data>
	<preferredDomainController>xs:string</preferredDomainController>
	<planName>xs:string</planName>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</EnablePlanRequest>

XML Message Elements and Attributes

Return Value

The EnablePlanResponse class contains the data returned after execution of EnablePlan.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document EnablePlanResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<EnablePlanResponse>
  <Data>xs:string</Data>
</EnablePlanResponse>

XML Message Elements and Attributes

ModifyCustomerDatabaseFile

Modify dataFile settings for a specified database.

Syntax

public ModifyCustomerDatabaseFileResponse ModifyCustomerDatabaseFile(ModifyCustomerDatabaseFileRequest request) {
}

Parameters

request

The ModifyCustomerDatabaseFileRequest contains the data used in execution of ModifyCustomerDatabaseFile.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document ModifyCustomerDatabaseFileRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<ModifyCustomerDatabaseFileRequest>
  <Data>
	<org>xs:string</org>
	<databaseName>xs:string</databaseName>
	<preferredDomainController>xs:string</preferredDomainController>
	<logicalName>xs:string</logicalName>
	<megabytes>xs:int</megabytes>
	<sqlUserName>xs:string</sqlUserName>
	<sqlUserPass>xs:string</sqlUserPass>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</ModifyCustomerDatabaseFileRequest>

XML Message Elements and Attributes

Return Value

The ModifyCustomerDatabaseFileResponse class contains the data returned after execution of ModifyCustomerDatabaseFile.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document ModifyCustomerDatabaseFileResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<ModifyCustomerDatabaseFileResponse>
  <Data>xs:string</Data>
</ModifyCustomerDatabaseFileResponse>

XML Message Elements and Attributes

ModifyCustomerWebSiteResponse

Modifies a customer Web site.

Syntax

public ModifyCustomerWebSiteResponse ModifyCustomerWebSite(ModifyCustomerWebSiteRequest request) {
}

Parameters

request

The ModifyCustomerWebSiteRequest contains the data used in execution of ModifyCustomerWebSite. This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document ModifyCustomerWebSiteRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<ModifyCustomerWebSiteRequest>
  <Data>
	<preferredDomainController>xs:string</preferredDomainController>
	<org>xs:string</org>
	<webSiteName>xs:string</webSiteName>
	<location>xs:string</location>
	<anonymousUserPass>xs:string</anonymousUserPass>
	<frontpageExtendWeb>xs:boolean</frontpageExtendWeb>
	<serverBindings>
	<binding port=".." ipAddress=".." hostHeader="..">xs:string</binding>
	</serverBindings>
	<properties>
	<property name="..">xs:string</property>
	</properties>
	<megabytes>xs:int</megabytes>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</ModifyCustomerWebSiteRequest>

XML Message Elements and Attributes

Return Value

The ModifyCustomerWebSiteResponse class contains the data returned after execution of ModifyCustomerWebSite.This class is an XmlSerialization compliant class generated from an XML Schema Definition. The XML Schema Definition document ModifyCustomerWebSiteResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<CreateCustomerWebSiteResponse>
  <Data>xs:string</Data>
</CreateCustomerWebSiteResponse>

XML Message Elements and Attributes

QueryCustomerPlans

Returns a list of customer's plans.

Syntax

public QueryCustomerPlansResponse QueryCustomerPlans(QueryCustomerPlansRequest request) {
}

Parameters

request

The QueryCustomerPlansRequest contains the data used in execution of QueryCustomerPlans.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document QueryCustomerPlansRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<QueryCustomerPlansRequest>
  <Data>
	<org>xs:string</org>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</QueryCustomerPlansRequest>

XML Message Elements and Attributes

Return Value

The QueryCustomerPlansResponse class contains the data returned after execution of QueryCustomerPlans.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document QueryCustomerPlansResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<QueryCustomerPlansResponse>
  <Data>
	<servicePlans>
	<plan>
		<planName>xs:string</planName>
		<planTypeName>xs:string</planTypeName>
		<planDescription>xs:string</planDescription>
		<planStatus>xs:string</planStatus>
		<dateCreated>xs:dateTime</dateCreated>
		<dateLastUpdated>xs:dateTime</dateLastUpdated>
	</plan>
	</servicePlans>
  </Data>
</QueryCustomerPlansResponse>

XML Message Elements and Attributes

QueryPlans

Adds valid service plans to a customer organizational unit and reserves any resources as necessary.

Syntax

public QueryPlansResponse QueryPlans(QueryPlansRequest request) {
}

Parameters

request

The QueryPlansRequest contains the data used in execution of QueryPlans.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document QueryPlansRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<QueryPlansRequest>
  <Data>
	<preferredDomainController>xs:string</preferredDomainController>
	<planTypeName>xs:string</planTypeName>
	<statusTypeName>xs:string</statusTypeName>
	<categoryName>xs:string</categoryName>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</QueryPlansRequest>

XML Message Elements and Attributes

Return Value

The QueryPlansResponse class contains the data returned after execution of QueryPlans.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document QueryPlansResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<QueryPlansResponse>
  <Data>
	<servicePlans>
	<plan>
		<planName>xs:string</planName>
		<planDescription>xs:string</planDescription>
		<planStatus>xs:string</planStatus>
		<dateCreated>xs:dateTime</dateCreated>
		<dateLastUpdated>xs:dateTime</dateLastUpdated>
		<planTypeName>xs:string</planTypeName>
	</plan>
	</servicePlans>
  </Data>
</QueryPlansResponse>

XML Message Elements and Attributes

QueryServicesByCustomer

Returns a listing of plans and provisioned services for a Customer organizationalUnit.

Syntax

public QueryServicesByCustomerResponse QueryServicesByCustomer(QueryServicesByCustomerRequest request) {
}

Parameters

request

The QueryServicesByCustomerRequest contains the data used in execution of QueryServicesByCustomer.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document QueryServicesByCustomerRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<QueryServicesByCustomerRequest>
  <Data>
	<org>xs:string</org>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</QueryServicesByCustomerRequest>

XML Message Elements and Attributes

Return Value

The QueryServicesByCustomerResponse class contains the data returned after execution of QueryServicesByCustomer.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document QueryServicesByCustomerResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<QueryServicesByCustomerResponse>
  <Data>
	<servicePlans>xs:string</servicePlans>
	<services>xs:string</services>
  </Data>
</QueryServicesByCustomerResponse>

XML Message Elements and Attributes

RemovePlansFromCustomer

Removes service plans from a customer organizational unit and reserves any resources as necessary.

Syntax

public RemovePlansFromCustomerResponse RemovePlansFromCustomer(RemovePlansFromCustomerRequest request) {
}

Parameters

request

The RemovePlansFromCustomerRequest contains the data used in execution of RemovePlansFromCustomer.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document RemovePlansFromCustomerRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<RemovePlansFromCustomerRequest>
  <Data>
	<org>xs:string</org>
	<plans>
	<planName>xs:string</planName>
	</plans>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</RemovePlansFromCustomerRequest>

XML Message Elements and Attributes

Return Value

The RemovePlansFromCustomerResponse class contains the data returned after execution of RemovePlansFromCustomer.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document RemovePlansFromCustomerResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<RemovePlansFromCustomerResponse>
  <Data>xs:string</Data>
</RemovePlansFromCustomerResponse>

XML Message Elements and Attributes

RemoveUsersFromSharepointSiteRole

Remove a user from a WSS site role.

Syntax

public RemoveUsersFromSharepointSiteRoleResponse RemoveUsersFromSharepointSiteRole(RemoveUsersFromSharepointSiteRoleRequest request) {
}

Parameters

request

The RemoveUsersFromSharepointSiteRoleRequest contains the data used in execution of RemoveUsersFromSharepointSiteRole.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document RemoveUsersFromSharepointSiteRoleRequest.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<RemoveUsersFromSharepointSiteRoleRequest>
  <Data>
	<org>xs:string</org>
	<siteName>xs:string</siteName>
	<target>xs:string</target>
	<roleName>xs:string</roleName>
	<users>
	<user>
		<userPrincipalName>xs:string</userPrincipalName>
		<preferredDomainController>xs:string</preferredDomainController>
	</user>
	</users>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</RemoveUsersFromSharepointSiteRoleRequest>

XML Message Elements and Attributes

Return Value

The RemoveUsersFromSharepointSiteRoleResponse class contains the data returned after execution of RemoveUsersFromSharepointSiteRole.This class is an XmlSerialization compliant class generated from an XML Schema Definition.The XML Schema Definition document RemoveUsersFromSharepointSiteRoleResponse.xsd is shipped with the WES and located in the root of the WES Virtual Directory. The following shows the basic XML format of the class:

XML Message Format

<RemoveUsersFromSharepointSiteRoleResponse>
  <Data>xs:string</Data>
</RemoveUsersFromSharepointSiteRoleResponse>

XML Message Elements and Attributes

Common WES Operations

The Common WES Operations category contains the following public procedures for common WES operations of a typical WES which are implemented by the WES for Windows-based Hosting:

FetchTargets

The FetchTargets operation of a WES provides Discovery capability for the service. This method is invoked to retrieve WES provisioning resources, their states, and the actions that can be performed on these resources.

WSDL Snippet of FetchTargets

<wsdl:operation name="FetchTargets">
  <wsdl:input wsa:Action="http://provisioning.microsoft.com/WellEnabledService/FetchTargets" message="tns:FetchTargetsMessageIn" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" />
  <wsdl:output wsa:Action="http://provisioning.microsoft.com/WellEnabledService/FetchTargetsResponse" message="tns:FetchTargetsMessageOut" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" />
</wsdl:operation>

Parameters

The FetchTargets operation does not accept any parameters and returns an XmlDocument object containing the details of the resources provided by the VAS, their states and the actions that they support. This response is based on the SDM-based schema.

Request Schema

None

Response Schema

Following is the snippet of FetchTargets response schema.

<xs:element name="FetchTargetsResponse">
  <xs:complexType>
	<xs:sequence>
	<xs:element minOccurs="1" maxOccurs="1" name="Information">
		<xs:complexType>
		<xs:sequence>
			<xs:element minOccurs="1" maxOccurs="1" name="FriendlyName" type="xs:string" />
			<xs:element minOccurs="1" maxOccurs="1" name="CompanyName" type="xs:string" />
			<xs:element minOccurs="1" maxOccurs="1" name="Copyright" type="xs:string" />
			<xs:element minOccurs="1" maxOccurs="1" name="Description" type="xs:string" />
		</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element minOccurs="1" maxOccurs="1" name="Status" type="xs:string" />
	<xs:element name="Resources">
		<xs:complexType>
		<xs:sequence>
			<xs:element name="Resource">

GetServiceHealthState

The service may have an associated state that it might want to expose for management purposes. For example, the service could be online, in a degraded state-such as having performance, security, dependency, integrity or other problems-offline, or in a failed state.

WSDL Snippet of GetServiceHealthState

  <wsdl:input wsa:Action="http://provisioning.microsoft.com/WellEnabledService/GetServiceHealthState" message="tns:GetServiceHealthStateMessageIn" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" />
  <wsdl:output wsa:Action="http://provisioning.microsoft.com/WellEnabledService/GetServiceHealthStateResponse" message="tns:GetServiceHealthStateMessageOut" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" />
</wsdl:operation>

Parameters

The GetServiceHealthState operation accepts GetServiceHealthStateRequest parameter and returns a GetServiceHealthStateResponse object containing the details of the Health of the VAS Backend.

Request Schema

Following is the GetServiceHealthStateRequest request schema.

  <xs:schema xmlns:b="http://schemas.microsoft.com/BizTalk/2003" xmlns="http://provisioning.microsoft.com/wellenabledservice/GetServiceHealthStateRequest.xsd" elementFormDefault="qualified" targetNamespace="http://provisioning.microsoft.com/wellenabledservice/GetServiceHealthStateRequest.xsd" id="GetServiceHealthStateRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="GetServiceHealthStateRequest">
	<xs:annotation>
	<xs:documentation>Queries the health state of a service.</xs:documentation>
	</xs:annotation>
	<xs:complexType>
	<xs:sequence>
		<xs:element name="Identifier" type="xs:string" />
		<xs:element name="Operation">
		<xs:simpleType id="OperationType">
			<xs:restriction base="xs:string">
			<xs:enumeration value="Provisioning" />
			<xs:enumeration value="Usage" />
			<xs:enumeration value="Health" />
			</xs:restriction>
		</xs:simpleType>
		</xs:element>
	</xs:sequence>
	</xs:complexType>
  </xs:element>
</xs:schema>

Response Schema

Following is the GetServiceHealthStateRequest response schema.

<xs:schema xmlns="http://provisioning.microsoft.com/wellenabledservice/GetServiceHealthStateResponse.xsd" elementFormDefault="qualified"
		targetNamespace="http://provisioning.microsoft.com/wellenabledservice/GetServiceHealthStateResponse.xsd" id="GetServiceHealthStateResponse"
		xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="GetServiceHealthStateResponse">
	<xs:annotation>
	<xs:documentation>Returns the last operation's result (succss, failure) and the time that it was completed.</xs:documentation>
	</xs:annotation>
	<xs:complexType>
	<xs:sequence>
		<xs:element name="Identifier" type="xs:string" />
		<xs:element name="ResultCode" type="xs:string" />
		<xs:element name="ErrorMessage" type="xs:string" />
		<xs:element name="LastSuccessTime" minOccurs="0" type="xs:string" />
		<xs:element name="LastFailureTime" minOccurs="0" type="xs:string" />
		<xs:element name="LastFailureFaultCode" minOccurs="0" type="xs:string" />
	</xs:sequence>
	</xs:complexType>
  </xs:element>
</xs:schema>