BizMerchant.RetrieveSubsidiaryUsers Method
The RetrieveSubsidiaryUsers method retrieves all user information from the child business units of the specified business unit.
Syntax
[Visual Basic .NET]
Public Function RetrieveSubsidiaryUsers(
ByVal Caller As CUserAuth,
ByVal BusinessId As String,
ByVal ColumnSetXML As String
) As String
[C#]
public string RetrieveSubsidiaryUsers(
CUserAuth Caller,
string BusinessId,
string ColumnSetXML
);
[C++]
public: String* RetrieveSubsidiaryUsers(
CUserAuth* Caller,
String* BusinessId,
String* ColumnSetXML
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvReadBusinessUnit privilege and access rights on the objects to be retrieved. See CUserAuth.
BusinessId
Specifies the ID of the business unit. This ID is specified by the platform and obtained at creation time.
ColumnSetXML
Specifies an XML string describing the fields you would like returned for each user. Passing an empty string or null returns all columns (Nothing or "" in VB .NET). The XML schema is described by systemuser.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data containing the set of child business unit users associated with the specified business unit. The fields that are returned for each user depend on what fields are specified in the ColumnSetXML parameter. This XML string is in the format
<systemusers> + systemuser1..N + </systemusers>
where the XML schema for each user is described by systemuser.xsd.
Remarks
The returned child business unit user XML data is not in the hierarchical format. Instead, it is a flat format, as shown in the following example:
User hierarchy:
B
/ \
U1 U2
/ \ / \
U11 U12 U21 U22
A call to RetrieveSubsidiaryUsers for business unit B returns the following 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>
Note This order is not guaranteed unless OrderXml is specified in the ColumnSet parameter. See ColumnSetXML Schema.
Unlike the Retrieve method, the XML string returned from this method may contain multiple objects. If no objects are returned the method simply returns an XML document for the object type with no data.
The XML string returned from this method does not contain elements for fields where the value is null or contains empty strings. This improves performance by not sending more XML data than is necessary from the server to the client.
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#]
// It is assumed that the caller has the privileges to perform this action
// 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.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// BizMerchant proxy object
Microsoft.Crm.Platform.Proxy.BizMerchant merchant = new Microsoft.Crm.Platform.Proxy.BizMerchant ();
merchant.Credentials = System.Net.CredentialCache.DefaultCredentials;
merchant.Url = strDir + "BizMerchant.srf";
string strErrorMsg;
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>systemuserid</column>";
strColumnSetXml += "<column>fullname</column>";
strColumnSetXml += "</columnset>";
string strResultXml = merchant.RetrieveSubsidiaryUsers(userAuth, userAuth.MerchantId, 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.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also