WES for Hosted Exchange API

The Well-Enabled Service (WES) for Hosted Exchange 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 Hosted Exchange MPS Namespace.

Methods

Provisioning

The Provisioning category contains the following public procedures for the provisioning of Hosted Exchange Services

ChangeUserPassword

Change the password of a user Active Directory object

Syntax

public ChangeUserPasswordResponse ChangeUserPassword(ChangeUserPasswordRequest request) {
}

Parameters

request

The ChangeUserPasswordRequest contains the data used in execution of ChangeUserPassword.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document ChangeUserPasswordRequest.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

<ChangeUserPasswordRequest>
  <Data>
	<path>xs:string</path>
	<oldPassword do-not-log="..">xs:string</oldPassword>
	<newPassword do-not-log="..">xs:string</newPassword>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</ChangeUserPasswordRequest>

Xml Message Elements and Attributes

Return Value

The ChangeUserPasswordResponse class contains the data returned after execution of ChangeUserPassword.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document ChangeUserPasswordResponse.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

<ChangeUserPasswordResponse>
  <Data>xs:string</Data>
</ChangeUserPasswordResponse>

Xml Message Elements and Attributes

CreateBusinessOrganization

Create a business organization

Syntax

public CreateBusinessOrganizationResponse CreateBusinessOrganization(CreateBusinessOrganizationRequest request) {
}

Parameters

request

The CreateBusinessOrganizationRequest contains the data used in execution of CreateBusinessOrganization.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreateBusinessOrganizationRequest.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

<CreateBusinessOrganizationRequest>
  <Data>
	<container>xs:string</container>
	<name>xs:string</name>
	<preferredDomainController>xs:string</preferredDomainController>
	<mailStore algorithm="..">
	<megabytes>xs:int</megabytes>
	<shared>xs:boolean</shared>
	<sourceMailStores>
		<sourceMailStore>
		<serverName>xs:string</serverName>
		<mailStoreName>xs:string</mailStoreName>
		<megabytes>xs:int</megabytes>
		</sourceMailStore>
	</sourceMailStores>
	</mailStore>
	<publicStore>
	<sourcePublicStoreServer>xs:string</sourcePublicStoreServer>
	<megabytes>xs:int</megabytes>
	</publicStore>
	<SMTPDomain>xs:string</SMTPDomain>
	<createSMTPDomain>xs:string</createSMTPDomain>
	<description>xs:string</description>
	<properties>
	<property name="..">
		<value>xs:string</value>
	</property>
	</properties>
	<availablePlans>
	<planName>xs:string</planName>
	</availablePlans>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</CreateBusinessOrganizationRequest>

Xml Message Elements and Attributes

Data - (minOccurs=1, maxOccurs=1). The root data node
- container - (minOccurs=1, maxOccurs=1). The LDAP path of a the container object
- name - (minOccurs=1, maxOccurs=1). The name of the object
- preferredDomainController - (minOccurs=1, maxOccurs=1). The name of the domain controller to use for this operation
- mailStore - (minOccurs=1, maxOccurs=1). The container node for mailStore settings
  - megabytes - (minOccurs=1, maxOccurs=1). size in megabytes
  - shared - (minOccurs=1, maxOccurs=1). This parameter only has meaning if the autoAllocate parameter is specified and serverName and mailStoreName are not specified. If this parameter is 0, the organization is given one or more mail stores which will not be shared with other organizations. (Unshared mail stores are those which were added using AddExchangeResources with their shared parameter as 0.) If the mailStore/shared parameter is 1, mail storage will be allocated from one or more shared mail stores. Shared mail stores may or may not be shared with other organizations
  - sourceMailStores - (minOccurs=0, maxOccurs=1). Container element for a collection of source mailstores
    - sourceMailStore - (minOccurs=0, maxOccurs=unbounded). Container element for source mailstore settings
      - serverName - (minOccurs=1, maxOccurs=1). The name of an Exchange server. This node will only be acknowledged if the mailStoreName optional node is also present
      - mailStoreName - (minOccurs=1, maxOccurs=1). The name of a an Exchange Mailstore. This node will only be acknowledged if the serverName optional node is also present
      - megabytes - (minOccurs=1, maxOccurs=1). size in megabytes
  - @algorithm - (minOccurs=0, maxOccurs=1). Specifies the selection algorithm to use when selecting an Exchange mail store for the new mailbox
- publicStore - (minOccurs=0, maxOccurs=1). The The container node for publicStore settings
  - sourcePublicStoreServer - (minOccurs=0, maxOccurs=1). The name of the public store server
  - megabytes - (minOccurs=1, maxOccurs=1). size in megabytes
- SMTPDomain - (minOccurs=0, maxOccurs=1). The SMTP domain to use when generating the user's primary E-Mail address. If not provided, the primary SMTPDomain stored in the Customer Plan Database is used. In general this parameter should only be used for special cases where the default behavior needs to be overridden.
- createSMTPDomain - (minOccurs=0, maxOccurs=1). Legacy flag indicating that the procedure should create an Exchange Recipient policy
- description - (minOccurs=0, maxOccurs=1). A description of this object
- properties - (minOccurs=0, maxOccurs=1). The container element for a collection of properties
  - property - (minOccurs=0, maxOccurs=unbounded). A property
    - value - (minOccurs=0, maxOccurs=unbounded). Value for this instance
    - @name - (minOccurs=0, maxOccurs=1). The name of the property
- availablePlans - (minOccurs=0, maxOccurs=1). The container element for a collection of plans that are made available to an organization
  - planName - (minOccurs=0, maxOccurs=unbounded). The Exchange mailbox plan
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 CreateBusinessOrganizationResponse class contains the data returned after execution of CreateBusinessOrganization.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreateBusinessOrganizationResponse.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

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

Xml Message Elements and Attributes

CreateBusinessUser

Create a business user in a specified organization

Syntax

public CreateBusinessUserResponse CreateBusinessUser(CreateBusinessUserRequest request) {
}

Parameters

request

The CreateBusinessUserRequest contains the data used in execution of CreateBusinessUser.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreateBusinessUserRequest.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

<CreateBusinessUserRequest>
  <Data>
	<container>xs:string</container>
	<userPrincipalName>xs:string</userPrincipalName>
	<customerTypeName>xs:string</customerTypeName>
	<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>
	<mail>
	<size>xs:int</size>
	<warningQuota>xs:int</warningQuota>
	<prohibitSendAndReceiveQuota>xs:int</prohibitSendAndReceiveQuota>
	<outgoingSizeLimit>xs:int</outgoingSizeLimit>
	<incomingSizeLimit>xs:int</incomingSizeLimit>
	</mail>
	<proxyAddresses>
	<value>xs:string</value>
	</proxyAddresses>
	<mailStore autoAllocate=".." algorithm="..">
	<serverName>xs:string</serverName>
	<mailStoreName>xs:string</mailStoreName>
	<shared>xs:boolean</shared>
	</mailStore>
	<SMTPDomain>xs:string</SMTPDomain>
	<preferredDomainController>xs:string</preferredDomainController>
	<sAMAccountName>xs:string</sAMAccountName>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</CreateBusinessUserRequest>

Xml Message Elements and Attributes

Data - (minOccurs=1, maxOccurs=1). The root data node
- container - (minOccurs=1, maxOccurs=1). The LDAP path of a the container object
- userPrincipalName - (minOccurs=1, maxOccurs=1). The user principal name of a user
- customerTypeName - (minOccurs=0, maxOccurs=1). Determines the type of resource management to use. BusinessUser and ConsumerUser are the two allowed inputs for this parameter. If not provided the procedure defaults to BusinessUser resource management.
- displayName - (minOccurs=0, maxOccurs=1). The display name of a user
- givenName - (minOccurs=0, maxOccurs=1). The given name of a user
- middleName - (minOccurs=0, maxOccurs=1). The middle name of a user
- sn - (minOccurs=0, maxOccurs=1). The surname of a user
- initials - (minOccurs=0, maxOccurs=1). The initials of a user
- newPassword - (minOccurs=0, maxOccurs=1). The new password for the specified user
  - @do-not-log - (minOccurs=0, maxOccurs=1). Instructs the engine to not log the element value.
- description - (minOccurs=0, maxOccurs=1). A description of this object
- planName - (minOccurs=0, maxOccurs=1). The Exchange mailbox plan
- isAdmin - (minOccurs=0, maxOccurs=1). Adds a user to the Admins group for an organization
- properties - (minOccurs=0, maxOccurs=1). The container element for a collection of properties
  - property - (minOccurs=0, maxOccurs=unbounded). A property
    - value - (minOccurs=0, maxOccurs=unbounded). Value for this instance
    - @name - (minOccurs=0, maxOccurs=1). The name of the property
- mail - (minOccurs=0, maxOccurs=1). Container element for Exchange Maibox settings
  - size - (minOccurs=1, maxOccurs=1). size in Kb (equivalent to ProhibitSendQuota). Note that this is value to use when allocating the mailbox to Resource Manager
  - warningQuota - (minOccurs=0, maxOccurs=1). size (in Kb) required to set this, default is 90% of size. Store default used if size is set to 0
  - prohibitSendAndReceiveQuota - (minOccurs=0, maxOccurs=1). size (in Kb) required to set this, default is 500% of size. Store default used if size is set to 0
  - outgoingSizeLimit - (minOccurs=0, maxOccurs=1). max size (in Kb) of outgoing messages, default is unlimited (-1)
  - incomingSizeLimit - (minOccurs=0, maxOccurs=1). max size (in Kb) of incoming messages, default is unlimited (-1)
