Managed Plans::QueryCustomersByParentID

This procedure returns a list of all of the customers in the PlanManager Database with a parentID of the supplied GUID or Path.

Arguments

Remarks

The result set will include a list of customer nodes as follows:

<customers>
		<customer>
				<GUID>.</GUID>
				<type>.</type>
				<path>.</path>
		</customer>
</customers>

If customers/customer/path is not present, the customer object is orphaned in that the corresponding Active Directory object does not exist or could not be found.

This procedure will not identify orphaned reseller organization objects as reseller organizations do not have an associated ParentID. Recovery of orphaned reseller organizations is not in the scope of this feature.

Security

The caller must be at least a member of role: DomainAdmins.

Error Handling

Error Condition	Error Text
Customer instance of ParentID not found	ParentID %GUID% or %Path% not found.
Neither GUID nor path specified	You must supply either a <GUID> or <path> element.

Sample Code

Example XML Request

<request>
  <data>
	<!--The preferred domain controller for Active Directory operations.-->
	<preferredDomainController>AD01.Fabrikam.Com</preferredDomainController>
	<!--GUID of a parent customer object such as Reseller or Tenant organization. GUID should only be used when Parent object to query is on longer in Active Directory. Required if Path not specified. Both of two formats are supported: {6e315934-b0f1-4343-9a0a-c9de3ee90eef}or 3459316ef1b043439a0ac9de3ee90eef-->
	<GUID>3459316ef1b043439a0ac9de3ee90eef</GUID>
  </data>
  <procedure>
	<execute namespace="Managed Plans" procedure="QueryCustomersByParentID" impersonate="1">
	<before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" />
	<before source="data" sourcePath="GUID" destination="executeData" mode="move" />
	<after source="executeData" destination="data" mode="merge" />
	</execute>
  </procedure>
</request>

Example XML Response

<response>
  <data>
	<!--GUID of a parent customer object such as Reseller or Tenant organization.-->
	<GUID>3459316ef1b043439a0ac9de3ee90eef</GUID>
	<!--LDAP Path of a parent customer object such as a Reseller or Tenant organization.-->
	<path>LDAP://OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</path>
	<!--Container element for a collection of one or more customer instances.-->
	<customers>
	<!--Container element for a single customer instance.-->
	<customer>
		<GUID>1F444526CB6F4D5C9A59C9A84E26B618</GUID>
		<Type>BusinessOrganization</Type>
		<Path>LDAP://OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</Path>
	</customer>
	</customers>
  </data>
</response>

Applies To