BizMerchant.RetrieveAllUsers Method
The RetrieveAllUsers method retrieves all users in the specified business unit hierarchy.
The user XML data that is returned is not in the hierarchical format. Instead, it is a flat format, as shown in the following example:
Business hierarchy:
B0 - u01, u02
/ \
u11, u12 - B1 B2 - u21, u22
Returned XML data:
<SystemUsers>
<SystemUser>u01 fields</SystemUser>
<SystemUser>u02 fields</SystemUser>
<SystemUser>u11 fields</SystemUser>
<SystemUser>u12 fields</SystemUser>
<SystemUser>u21 fields</SystemUser>
<SystemUser>u22 fields</SystemUser>
</SystemUsers>
Syntax
[Visual Basic .NET]
Public Function RetrieveAllUsers(
ByVal Caller As CUserAuth,
ByVal BusinessId As String,
ByVal ColumnSet As String
) As String
[C#]
public string RetrieveAllUsers(
CUserAuth Caller,
string BusinessId,
string ColumnSet
);
[C++]
public: String* RetrieveAllUsers(
CUserAuth* Caller,
String* BusinessId,
String* ColumnSet
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadBusinessUnit privilege to perform this action. See CUserAuth.
BusinessId
Specifies the ID of the business unit. 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 contains the XML data listing all of the users. The fields that are returned for each user depend on what fields are specified in the ColumnSet parameter. The XML schema is described by systemuser.xsd.
Remarks
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.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// BizMerchant proxy object
Microsoft.CRM.Proxy.BizMerchant merchant = new Microsoft.CRM.Proxy.BizMerchant ();
merchant.Credentials = System.Net.CredentialCache.DefaultCredentials;
merchant.Url = strDir + "BizMerchant.srf";
string strErrorMsg;
try
{
Microsoft.CRM.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 += "<column>personalemailaddress</column>";
strColumnSetXml += "</columnset>";
string strResultXml = merchant.RetrieveAllUsers(userAuth, userAuth.MerchantId, strColumnSetXml);
// Now strResultXml should contain all users in the business unit hierarchy
}
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