- proxyAddresses - (minOccurs=0, maxOccurs=1). Additional SMTP proxy addresses for the user
  - value - (minOccurs=0, maxOccurs=unbounded). Value for this instance
- mailStore - (minOccurs=0, maxOccurs=1). The The container node for mailStore settings
  - serverName - (minOccurs=0, maxOccurs=1). The name of an Exchange server. This node will only be acknowledged if the mailStoreName optional node is also present
  - mailStoreName - (minOccurs=0, maxOccurs=1). The name of a an Exchange Mailstore. This node will only be acknowledged if the serverName optional node is also present
  - shared - (minOccurs=0, maxOccurs=1). This parameter only has meaning if the autoAllocate parameter is specified and serverName and mailStoreName are not specified. If this parameter is 0, the organization is given one or more mail stores which will not be shared with other organizations. (Unshared mail stores are those which were added using AddExchangeResources with their shared parameter as 0.) If the mailStore/shared parameter is 1, mail storage will be allocated from one or more shared mail stores. Shared mail stores may or may not be shared with other organizations
  - @autoAllocate - (minOccurs=0, maxOccurs=1). Specifies the selection algorithm to use when automatically allocating storage space to the customer organization for the mailbox
  - @algorithm - (minOccurs=0, maxOccurs=1). Specifies the selection algorithm to use when selecting an Exchange mail store for the new mailbox
- SMTPDomain - (minOccurs=0, maxOccurs=1). The SMTP domain to use when generating the user's primary E-Mail address. If not provided, the primary SMTPDomain stored in the Customer Plan Database is used. In general this parameter should only be used for special cases where the default behavior needs to be overridden.
- preferredDomainController - (minOccurs=1, maxOccurs=1). The name of the domain controller to use for this operation
- sAMAccountName - (minOccurs=0, maxOccurs=1). Optional sAMAccountName.
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 CreateBusinessUserResponse class contains the data returned after execution of CreateBusinessUser.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreateBusinessUserResponse.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

<CreateBusinessUserResponse>
  <Data>
	<mail>
	<size>xs:int</size>
	<warningQuota>xs:int</warningQuota>
	<prohibitSendAndReceiveQuota>xs:int</prohibitSendAndReceiveQuota>
	<outgoingSizeLimit>xs:int</outgoingSizeLimit>
	<incomingSizeLimit>xs:int</incomingSizeLimit>
	<POP enable="..">xs:string</POP>
	<IMAP enable="..">xs:string</IMAP>
	<HTTP enable="..">xs:string</HTTP>
	<MAPI enable=".." cachedModeOnly="..">xs:string</MAPI>
	</mail>
	<properties>
	<property name="..">
		<value>xs:string</value>
	</property>
	</properties>
	<user path=".." name="..">
	<memberOfGroup name="..">xs:string</memberOfGroup>
	</user>
  </Data>
</CreateBusinessUserResponse>

Xml Message Elements and Attributes

Data - (minOccurs=1, maxOccurs=1). The root data node
- mail - (minOccurs=0, maxOccurs=1). Container element for Exchange Maibox settings
  - size - (minOccurs=1, maxOccurs=1). size in Kb (equivalent to ProhibitSendQuota). Note that this is value to use when allocating the mailbox to Resource Manager
  - warningQuota - (minOccurs=1, maxOccurs=1). size (in Kb) required to set this, default is 90% of size. Store default used if size is set to 0
  - prohibitSendAndReceiveQuota - (minOccurs=1, maxOccurs=1). size (in Kb) required to set this, default is 500% of size. Store default used if size is set to 0
  - outgoingSizeLimit - (minOccurs=1, maxOccurs=1). max size (in Kb) of outgoing messages, default is unlimited (-1)
  - incomingSizeLimit - (minOccurs=1, maxOccurs=1). max size (in Kb) of incoming messages, default is unlimited (-1)
  - POP - (minOccurs=1, maxOccurs=1). Enable or disable the POP protocol
    - @enable - (minOccurs=0, maxOccurs=1). Enable
  - IMAP - (minOccurs=1, maxOccurs=1). Enable or disable the POP protocol
    - @enable - (minOccurs=0, maxOccurs=1). Enable
  - HTTP - (minOccurs=1, maxOccurs=1). Enable or disable the POP protocol
    - @enable - (minOccurs=0, maxOccurs=1). Enable
  - MAPI - (minOccurs=1, maxOccurs=1). Enable or disable the POP protocol
    - @enable - (minOccurs=0, maxOccurs=1). Enable
    - @cachedModeOnly - (minOccurs=0, maxOccurs=1). Require clients to use cached mode only
- properties - (minOccurs=0, maxOccurs=1). The container element for a collection of properties
  - property - (minOccurs=0, maxOccurs=unbounded). A property
    - value - (minOccurs=0, maxOccurs=unbounded). Value for this property
    - @name - (minOccurs=0, maxOccurs=1). The name of the property
- user - (minOccurs=1, maxOccurs=1). Details regarding a user account
  - memberOfGroup - (minOccurs=0, maxOccurs=unbounded). Group membership
    - @name - (minOccurs=0, maxOccurs=1). Name of the object.
  - @path - (minOccurs=0, maxOccurs=1). The LDAP path of a user object
  - @name - (minOccurs=0, maxOccurs=1). The name of the object

CreateConsumerUser

Create a consumer user in a specified organization

Syntax

public CreateConsumerUserResponse CreateConsumerUser(CreateConsumerUserRequest request) {
}

Parameters

request

The CreateConsumerUserRequest contains the data used in execution of CreateConsumerUser.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreateConsumerUserRequest.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

<CreateConsumerUserRequest>
  <Data>
	<container>xs:string</container>
	<userPrincipalName>xs:string</userPrincipalName>
	<sAMAccountName>xs:string</sAMAccountName>
	<preferredDomainController>xs:string</preferredDomainController>
	<planName>xs:string</planName>
	<mailStore>
	<serverName>xs:string</serverName>
	<mailStoreName>xs:string</mailStoreName>
	</mailStore>
	<mail>
	<size>xs:int</size>
	<warningQuota>xs:int</warningQuota>
	<prohibitSendAndReceiveQuota>xs:int</prohibitSendAndReceiveQuota>
	<outgoingSizeLimit>xs:int</outgoingSizeLimit>
	<incomingSizeLimit>xs:int</incomingSizeLimit>
	</mail>
	<proxyAddresses>
	<value>xs:string</value>
	</proxyAddresses>
	<newPassword do-not-log="..">xs:string</newPassword>
	<displayName>xs:string</displayName>
	<givenName>xs:string</givenName>
	<middleName>xs:string</middleName>
	<sn>xs:string</sn>
	<initials>xs:string</initials>
	<description>xs:string</description>
	<properties>
	<property name="..">
		<value>xs:string</value>
	</property>
	</properties>
	<alias>xs:string</alias>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</CreateConsumerUserRequest>

Xml Message Elements and Attributes

Data - (minOccurs=1, maxOccurs=1). The root data node
- container - (minOccurs=1, maxOccurs=1). A valid LDAP path of the OU where the new organization will be created. For example LDAP://OU=Reseller1,OU=Hosting,DC=fabrikam,DC=Com.
- userPrincipalName - (minOccurs=0, maxOccurs=1). the User principal name of the user. Typically this would be user@SMTPDomain to enable UPN login to e-mail account with the user's e-mail address.
- sAMAccountName - (minOccurs=0, maxOccurs=1). the sAMAccountName
- preferredDomainController - (minOccurs=1, maxOccurs=1). FQDN of a domain controller.
- planName - (minOccurs=0, maxOccurs=1). The name of the desired service plan. Can occur multiple times in the node.
- mailStore - (minOccurs=0, maxOccurs=1). The name of a server to allocate a user's mailbox to. If this optional parameter is present then mailStoreName must also be present. The mail store must be defined as a consumer mail store in resource management.
  - serverName - (minOccurs=0, maxOccurs=1). The name of a server to allocate a user's mailbox to. If this optional parameter is present then mailStoreName must also be present. The mail store must be defined as a consumer mail store in resource management.
  - mailStoreName - (minOccurs=0, maxOccurs=1). The name of a mailstore to allocate a user's mailbox to. If this optional parameter is present then serverName must also be present. The mail store must be defined as a consumer mail store in resource management.
- mail - (minOccurs=0, maxOccurs=1). Container element for Exchange Maibox settings
  - size - (minOccurs=1, maxOccurs=1). size in Kb (equivalent to ProhibitSendQuota). Note that this is value to use when allocating the mailbox to Resource Manager
  - warningQuota - (minOccurs=0, maxOccurs=1). size (in Kb) required to set this, default is 90% of size. Store default used if size is set to 0
  - prohibitSendAndReceiveQuota - (minOccurs=0, maxOccurs=1). size (in Kb) required to set this, default is 500% of size. Store default used if size is set to 0
  - outgoingSizeLimit - (minOccurs=0, maxOccurs=1). max size (in Kb) of outgoing messages, default is unlimited (-1)
  - incomingSizeLimit - (minOccurs=0, maxOccurs=1). max size (in Kb) of incoming messages, default is unlimited (-1)
