Managed Plans::GetPlansByCustomer

This procedure returns a list of all of the plans assigned to a customer based on supplied GUID or PATH.

Input Arguments for Hosted Messaging and Collaboration version 4.0 or earlier

Input Arguments	Type	Required	Description
<preferredDomainController>	string	Yes	The domain controller to use for Active Directory operations. Use the fully qualified domain name of the domain controller that you want to use.
<path>	string	Yes	The Lightweight Directory Access Protocol (LDAP) path of the organization Active Directory object.
<statusTypeName>	string	Yes	The status type for the new customer -- for example, "Enabled."
<planTypeName>	string	No	Allows you filter the response by plan type.
<serviceName>	string	No	Filter the response by serviceName associated with plan type.

Input Arguments for Hosted Messaging and Collaboration version 4.5

Input Arguments	Type	Required	Description
<preferredDomainController>	string	No	The domain controller to use for Active Directory operations. Use the fully qualified domain name of the domain controller that you want to use.
<GUID>	string	Yes if <Path> is not specified.	The GUID of customer instance. GUID should only be specified when the customer object is no longer found in Active Directory. That is, customer has been orphaned in the plans Database.
<path>	string	Yes if <GUID> is not specified.	The Lightweight Directory Access Protocol (LDAP) path of the customer instance. If both GUID and path are supplied, GUID takes precedence, path is ignored.
<planTypeName>	string	No	The unique friendly type name.
<statusTypeName>	string	No	The status type for the new customer -- for example, "Enabled."
<serviceName>	string	No	Filter the response by serviceName associated with plan type.

Output Arguments	Description
<plans>	Container element for plan definition. Empty node is returned if no plans for this customer.
<plans/plan>	Zero or more plan definitions.
<plan/dateAssigned>	The date the plan was added to the customer's available plans list.
<plan/planDescription>	The plan description.
<plan/planName>	The name of the plan.
<plan/planStatus>	The status of the plan.
<plan/planTypeName>	The plan type.
<plan/serviceName>	The name of the service associated with the plan type.

Remarks

Sample Code

Example XML Request

<request>
  <data>
	<!--GUID of the customer Active Directory object. Both of two formats are supported: {6e315934-b0f1-4343-9a0a-c9de3ee90eef}or 3459316ef1b043439a0ac9de3ee90eef-->
	<GUID>3459316ef1b043439a0ac9de3ee90eef</GUID>
	<!--The preferred domain controller for Active Directory operations.-->
	<preferredDomainController>AD01.Fabrikam.Com</preferredDomainController>
	<!--The status type for the new type. E.g. "Enabled."-->
	<statusTypeName>Enabled</statusTypeName>
	<!--Optionally filter the report by plan type name.-->
	<planTypeName>ExchOrgHosting</planTypeName>
	<!--Optionally filter the report by service name.-->
	<serviceName>HostedEmail</serviceName>
  </data>
  <procedure>
	<execute namespace="Managed Plans" procedure="GetPlansByCustomer" impersonate="1">
	<before source="data" sourcePath="GUID" destination="executeData" mode="move" />
	<before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" />
	<before source="data" sourcePath="statusTypeName" destination="executeData" mode="move" />
	<before source="data" sourcePath="planTypeName" destination="executeData" mode="move" />
	<before source="data" sourcePath="serviceName" destination="executeData" mode="move" />
	<after source="executeData" destination="data" mode="merge" />
	</execute>
  </procedure>
</request>

Example XML Response

<response>
  <data>
	<!--Container element for plans collection. Empty node if no plans are present in the system-->
	<plans>
	<!--Zero or more plan definitions-->
	<plan>
		<planName>PlantinumMailHosting</planName>
		<planTypeName>ExchOrgHosting</planTypeName>
		<serviceName>HostedEmail</serviceName>
		<planDescription>Platinum EMail services</planDescription>
		<dateAssigned>2006-03-30T02:55:17.460000000</dateAssigned>
	</plan>
	</plans>
  </data>
</response>

Applies To