BizUser.RetrieveAllChildUsers Method
The RetrieveAllChildUsers method retrieves all users in the reporting hierarchy of the specified user.
Syntax
[Visual Basic .NET]
Public Function RetrieveAllChildUsers(
ByVal Caller As CUserAuth,
ByVal UserId As String,
ByVal ColumnSet As String
) As String
[C#]
public string RetrieveAllChildUsers(
CUserAuth Caller,
string UserId,
string ColumnSet
);
[C++]
public: String* RetrieveAllChildUsers(
CUserAuth* Caller,
String* UserId,
String* ColumnSet
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadUser privilege to perform this action. See CUserAuth.
UserId
Specifies the ID of the user. This ID is specified by the platform and obtained at creation time.
ColumnSet
Specifies an XML string describing the fields you would like returned for each user. Passing "" or null returns all columns. The XML schema is described by systemuser.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data listing all users. The fields that are returned depend on what fields are specified in the ColumnSet parameter. The XML schema is described by systemuser.xsd.
Remarks
The returned user XML data is not in the hierarchical format. Instead, it is a flat format, as shown in the following example:
User hierarchy:
U
/ \
U1 U2
/ \ / \
U11 U12 U21 U22
Returned XML data:
<SystemUsers>
<SystemUser>
... // U1 fields
</SystemUser>
<SystemUser>
... // U2 fields
</SystemUser>
<SystemUser>
... // U11 fields
</SystemUser>
<SystemUser>
... // U12 fields
</SystemUser>
<SystemUser>
... // U21 fields
</SystemUser>
<SystemUser>
... // U22 fields
</SystemUser>
</SystemUsers>
If there is an error, SOAP throws an exception and the error message is reported in System.Web.Services.Protocols.SoapException.Detail.OuterXml.
All IDs passed to the platform are GUIDs wrapped in braces. For example: {6522D89A-A752-4455-A2B0-51494C6957C3}
Example
[C#]
// strServer should be set with the name of the platform Web server
string strServer = "myservername";
// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "https://" + strServer + "/" + virtualDirectory + "/";
// BizUser proxy object
Microsoft.CRM.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
string strErrorMsg;
string strUserId = "{ECF99EF1-3858-4E06-ABD9-EBFE526BF9FF}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>fullname</column>";
strColumnSetXml += "<column>internalemailaddress</column>";
strColumnSetXml += "</columnset>";
// Retrieve all users in the specified user hierarchy
string strUserXml = bizUser.RetrieveAllChildUsers(userAuth, strUserID, strColumnSetXml);
}
catch (System.Web.Services.Protocols.SoapException err)
{
// Process the platform error here
strErrorMsg = ("ErrorMessage: " + err.Message + " " + err.Detail.OuterXml + " Source: " + err.Source );
}
catch (Exception err)
{
// Process other errors here
strErrorMsg = ("ErrorMessage: " + err.Message );
}
Requirements
Namespace: Microsoft.CRM.Proxy
Assembly: microsoft.crm.proxy.dll
See Also