- proxyAddresses - (minOccurs=0, maxOccurs=1). Additional SMTP proxy addresses for the user
  - value - (minOccurs=0, maxOccurs=unbounded). Value for this instance
- newPassword - (minOccurs=0, maxOccurs=1). The new password for the user. All domain password policy restrictions apply.
  - @do-not-log - (minOccurs=0, maxOccurs=1). Instructs the engine to not log the element value.
- displayName - (minOccurs=0, maxOccurs=1). The user's display name
- givenName - (minOccurs=0, maxOccurs=1). The user's given name
- middleName - (minOccurs=0, maxOccurs=1). The user's middle name
- sn - (minOccurs=0, maxOccurs=1). surname of the user
- initials - (minOccurs=0, maxOccurs=1). The user's initials
- description - (minOccurs=0, maxOccurs=1). description of the organization.
- properties - (minOccurs=0, maxOccurs=1). The container element for a collection of properties
  - property - (minOccurs=0, maxOccurs=unbounded). A property
    - value - (minOccurs=0, maxOccurs=unbounded). Value for this instance
    - @name - (minOccurs=0, maxOccurs=1). The name of the object
- alias - (minOccurs=0, maxOccurs=1). The procedure will accept this as an optional parameter. Other wise an alias will be generated from the UPN prefix (e.g. user from user@alpineskihouse.com)
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 CreateConsumerUserResponse class contains the data returned after execution of CreateConsumerUser.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreateConsumerUserResponse.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

<CreateConsumerUserResponse>
  <Data>
	<mail>
	<size>xs:int</size>
	<warningQuota>xs:int</warningQuota>
	<prohibitSendAndReceiveQuota>xs:int</prohibitSendAndReceiveQuota>
	<outgoingSizeLimit>xs:int</outgoingSizeLimit>
	<incomingSizeLimit>xs:int</incomingSizeLimit>
	<POP enable="..">xs:string</POP>
	<IMAP enable="..">xs:string</IMAP>
	<HTTP enable="..">xs:string</HTTP>
	<MAPI enable=".." cachedModeOnly="..">xs:string</MAPI>
	</mail>
	<properties>
	<property name="..">
		<value>xs:string</value>
	</property>
	</properties>
	<user path=".." name="..">
	<memberOfGroup name="..">xs:string</memberOfGroup>
	</user>
  </Data>
</CreateConsumerUserResponse>

Xml Message Elements and Attributes

Data - (minOccurs=1, maxOccurs=1). The root data node
- mail - (minOccurs=0, maxOccurs=1). Container element for Exchange Maibox settings
  - size - (minOccurs=1, maxOccurs=1). size in Kb (equivalent to ProhibitSendQuota). Note that this is value to use when allocating the mailbox to Resource Manager
  - warningQuota - (minOccurs=1, maxOccurs=1). size (in Kb) required to set this, default is 90% of size. Store default used if size is set to 0
  - prohibitSendAndReceiveQuota - (minOccurs=0, maxOccurs=1). size (in Kb) required to set this, default is 500% of size. Store default used if size is set to 0
  - outgoingSizeLimit - (minOccurs=0, maxOccurs=1). max size (in Kb) of outgoing messages, default is unlimited (-1)
  - incomingSizeLimit - (minOccurs=0, maxOccurs=1). max size (in Kb) of incoming messages, default is unlimited (-1)
  - POP - (minOccurs=0, maxOccurs=1). Enable or disable the POP protocol
    - @enable - (minOccurs=0, maxOccurs=1). Enable
  - IMAP - (minOccurs=0, maxOccurs=1). Enable or disable the POP protocol
    - @enable - (minOccurs=0, maxOccurs=1). Enable
  - HTTP - (minOccurs=0, maxOccurs=1). Enable or disable the POP protocol
    - @enable - (minOccurs=0, maxOccurs=1). Enable
  - MAPI - (minOccurs=0, maxOccurs=1). Enable or disable the POP protocol
    - @enable - (minOccurs=0, maxOccurs=1). Enable
    - @cachedModeOnly - (minOccurs=0, maxOccurs=1). Require clients to use cached mode only
- properties - (minOccurs=0, maxOccurs=1). The container element for a collection of properties
  - property - (minOccurs=0, maxOccurs=unbounded). A property
    - value - (minOccurs=0, maxOccurs=unbounded). Value for this property
    - @name - (minOccurs=0, maxOccurs=1). The name of the property
- user - (minOccurs=1, maxOccurs=1). Details regarding a user account
  - memberOfGroup - (minOccurs=0, maxOccurs=unbounded). Group membership
    - @name - (minOccurs=0, maxOccurs=1). Name of the object.
  - @path - (minOccurs=0, maxOccurs=1). The LDAP path of a user object
  - @name - (minOccurs=0, maxOccurs=1). The name of the object

CreateConsumerVanityDomain

Creates a vanity domain for a consumer user

Syntax

public CreateConsumerVanityDomainResponse CreateConsumerVanityDomain(CreateConsumerVanityDomainRequest request) {
}

Parameters

request

The CreateConsumerVanityDomainRequest contains the data used in execution of CreateConsumerVanityDomain.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreateConsumerVanityDomainRequest.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

<CreateConsumerVanityDomainRequest>
  <Data>
	<path>xs:string</path>
	<name>xs:string</name>
	<SMTPDomain>xs:string</SMTPDomain>
	<preferredDomainController>xs:string</preferredDomainController>
	<createSMTPDomain>xs:string</createSMTPDomain>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</CreateConsumerVanityDomainRequest>

Xml Message Elements and Attributes

Return Value

The CreateConsumerVanityDomainResponse class contains the data returned after execution of CreateConsumerVanityDomain.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreateConsumerVanityDomainResponse.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

<CreateConsumerVanityDomainResponse>
  <Data>xs:string</Data>
</CreateConsumerVanityDomainResponse>

Xml Message Elements and Attributes

CreateDistributionList

Creates a distribution list

Syntax

public CreateDistributionListResponse CreateDistributionList(CreateDistributionListRequest request) {
}

Parameters

request

The CreateDistributionListRequest contains the data used in execution of CreateDistributionList.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreateDistributionListRequest.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

<CreateDistributionListRequest>
  <Data>
	<container>xs:string</container>
	<preferredDomainController>xs:string</preferredDomainController>
	<managedBy>xs:string</managedBy>
	<name>xs:string</name>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</CreateDistributionListRequest>

Xml Message Elements and Attributes

Return Value

The CreateDistributionListResponse class contains the data returned after execution of CreateDistributionList.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreateDistributionListResponse.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

<CreateDistributionListResponse>
  <Data>xs:string</Data>
</CreateDistributionListResponse>

Xml Message Elements and Attributes

CreateMailbox

Create an Exchange Mailbox and mail enable a user

Syntax

public CreateMailboxResponse CreateMailbox(CreateMailboxRequest request) {
}

Parameters

request

The CreateMailboxRequest contains the data used in execution of CreateMailbox.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreateMailboxRequest.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

<CreateMailboxRequest>
  <Data>
	<path>xs:string</path>
	<planName>xs:string</planName>
	<customerTypeName>xs:string</customerTypeName>
	<SMTPDomain>xs:string</SMTPDomain>
	<mailStore autoAllocate=".." algorithm="..">
	<serverName>xs:string</serverName>
	<mailStoreName>xs:string</mailStoreName>
	<shared>xs:boolean</shared>
	</mailStore>
	<proxyAddresses>
	<value>xs:string</value>
	</proxyAddresses>
	<mail>
	<size>xs:int</size>
	<warningQuota>xs:int</warningQuota>
	<prohibitSendAndReceiveQuota>xs:int</prohibitSendAndReceiveQuota>
	<outgoingSizeLimit>xs:int</outgoingSizeLimit>
	<incomingSizeLimit>xs:int</incomingSizeLimit>
	</mail>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</CreateMailboxRequest>

Xml Message Elements and Attributes

Data - (minOccurs=1, maxOccurs=1). The root data node
- path - (minOccurs=0, maxOccurs=1). The LDAP path of a user object
- planName - (minOccurs=1, maxOccurs=1). The Exchange mailbox plan
- customerTypeName - (minOccurs=1, maxOccurs=1). Determines the type of resource management to use. BusinessUser and ConsumerUser are the two allowed inputs for this parameter.
- SMTPDomain - (minOccurs=0, maxOccurs=1). The SMTP domain to use when generating the user's primary E-Mail address. If not provided, the primary SMTPDomain stored in the Customer Plan Database is used. In general this parameter should only be used for special cases where the default behavior needs to be overridden.
- mailStore - (minOccurs=0, maxOccurs=1). The The container node for mailStore settings
  - serverName - (minOccurs=0, maxOccurs=1). The name of a server to allocate a user's mailbox to. This node will only be acknowledged if the mailStoreName optional node is also present
  - mailStoreName - (minOccurs=0, maxOccurs=1). The name of a mailstore to allocate a mailbox to. This node will only be acknowledged if the serverName optional node is also present
  - shared - (minOccurs=0, maxOccurs=1). This parameter only has meaning if the autoAllocate parameter is specified and serverName and mailStoreName are not specified. If this parameter is 0, the organization is given one or more mail stores which will not be shared with other organizations. (Unshared mail stores are those which were added using AddExchangeResources with their shared parameter as 0.) If the mailStore/shared parameter is 1, mail storage will be allocated from one or more shared mail stores. Shared mail stores may or may not be shared with other organizations
  - @autoAllocate - (minOccurs=0, maxOccurs=1). Specifies the selection algorithm to use when automatically allocating storage space to the customer organization for the mailbox
  - @algorithm - (minOccurs=0, maxOccurs=1). Specifies the selection algorithm to use when selecting an Exchange mail store for the new mailbox
- proxyAddresses - (minOccurs=0, maxOccurs=1). Additional SMTP proxy addresses for the user
  - value - (minOccurs=0, maxOccurs=unbounded). Value for this instance
- mail - (minOccurs=0, maxOccurs=1). Container element for Exchange Maibox settings
  - size - (minOccurs=1, maxOccurs=1). size in Kb (equivalent to ProhibitSendQuota). Note that this is value to use when allocating the mailbox to Resource Manager
  - warningQuota - (minOccurs=0, maxOccurs=1). size (in Kb) required to set this, default is 90% of size. Store default used if size is set to 0
  - prohibitSendAndReceiveQuota - (minOccurs=0, maxOccurs=1). size (in Kb) required to set this, default is 500% of size. Store default used if size is set to 0
  - outgoingSizeLimit - (minOccurs=0, maxOccurs=1). max size (in Kb) of outgoing messages, default is unlimited (-1)
  - incomingSizeLimit - (minOccurs=0, maxOccurs=1). max size (in Kb) of incoming messages, default is unlimited (-1)
- preferredDomainController - (minOccurs=1, maxOccurs=1). The name of the domain controller to use for this operation
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 CreateMailboxResponse class contains the data returned after execution of CreateMailbox.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreateMailboxResponse.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

<CreateMailboxResponse>
  <Data>
	<mail>
	<size>xs:int</size>
	<warningQuota>xs:int</warningQuota>
	<prohibitSendAndReceiveQuota>xs:int</prohibitSendAndReceiveQuota>
	<outgoingSizeLimit>xs:int</outgoingSizeLimit>
	<incomingSizeLimit>xs:int</incomingSizeLimit>
	<POP enable="..">xs:string</POP>
	<IMAP enable="..">xs:string</IMAP>
	<HTTP enable="..">xs:string</HTTP>
	<MAPI enable=".." cachedModeOnly="..">xs:string</MAPI>
	</mail>
	<proxyAddresses>
	<value>xs:string</value>
	</proxyAddresses>
  </Data>
</CreateMailboxResponse>

Xml Message Elements and Attributes

CreateOrganizationAddressLists

Creates a Global Address, Address, and Offline Address Lists for an organization

Syntax

public CreateOrganizationAddressListsResponse CreateOrganizationAddressLists(CreateOrganizationAddressListsRequest request) {
}

Parameters

request

The CreateOrganizationAddressListsRequest contains the data used in execution of CreateOrganizationAddressLists.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreateOrganizationAddressListsRequest.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

<CreateOrganizationAddressListsRequest>
  <Data>
	<path>xs:string</path>
	<SMTPDomain>xs:string</SMTPDomain>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</CreateOrganizationAddressListsRequest>

Xml Message Elements and Attributes

Return Value

The CreateOrganizationAddressListsResponse class contains the data returned after execution of CreateOrganizationAddressLists.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreateOrganizationAddressListsResponse.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

<CreateOrganizationAddressListsResponse>
  <Data>xs:string</Data>
</CreateOrganizationAddressListsResponse>

Xml Message Elements and Attributes

CreatePublicFolder

Creates a top level public folder for an organization

Syntax

public CreatePublicFolderResponse CreatePublicFolder(CreatePublicFolderRequest request) {
}

Parameters

request

The CreatePublicFolderRequest contains the data used in execution of CreatePublicFolder.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreatePublicFolderRequest.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

<CreatePublicFolderRequest>
  <Data>
	<path>xs:string</path>
	<megabytes>xs:string</megabytes>
	<preferredDomainController>xs:string</preferredDomainController>
	<SMTPDomain>xs:string</SMTPDomain>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</CreatePublicFolderRequest>

Xml Message Elements and Attributes

Return Value

The CreatePublicFolderResponse class contains the data returned after execution of CreatePublicFolder.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreatePublicFolderResponse.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

<CreatePublicFolderResponse>
  <Data>xs:string</Data>
</CreatePublicFolderResponse>

Xml Message Elements and Attributes

CreateResellerOrganization

Create a reseller organization

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>
	<container>xs:string</container>
	<name>xs:string</name>
	<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

CreateSMTPDomain

Create a secondary SMTP Domain for a customer organization

Syntax

public CreateSMTPDomainResponse CreateSMTPDomain(CreateSMTPDomainRequest request) {
}

Parameters

request

The CreateSMTPDomainRequest contains the data used in execution of CreateSMTPDomain.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreateSMTPDomainRequest.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

<CreateSMTPDomainRequest>
  <Data>
	<path>xs:string</path>
	<preferredDomainController>xs:string</preferredDomainController>
	<SMTPDomain>xs:string</SMTPDomain>
	<createSMTPDomain>xs:string</createSMTPDomain>
	<domainTypeName>xs:string</domainTypeName>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</CreateSMTPDomainRequest>

Xml Message Elements and Attributes

Return Value

The CreateSMTPDomainResponse class contains the data returned after execution of CreateSMTPDomain.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreateSMTPDomainResponse.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

<CreateSMTPDomainResponse>
  <Data>xs:string</Data>
</CreateSMTPDomainResponse>

Xml Message Elements and Attributes

CreateSMTPProxyAddress

Create a SMTP proxy address for a user.

Syntax

public CreateSMTPProxyAddressResponse CreateSMTPProxyAddress(CreateSMTPProxyAddressRequest request) {
}

Parameters

request

The CreateSMTPProxyAddressRequest contains the data used in execution of CreateSMTPProxyAddress.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreateSMTPProxyAddressRequest.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

<CreateSMTPProxyAddressRequest>
  <Data>
	<path>xs:string</path>
	<preferredDomainController>xs:string</preferredDomainController>
	<proxyAddress setPrimary="..">xs:string</proxyAddress>
	<customerTypeName>xs:string</customerTypeName>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</CreateSMTPProxyAddressRequest>

Xml Message Elements and Attributes

Return Value

The CreateSMTPProxyAddressResponse class contains the data returned after execution of CreateSMTPProxyAddress.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreateSMTPProxyAddressResponse.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

<CreateSMTPProxyAddressResponse>
  <Data>xs:string</Data>
</CreateSMTPProxyAddressResponse>

Xml Message Elements and Attributes

DeleteBusinessOrganization

Delete a business organization

Syntax

public DeleteBusinessOrganizationResponse DeleteBusinessOrganization(DeleteBusinessOrganizationRequest request) {
}

Parameters

request

The DeleteBusinessOrganizationRequest contains the data used in execution of DeleteBusinessOrganization.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document DeleteBusinessOrganizationRequest.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

<DeleteBusinessOrganizationRequest>
  <Data>
	<path>xs:string</path>
	<preferredDomainController>xs:string</preferredDomainController>
	<deleteSMTPDomain>xs:string</deleteSMTPDomain>
	<SMTPDomain>xs:string</SMTPDomain>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</DeleteBusinessOrganizationRequest>

Xml Message Elements and Attributes

Return Value

The DeleteBusinessOrganizationResponse class contains the data returned after execution of DeleteBusinessOrganization.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document DeleteBusinessOrganizationResponse.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

<DeleteBusinessOrganizationResponse>
  <Data>xs:string</Data>
</DeleteBusinessOrganizationResponse>

Xml Message Elements and Attributes

DeleteBusinessUser

Delete a business user from a specified organization

Syntax

public DeleteBusinessUserResponse DeleteBusinessUser(DeleteBusinessUserRequest request) {
}

Parameters

request

The DeleteBusinessUserRequest contains the data used in execution of DeleteBusinessUser.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document DeleteBusinessUserRequest.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

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

Xml Message Elements and Attributes

Return Value

The DeleteBusinessUserResponse class contains the data returned after execution of DeleteBusinessUser.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document DeleteBusinessUserResponse.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

<DeleteBusinessUserResponse>
  <Data>xs:string</Data>
</DeleteBusinessUserResponse>

Xml Message Elements and Attributes

DeleteConsumerUser

Delete a Consumer user from a specified organization

Syntax

public DeleteConsumerUserResponse DeleteConsumerUser(DeleteConsumerUserRequest request) {
}

Parameters

request

The DeleteConsumerUserRequest contains the data used in execution of DeleteConsumerUser.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document DeleteConsumerUserRequest.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

<DeleteConsumerUserRequest>
  <Data>
	<path>xs:string</path>
	<preferredDomainController>xs:string</preferredDomainController>
	<deleteSMTPDomain>xs:string</deleteSMTPDomain>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</DeleteConsumerUserRequest>

Xml Message Elements and Attributes

Return Value

The DeleteConsumerUserResponse class contains the data returned after execution of DeleteConsumerUser.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document DeleteConsumerUserResponse.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

<DeleteConsumerUserResponse>
  <Data>xs:string</Data>
</DeleteConsumerUserResponse>

Xml Message Elements and Attributes

DeleteDistributionList

Deletes a distribution list

Syntax

public DeleteDistributionListResponse DeleteDistributionList(DeleteDistributionListRequest request) {
}

Parameters

request

The DeleteDistributionListRequest contains the data used in execution of DeleteDistributionList.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document DeleteDistributionListRequest.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

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

Xml Message Elements and Attributes

Return Value

The DeleteDistributionListResponse class contains the data returned after execution of DeleteDistributionList.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document DeleteDistributionListResponse.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

<DeleteDistributionListResponse>
  <Data>xs:string</Data>
</DeleteDistributionListResponse>

Xml Message Elements and Attributes

DeleteMailbox

Delete a mailbox

Syntax

public DeleteMailboxResponse DeleteMailbox(DeleteMailboxRequest request) {
}

Parameters

request

The DeleteMailboxRequest contains the data used in execution of DeleteMailbox.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document DeleteMailboxRequest.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

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

Xml Message Elements and Attributes

Return Value

The DeleteMailboxResponse class contains the data returned after execution of DeleteMailbox.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document DeleteMailboxResponse.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

<DeleteMailboxResponse>
  <Data>xs:string</Data>
</DeleteMailboxResponse>

Xml Message Elements and Attributes

DeletePublicFolder

Delete a top level public folder for an organization

Syntax

public DeletePublicFolderResponse DeletePublicFolder(DeletePublicFolderRequest request) {
}

Parameters

request

The DeletePublicFolderRequest contains the data used in execution of DeletePublicFolder.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document DeletePublicFolderRequest.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

<DeletePublicFolderRequest>
  <Data>
	<path>xs:string</path>
	<preferredDomainController>xs:string</preferredDomainController>
	<name>xs:string</name>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</DeletePublicFolderRequest>

Xml Message Elements and Attributes

Return Value

The DeletePublicFolderResponse class contains the data returned after execution of DeletePublicFolder.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document DeletePublicFolderResponse.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

<DeletePublicFolderResponse>
  <Data>xs:string</Data>
</DeletePublicFolderResponse>

Xml Message Elements and Attributes

DeleteSMTPDomain

Delete a secondary SMTP Domain for a customer organization

Syntax

public DeleteSMTPDomainResponse DeleteSMTPDomain(DeleteSMTPDomainRequest request) {
}

Parameters

request

The DeleteSMTPDomainRequest contains the data used in execution of DeleteSMTPDomain.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document DeleteSMTPDomainRequest.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

<DeleteSMTPDomainRequest>
  <Data>
	<path>xs:string</path>
	<preferredDomainController>xs:string</preferredDomainController>
	<SMTPDomain>xs:string</SMTPDomain>
	<deleteSMTPDomain>xs:string</deleteSMTPDomain>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</DeleteSMTPDomainRequest>

Xml Message Elements and Attributes

Return Value

The DeleteSMTPDomainResponse class contains the data returned after execution of DeleteSMTPDomain.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document DeleteSMTPDomainResponse.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

<DeleteSMTPDomainResponse>
  <Data>xs:string</Data>
</DeleteSMTPDomainResponse>

Xml Message Elements and Attributes

DeleteSMTPProxyAddress

Delete a SMTP proxy address for a user.

Syntax

public DeleteSMTPProxyAddressResponse DeleteSMTPProxyAddress(DeleteSMTPProxyAddressRequest request) {
}

Parameters

request

The DeleteSMTPProxyAddressRequest contains the data used in execution of DeleteSMTPProxyAddress.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document DeleteSMTPProxyAddressRequest.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

<DeleteSMTPProxyAddressRequest>
  <Data>
	<path>xs:string</path>
	<preferredDomainController>xs:string</preferredDomainController>
	<proxyAddress>xs:string</proxyAddress>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</DeleteSMTPProxyAddressRequest>

Xml Message Elements and Attributes

Return Value

The DeleteSMTPProxyAddressResponse class contains the data returned after execution of DeleteSMTPProxyAddress.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document DeleteSMTPProxyAddressResponse.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

<DeleteSMTPProxyAddressResponse>
  <Data>xs:string</Data>
</DeleteSMTPProxyAddressResponse>

Xml Message Elements and Attributes

DisableMailbox

Disables the Users Mailbox

Syntax

public DisableMailboxResponse DisableMailbox(DisableMailboxRequest request) {
}

Parameters

request

The DisableMailboxRequest contains the data used in execution of DisableMailbox.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document DisableMailboxRequest.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

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

Xml Message Elements and Attributes

Return Value

The DisableMailboxResponse class contains the data returned after execution of DisableMailbox.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document DisableMailboxResponse.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

<DisableMailboxResponse>
  <Data>xs:string</Data>
</DisableMailboxResponse>

Xml Message Elements and Attributes

DisableUser

Disable a customer Active Directory user object

Syntax

public DisableUserResponse DisableUser(DisableUserRequest request) {
}

Parameters

request

The DisableUserRequest contains the data used in execution of DisableUser.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document DisableUserRequest.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

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

Xml Message Elements and Attributes

Return Value

The DisableUserResponse class contains the data returned after execution of DisableUser.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document DisableUserResponse.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

<DisableUserResponse>
  <Data>xs:string</Data>
</DisableUserResponse>

Xml Message Elements and Attributes

EnableMailbox

Enables the Users Mailbox

Syntax

public EnableMailboxResponse EnableMailbox(EnableMailboxRequest request) {
}

Parameters

request

The EnableMailboxRequest contains the data used in execution of EnableMailbox.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document EnableMailboxRequest.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

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

Xml Message Elements and Attributes

Return Value

The EnableMailboxResponse class contains the data returned after execution of EnableMailbox.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document EnableMailboxResponse.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

<EnableMailboxResponse>
  <Data>xs:string</Data>
</EnableMailboxResponse>

Xml Message Elements and Attributes

EnableUser

Enable a customer Active Directory user object

Syntax

public EnableUserResponse EnableUser(EnableUserRequest request) {
}

Parameters

request

The EnableUserRequest contains the data used in execution of EnableUser.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document EnableUserRequest.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

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

Xml Message Elements and Attributes

Return Value

The EnableUserResponse class contains the data returned after execution of EnableUser.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document EnableUserResponse.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

<EnableUserResponse>
  <Data>xs:string</Data>
</EnableUserResponse>

Xml Message Elements and Attributes

EnsureExchangeVirtualDirectories

Ensures a virtual directory on every Exchange server. Succeeds if it already exists.

Syntax

public EnsureExchangeVirtualDirectoriesResponse EnsureExchangeVirtualDirectories(EnsureExchangeVirtualDirectoriesRequest request) {
}

Parameters

request

The EnsureExchangeVirtualDirectoriesRequest contains the data used in execution of EnsureExchangeVirtualDirectories.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document EnsureExchangeVirtualDirectoriesRequest.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

<EnsureExchangeVirtualDirectoriesRequest>
  <Data>
	<path>xs:string</path>
	<SMTPDomain>xs:string</SMTPDomain>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</EnsureExchangeVirtualDirectoriesRequest>

Xml Message Elements and Attributes

Return Value

The EnsureExchangeVirtualDirectoriesResponse class contains the data returned after execution of EnsureExchangeVirtualDirectories.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document EnsureExchangeVirtualDirectoriesResponse.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

<EnsureExchangeVirtualDirectoriesResponse>
  <Data>xs:string</Data>
</EnsureExchangeVirtualDirectoriesResponse>

Xml Message Elements and Attributes

ExchangeEnableOrganization

Enable an organization for Exchange mailboxes

Syntax

public ExchangeEnableOrganizationResponse ExchangeEnableOrganization(ExchangeEnableOrganizationRequest request) {
}

Parameters

request

The ExchangeEnableOrganizationRequest contains the data used in execution of ExchangeEnableOrganization.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document ExchangeEnableOrganizationRequest.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

<ExchangeEnableOrganizationRequest>
  <Data>
	<path>xs:string</path>
	<SMTPDomain>xs:string</SMTPDomain>
	<preferredDomainController>xs:string</preferredDomainController>
	<mailStore algorithm="..">
	<megabytes>xs:int</megabytes>
	<shared>xs:boolean</shared>
	<sourceMailStores>
		<sourceMailStore>
		<serverName>xs:string</serverName>
		<mailStoreName>xs:string</mailStoreName>
		<megabytes>xs:int</megabytes>
		</sourceMailStore>
	</sourceMailStores>
	</mailStore>
	<publicStore>
	<megabytes>xs:int</megabytes>
	<sourcePublicStoreServer>xs:string</sourcePublicStoreServer>
	</publicStore>
	<createSMTPDomain>xs:string</createSMTPDomain>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</ExchangeEnableOrganizationRequest>

Xml Message Elements and Attributes

Data - (minOccurs=1, maxOccurs=1). The root data node
- path - (minOccurs=1, maxOccurs=1). LDAP path of the organization.
- SMTPDomain - (minOccurs=0, maxOccurs=1). The SMTP domain of the new organization. For example alpineskihouse.com.
- preferredDomainController - (minOccurs=1, maxOccurs=1). FQDN of a domain controller.
- mailStore - (minOccurs=0, maxOccurs=1). The container element for Exchange mail store settings.
  - megabytes - (minOccurs=0, maxOccurs=1). Size of the public folder allocation.
  - shared - (minOccurs=0, maxOccurs=1). If this parameter is 0, the organization is given one or more mail stores which will not be shared with other organizations. (Unshared mail stores are those which were added using AddExchangeResources with their shared parameter as 0.) If the mailStore shared parameter is 1, mail storage will be allocated from one or more shared mail stores. Shared mail stores may or may not be shared with other organizations
  - sourceMailStores - (minOccurs=0, maxOccurs=1). If this parameter is supplied, then the automatic allocation behavior is overridden, and the mailStore megabytes parameter is ignored. The sourceMailStores parameter specifies a set of mail stores to be allocated to this org. If any of the specifed stores is unavailable or has insufficient storage, then the entire call will fail. The total mail storage allocation for the org will be the total of the megabytes parameters in all of the supplied sourceMailStore parameters
    - sourceMailStore - (minOccurs=0, maxOccurs=1). Container element for source mail store settings
      - serverName - (minOccurs=0, maxOccurs=1). The name of a server. If this optional parameter is present then mailStoreName must also be present. The mail store must be defined as a consumer mail store in resource management.
      - mailStoreName - (minOccurs=0, maxOccurs=1). The name of a mailstore. If this optional parameter is present then serverName must also be present. The mail store must be defined as a consumer mail store in resource management.
      - megabytes - (minOccurs=0, maxOccurs=1). Size of the mailbox store allocation.
  - @algorithm - (minOccurs=0, maxOccurs=1). Possible values are "level" and "tightPack". Default is "tightPack". If this attribute is "tightPack", allocations are packed tightly to minimize the number of servers used. Otherwise, packing is leveled across mail stores. Leveling is recommended to facilitate upselling of services. Note that this attribute is ignored if the customerTypeName=ConsumerUser.
- publicStore - (minOccurs=0, maxOccurs=1). number of megabytes in publicstore allocation to reserve for the organization
  - megabytes - (minOccurs=1, maxOccurs=1). Size of the public folder allocation.
  - sourcePublicStoreServer - (minOccurs=0, maxOccurs=1). If this parameter is supplied, it specifies the public store to put the organization's public folder storage on
- createSMTPDomain - (minOccurs=0, maxOccurs=1). Legacy flag indicating that the domain should be added to an Exchange Recipient Policy
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 ExchangeEnableOrganizationResponse class contains the data returned after execution of ExchangeEnableOrganization.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document ExchangeEnableOrganizationResponse.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

<ExchangeEnableOrganizationResponse>
  <Data>xs:string</Data>
</ExchangeEnableOrganizationResponse>

Xml Message Elements and Attributes

GetModifiedOrganizations

Returns organizations that have had membership changes and modifications after a specified date

Syntax

public GetModifiedOrganizationsResponse GetModifiedOrganizations(GetModifiedOrganizationsRequest request) {
}

Parameters

request

The GetModifiedOrganizationsRequest contains the data used in execution of GetModifiedOrganizations.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document GetModifiedOrganizationsRequest.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

<GetModifiedOrganizationsRequest>
  <Data>
	<startDate>xs:string</startDate>
	<endDate>xs:string</endDate>
	<preferredDomainController>xs:string</preferredDomainController>
	<maximumRows>xs:int</maximumRows>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</GetModifiedOrganizationsRequest>

Xml Message Elements and Attributes

Return Value

The GetModifiedOrganizationsResponse class contains the data returned after execution of GetModifiedOrganizations.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document GetModifiedOrganizationsResponse.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

<GetModifiedOrganizationsResponse>
  <Data>
	<orgs>
	<org>xs:string</org>
	</orgs>
  </Data>
</GetModifiedOrganizationsResponse>

Xml Message Elements and Attributes

GetProperties

Get properties for an object given an LDAP path

Syntax

public GetPropertiesResponse GetProperties(GetPropertiesRequest request) {
}

Parameters

request

The GetPropertiesRequest contains the data used in execution of GetProperties.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document GetPropertiesRequest.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

<GetPropertiesRequest>
  <Data>
	<preferredDomainController>xs:string</preferredDomainController>
	<path>xs:string</path>
	<propertyList>
	<property name="..">xs:string</property>
	</propertyList>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</GetPropertiesRequest>

Xml Message Elements and Attributes

Return Value

The GetPropertiesResponse class contains the data returned after execution of GetProperties.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document GetPropertiesResponse.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

<GetPropertiesResponse>
  <Data>
	<properties>
	<property name="..">
		<value>xs:string</value>
	</property>
	</properties>
  </Data>
</GetPropertiesResponse>

Xml Message Elements and Attributes

GetUserMailboxPlan

Gets the Current Plan Assigned to the User

Syntax

public GetUserMailboxPlanResponse GetUserMailboxPlan(GetUserMailboxPlanRequest request) {
}

Parameters

request

The GetUserMailboxPlanRequest contains the data used in execution of GetUserMailboxPlan.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document GetUserMailboxPlanRequest.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

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

Xml Message Elements and Attributes

Return Value

The GetUserMailboxPlanResponse class contains the data returned after execution of GetUserMailboxPlan.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document GetUserMailboxPlanResponse.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

<GetUserMailboxPlanResponse>
  <Data>
	<planName>xs:string</planName>
	<statusTypeName>xs:string</statusTypeName>
	<planDescription>xs:string</planDescription>
	<planTypeName>xs:string</planTypeName>
	<planSettings>xs:string</planSettings>
	<planFeatures>
	<feature>
		<featureName>xs:string</featureName>
		<featureDescription>xs:string</featureDescription>
		<featureValue>xs:string</featureValue>
		<nativeAttribute>xs:string</nativeAttribute>
		<parentNode>xs:string</parentNode>
	</feature>
	</planFeatures>
  </Data>
</GetUserMailboxPlanResponse>

Xml Message Elements and Attributes

InitializeCustomerPlanDatabase

Adds Hosted Exchange customer, asset, event, status, and feature types to the Customer Plan Database.

Syntax

public InitializeCustomerPlanDatabaseResponse InitializeCustomerPlanDatabase(InitializeCustomerPlanDatabaseRequest request) {
}

Parameters

request

The InitializeCustomerPlanDatabaseRequest contains the data used in execution of InitializeCustomerPlanDatabase.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document InitializeCustomerPlanDatabaseRequest.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

<InitializeCustomerPlanDatabaseRequest>
  <Data>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</InitializeCustomerPlanDatabaseRequest>

Xml Message Elements and Attributes

Return Value

The InitializeCustomerPlanDatabaseResponse class contains the data returned after execution of InitializeCustomerPlanDatabase.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document InitializeCustomerPlanDatabaseResponse.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

<InitializeCustomerPlanDatabaseResponse>
  <Data>xs:string</Data>
</InitializeCustomerPlanDatabaseResponse>

Xml Message Elements and Attributes

InitializeHostedExchange

Performs initialization for Hosted Exchange

Syntax

public InitializeHostedExchangeResponse InitializeHostedExchange(InitializeHostedExchangeRequest request) {
}

Parameters

request

The InitializeHostedExchangeRequest contains the data used in execution of InitializeHostedExchange.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document InitializeHostedExchangeRequest.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

<InitializeHostedExchangeRequest>
  <Data>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</InitializeHostedExchangeRequest>

Xml Message Elements and Attributes

Return Value

The InitializeHostedExchangeResponse class contains the data returned after execution of InitializeHostedExchange.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document InitializeHostedExchangeResponse.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

<InitializeHostedExchangeResponse>
  <Data>xs:string</Data>
</InitializeHostedExchangeResponse>

Xml Message Elements and Attributes

InitializeNamespaceSecurity

Initialize the security for the procedures in this namespace

Syntax

public InitializeNamespaceSecurityResponse InitializeNamespaceSecurity(InitializeNamespaceSecurityRequest request) {
}

Parameters

request

The InitializeNamespaceSecurityRequest contains the data used in execution of InitializeNamespaceSecurity.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document InitializeNamespaceSecurityRequest.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

<InitializeNamespaceSecurityRequest>
  <Data>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</InitializeNamespaceSecurityRequest>

Xml Message Elements and Attributes

Return Value

The InitializeNamespaceSecurityResponse class contains the data returned after execution of InitializeNamespaceSecurity.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document InitializeNamespaceSecurityResponse.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

<InitializeNamespaceSecurityResponse>
  <Data>xs:string</Data>
</InitializeNamespaceSecurityResponse>

Xml Message Elements and Attributes

MailDisableContact

Disable a Contact for Mail

Syntax

public MailDisableContactResponse MailDisableContact(MailDisableContactRequest request) {
}

Parameters

request

The MailDisableContactRequest contains the data used in execution of MailDisableContact.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document MailDisableContactRequest.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

<MailDisableContactRequest>
  <Data>
	<contact>xs:string</contact>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</MailDisableContactRequest>

Xml Message Elements and Attributes

Return Value

The MailDisableContactResponse class contains the data returned after execution of MailDisableContact.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document MailDisableContactResponse.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

<MailDisableContactResponse>
  <Data>xs:string</Data>
</MailDisableContactResponse>

Xml Message Elements and Attributes

MailDisableGroup

Mail Disables a Group for Mail

Syntax

public MailDisableGroupResponse MailDisableGroup(MailDisableGroupRequest request) {
}

Parameters

request

The MailDisableGroupRequest contains the data used in execution of MailDisableGroup.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document MailDisableGroupRequest.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

<MailDisableGroupRequest>
  <Data>
	<group>xs:string</group>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</MailDisableGroupRequest>

Xml Message Elements and Attributes

Return Value

The MailDisableGroupResponse class contains the data returned after execution of MailDisableGroup.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document MailDisableGroupResponse.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

<MailDisableGroupResponse>
  <Data>xs:string</Data>
</MailDisableGroupResponse>

Xml Message Elements and Attributes

MailEnableContact

Enables a Contact for Mail

Syntax

public MailEnableContactResponse MailEnableContact(MailEnableContactRequest request) {
}

Parameters

request

The MailEnableContactRequest contains the data used in execution of MailEnableContact.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document MailEnableContactRequest.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

<MailEnableContactRequest>
  <Data>
	<contact>xs:string</contact>
	<preferredDomainController>xs:string</preferredDomainController>
	<proxyAddress>xs:string</proxyAddress>
	<targetAddress>xs:string</targetAddress>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</MailEnableContactRequest>

Xml Message Elements and Attributes

Return Value

The MailEnableContactResponse class contains the data returned after execution of MailEnableContact.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document MailEnableContactResponse.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

<MailEnableContactResponse>
  <Data>xs:string</Data>
</MailEnableContactResponse>

Xml Message Elements and Attributes

MailEnableGroup

Mail Enables a Group for Mail

Syntax

public MailEnableGroupResponse MailEnableGroup(MailEnableGroupRequest request) {
}

Parameters

request

The MailEnableGroupRequest contains the data used in execution of MailEnableGroup.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document MailEnableGroupRequest.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

<MailEnableGroupRequest>
  <Data>
	<group>xs:string</group>
	<preferredDomainController>xs:string</preferredDomainController>
	<proxyAddress>xs:string</proxyAddress>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</MailEnableGroupRequest>

Xml Message Elements and Attributes

Return Value

The MailEnableGroupResponse class contains the data returned after execution of MailEnableGroup.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document MailEnableGroupResponse.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

<MailEnableGroupResponse>
  <Data>xs:string</Data>
</MailEnableGroupResponse>

Xml Message Elements and Attributes

MakeUserAdmin

Adds or removes a user from the admin group of a specified organization

Syntax

public MakeUserAdminResponse MakeUserAdmin(MakeUserAdminRequest request) {
}

Parameters

request

The MakeUserAdminRequest contains the data used in execution of MakeUserAdmin.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document MakeUserAdminRequest.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

<MakeUserAdminRequest>
  <Data>
	<path>xs:string</path>
	<isAdmin>xs:boolean</isAdmin>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</MakeUserAdminRequest>

Xml Message Elements and Attributes

Return Value

The MakeUserAdminResponse class contains the data returned after execution of MakeUserAdmin.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document MakeUserAdminResponse.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

<MakeUserAdminResponse>
  <Data>xs:string</Data>
</MakeUserAdminResponse>

Xml Message Elements and Attributes

ModifyDistributionList

Modifys a distribution list

Syntax

public ModifyDistributionListResponse ModifyDistributionList(ModifyDistributionListRequest request) {
}

Parameters

request

The ModifyDistributionListRequest contains the data used in execution of ModifyDistributionList.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document ModifyDistributionListRequest.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

<ModifyDistributionListRequest>
  <Data>
	<path>xs:string</path>
	<preferredDomainController>xs:string</preferredDomainController>
	<managedBy>xs:string</managedBy>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</ModifyDistributionListRequest>

Xml Message Elements and Attributes

Return Value

The ModifyDistributionListResponse class contains the data returned after execution of ModifyDistributionList.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document ModifyDistributionListResponse.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

<ModifyDistributionListResponse>
  <Data>xs:string</Data>
</ModifyDistributionListResponse>

Xml Message Elements and Attributes

ModifyUser

Modify an Active Directory user object

Syntax

public ModifyUserResponse ModifyUser(ModifyUserRequest request) {
}

Parameters

request

The ModifyUserRequest contains the data used in execution of ModifyUser.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document ModifyUserRequest.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

<ModifyUserRequest>
  <Data>
	<path>xs:string</path>
	<preferredDomainController>xs:string</preferredDomainController>
	<displayName>xs:string</displayName>
	<givenName>xs:string</givenName>
	<middleName>xs:string</middleName>
	<sn>xs:string</sn>
	<initials>xs:string</initials>
	<description>xs:string</description>
	<properties>
	<property name=".." mode="..">
		<value>xs:string</value>
	</property>
	</properties>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</ModifyUserRequest>

Xml Message Elements and Attributes

Return Value

The ModifyUserResponse class contains the data returned after execution of ModifyUser.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document ModifyUserResponse.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

<ModifyUserResponse>
  <Data>xs:string</Data>
</ModifyUserResponse>

Xml Message Elements and Attributes

ModifyUserMailboxQuota

Change the Exchange mailbox quotas for a specified user.

Syntax

public ModifyUserMailboxQuotaResponse ModifyUserMailboxQuota(ModifyUserMailboxQuotaRequest request) {
}

Parameters

request

The ModifyUserMailboxQuotaRequest contains the data used in execution of ModifyUserMailboxQuota.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document ModifyUserMailboxQuotaRequest.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

<ModifyUserMailboxQuotaRequest>
  <Data>
	<path>xs:string</path>
	<preferredDomainController>xs:string</preferredDomainController>
	<customerTypeName>xs:string</customerTypeName>
	<mail>
	<size>xs:int</size>
	<warningQuota>xs:int</warningQuota>
	<prohibitSendAndReceiveQuota>xs:int</prohibitSendAndReceiveQuota>
	<outgoingSizeLimit>xs:int</outgoingSizeLimit>
	<incomingSizeLimit>xs:int</incomingSizeLimit>
	</mail>
	<mailStore autoAllocate="..">xs:string</mailStore>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</ModifyUserMailboxQuotaRequest>

Xml Message Elements and Attributes

Return Value

The ModifyUserMailboxQuotaResponse class contains the data returned after execution of ModifyUserMailboxQuota.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document ModifyUserMailboxQuotaResponse.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

<ModifyUserMailboxQuotaResponse>
  <Data>
	<properties>
	<property name="..">
		<value>xs:string</value>
	</property>
	</properties>
	<mail>
	<size>xs:int</size>
	<warningQuota>xs:int</warningQuota>
	<prohibitSendAndReceiveQuota>xs:int</prohibitSendAndReceiveQuota>
	<outgoingSizeLimit>xs:int</outgoingSizeLimit>
	<incomingSizeLimit>xs:int</incomingSizeLimit>
	</mail>
  </Data>
</ModifyUserMailboxQuotaResponse>

Xml Message Elements and Attributes

AddAvailablePlans

Adds service plans to the available plans list for an organization

Syntax

public AddAvailablePlansResponse AddAvailablePlans(AddAvailablePlansRequest request) {
}

Parameters

request

The AddAvailablePlansRequest contains the data used in execution of AddAvailablePlans.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document AddAvailablePlansRequest.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

<AddAvailablePlansRequest>
  <Data>
	<path>xs:string</path>
	<preferredDomainController>xs:string</preferredDomainController>
	<availablePlans>
	<planName>xs:string</planName>
	</availablePlans>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</AddAvailablePlansRequest>

Xml Message Elements and Attributes

Return Value

The AddAvailablePlansResponse class contains the data returned after execution of AddAvailablePlans.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document AddAvailablePlansResponse.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

<AddAvailablePlansResponse>
  <Data>xs:string</Data>
</AddAvailablePlansResponse>

Xml Message Elements and Attributes

ChangeUserMailboxPlan

Change the Exchange mailbox service plan for a specified user.

Syntax

public ChangeUserMailboxPlanResponse ChangeUserMailboxPlan(ChangeUserMailboxPlanRequest request) {
}

Parameters

request

The ChangeUserMailboxPlanRequest contains the data used in execution of ChangeUserMailboxPlan.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document ChangeUserMailboxPlanRequest.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

<ChangeUserMailboxPlanRequest>
  <Data>
	<path>xs:string</path>
	<planName>xs:string</planName>
	<preferredDomainController>xs:string</preferredDomainController>
	<customerTypeName>xs:string</customerTypeName>
	<mail>
	<size>xs:int</size>
	<warningQuota>xs:int</warningQuota>
	<prohibitSendAndReceiveQuota>xs:int</prohibitSendAndReceiveQuota>
	<outgoingSizeLimit>xs:int</outgoingSizeLimit>
	<incomingSizeLimit>xs:int</incomingSizeLimit>
	</mail>
	<mailStore autoAllocate="..">xs:string</mailStore>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</ChangeUserMailboxPlanRequest>

Xml Message Elements and Attributes

Return Value

The ChangeUserMailboxPlanResponse class contains the data returned after execution of ChangeUserMailboxPlan.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document ChangeUserMailboxPlanResponse.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

<ChangeUserMailboxPlanResponse>
  <Data>
	<properties>
	<property name="..">
		<value>xs:string</value>
	</property>
	</properties>
	<mail>
	<size>xs:int</size>
	<warningQuota>xs:int</warningQuota>
	<prohibitSendAndReceiveQuota>xs:int</prohibitSendAndReceiveQuota>
	<outgoingSizeLimit>xs:int</outgoingSizeLimit>
	<incomingSizeLimit>xs:int</incomingSizeLimit>
	<POP enable="..">xs:string</POP>
	<IMAP enable="..">xs:string</IMAP>
	<HTTP enable="..">xs:string</HTTP>
	<MAPI enable=".." cachedModeOnly="..">xs:string</MAPI>
	</mail>
  </Data>
</ChangeUserMailboxPlanResponse>

Xml Message Elements and Attributes

CreateMailboxPlan

Creates a service plan for Exchange mailboxes

Syntax

public CreateMailboxPlanResponse CreateMailboxPlan(CreateMailboxPlanRequest request) {
}

Parameters

request

The CreateMailboxPlanRequest contains the data used in execution of CreateMailboxPlan.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreateMailboxPlanRequest.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

<CreateMailboxPlanRequest>
  <Data>
	<planName>xs:string</planName>
	<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>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</CreateMailboxPlanRequest>

Xml Message Elements and Attributes

Return Value

The CreateMailboxPlanResponse class contains the data returned after execution of CreateMailboxPlan.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreateMailboxPlanResponse.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

<CreateMailboxPlanResponse>
  <Data>xs:string</Data>
</CreateMailboxPlanResponse>

Xml Message Elements and Attributes

CreatePlanFeatureTypes

Creates one or many service plan feature types in the customer plan database

Syntax

public CreatePlanFeatureTypesResponse CreatePlanFeatureTypes(CreatePlanFeatureTypesRequest request) {
}

Parameters

request

The CreatePlanFeatureTypesRequest contains the data used in execution of CreatePlanFeatureTypes.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreatePlanFeatureTypesRequest.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

<CreatePlanFeatureTypesRequest>
  <Data>
	<planFeatures>
	<feature>
		<featureName>xs:string</featureName>
		<featureDescription>xs:string</featureDescription>
		<nativeAttribute>xs:string</nativeAttribute>
		<parentNode>xs:string</parentNode>
		<xslDataType>xs:string</xslDataType>
	</feature>
	</planFeatures>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</CreatePlanFeatureTypesRequest>

Xml Message Elements and Attributes

Return Value

The CreatePlanFeatureTypesResponse class contains the data returned after execution of CreatePlanFeatureTypes.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document CreatePlanFeatureTypesResponse.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

<CreatePlanFeatureTypesResponse>
  <Data>xs:string</Data>
</CreatePlanFeatureTypesResponse>

Xml Message Elements and Attributes

GetOrganizationAvailablePlans

Returns a listing of service plans that are available for an organization's users

Syntax

public GetOrganizationAvailablePlansResponse GetOrganizationAvailablePlans(GetOrganizationAvailablePlansRequest request) {
}

Parameters

request

The GetOrganizationAvailablePlansRequest contains the data used in execution of GetOrganizationAvailablePlans.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document GetOrganizationAvailablePlansRequest.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

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

Xml Message Elements and Attributes

Return Value

The GetOrganizationAvailablePlansResponse class contains the data returned after execution of GetOrganizationAvailablePlans.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document GetOrganizationAvailablePlansResponse.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

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

Xml Message Elements and Attributes

GetOrganizationDomains

Returns a listing of SMTP Domains for a specified organization.

Syntax

public GetOrganizationDomainsResponse GetOrganizationDomains(GetOrganizationDomainsRequest request) {
}

Parameters

request

The GetOrganizationDomainsRequest contains the data used in execution of GetOrganizationDomains.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document GetOrganizationDomainsRequest.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

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

Xml Message Elements and Attributes

Return Value

The GetOrganizationDomainsResponse class contains the data returned after execution of GetOrganizationDomains.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document GetOrganizationDomainsResponse.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

<GetOrganizationDomainsResponse>
  <Data>
	<SMTPDomains>
	<SMTPDomain>
		<domainName>xs:string</domainName>
		<domainTypeName>xs:string</domainTypeName>
	</SMTPDomain>
	</SMTPDomains>
  </Data>
</GetOrganizationDomainsResponse>

Xml Message Elements and Attributes

GetPlanDetail

Returns details for a specified service plan

Syntax

public GetPlanDetailResponse GetPlanDetail(GetPlanDetailRequest request) {
}

Parameters

request

The GetPlanDetailRequest contains the data used in execution of GetPlanDetail.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document GetPlanDetailRequest.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

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

Xml Message Elements and Attributes

Return Value

The GetPlanDetailResponse class contains the data returned after execution of GetPlanDetail.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document GetPlanDetailResponse.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

<GetPlanDetailResponse>
  <Data>
	<planName>xs:string</planName>
	<statusTypeName>xs:string</statusTypeName>
	<planDescription>xs:string</planDescription>
	<planTypeName>xs:string</planTypeName>
	<planSettings>xs:string</planSettings>
	<planFeatures>
	<feature>
		<featureName>xs:string</featureName>
		<featureDescription>xs:string</featureDescription>
		<featureValue>xs:string</featureValue>
		<nativeAttribute>xs:string</nativeAttribute>
		<parentNode>xs:string</parentNode>
	</feature>
	</planFeatures>
  </Data>
</GetPlanDetailResponse>

Xml Message Elements and Attributes

GetPlans

Returns listing of service plans based on optional filters

Syntax

public GetPlansResponse GetPlans(GetPlansRequest request) {
}

Parameters

request

The GetPlansRequest contains the data used in execution of GetPlans.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document GetPlansRequest.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

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

Xml Message Elements and Attributes

Return Value

The GetPlansResponse class contains the data returned after execution of GetPlans.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document GetPlansResponse.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

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

Xml Message Elements and Attributes

RemoveAvailablePlans

Removes service plans from the available plans list for an organization

Syntax

public RemoveAvailablePlansResponse RemoveAvailablePlans(RemoveAvailablePlansRequest request) {
}

Parameters

request

The RemoveAvailablePlansRequest contains the data used in execution of RemoveAvailablePlans.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document RemoveAvailablePlansRequest.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

<RemoveAvailablePlansRequest>
  <Data>
	<path>xs:string</path>
	<preferredDomainController>xs:string</preferredDomainController>
	<availablePlans>
	<planName>xs:string</planName>
	</availablePlans>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</RemoveAvailablePlansRequest>

Xml Message Elements and Attributes

Return Value

The RemoveAvailablePlansResponse class contains the data returned after execution of RemoveAvailablePlans.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document RemoveAvailablePlansResponse.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

<RemoveAvailablePlansResponse>
  <Data>xs:string</Data>
</RemoveAvailablePlansResponse>

Xml Message Elements and Attributes

RebuildOfflineAddressList

Rebuilds the Offline Address List for a specified organization

Syntax

public RebuildOfflineAddressListResponse RebuildOfflineAddressList(RebuildOfflineAddressListRequest request) {
}

Parameters

request

The RebuildOfflineAddressListRequest contains the data used in execution of RebuildOfflineAddressList.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document RebuildOfflineAddressListRequest.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

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

Xml Message Elements and Attributes

Return Value

The RebuildOfflineAddressListResponse class contains the data returned after execution of RebuildOfflineAddressList.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document RebuildOfflineAddressListResponse.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

<RebuildOfflineAddressListResponse>
  <Data>xs:string</Data>
</RebuildOfflineAddressListResponse>

Xml Message Elements and Attributes

SetCustomerDatabaseLocation

Sets the location and database name of the customer database

Syntax

public SetCustomerDatabaseLocationResponse SetCustomerDatabaseLocation(SetCustomerDatabaseLocationRequest request) {
}

Parameters

request

The SetCustomerDatabaseLocationRequest contains the data used in execution of SetCustomerDatabaseLocation.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document SetCustomerDatabaseLocationRequest.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

<SetCustomerDatabaseLocationRequest>
  <Data>
	<serverName>xs:string</serverName>
	<databaseName>xs:string</databaseName>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</SetCustomerDatabaseLocationRequest>

Xml Message Elements and Attributes

Return Value

The SetCustomerDatabaseLocationResponse class contains the data returned after execution of SetCustomerDatabaseLocation.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document SetCustomerDatabaseLocationResponse.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

<SetCustomerDatabaseLocationResponse>
  <Data>xs:string</Data>
</SetCustomerDatabaseLocationResponse>

Xml Message Elements and Attributes

SetUserPassword

Set the password of a customer Active Directory user object

Syntax

public SetUserPasswordResponse SetUserPassword(SetUserPasswordRequest request) {
}

Parameters

request

The SetUserPasswordRequest contains the data used in execution of SetUserPassword.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document SetUserPasswordRequest.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

<SetUserPasswordRequest>
  <Data>
	<path>xs:string</path>
	<newPassword do-not-log="..">xs:string</newPassword>
	<preferredDomainController>xs:string</preferredDomainController>
  </Data>
  <Username>xs:string</Username>
  <Password>xs:string</Password>
</SetUserPasswordRequest>

Xml Message Elements and Attributes

Return Value

The SetUserPasswordResponse class contains the data returned after execution of SetUserPassword.This class is an XmlSerialization compliant class generated from an Xml Schema Definition.The Xml Schema Definition document SetUserPasswordResponse.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

<SetUserPasswordResponse>
  <Data>xs:string</Data>
</SetUserPasswordResponse>

Xml Message Elements and Attributes

Common WES Operations

This category contains the following public procedures for common operations of a typical WES that are implemented by the WES for Hosted Exchange.

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.

Web Services Description Language (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 Value-added Services (VAS), their states, and the actions that they support. This response is based on the System Definition Model (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.

Web Services Description Language (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 Value-added Services (VAS) back end.

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 (success, 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>