BizUser.RetrieveBusiness Method

The RetrieveBusiness method retrieves the business information for the specified user.

Syntax

[Visual Basic .NET]
Public Function RetrieveBusiness(
  ByVal Caller As CUserAuth,
  ByVal UserId As String
) As String
[C#]
public string RetrieveBusiness(
  CUserAuth  Caller,
  string  UserId
);
[C++]
public: String* RetrieveBusiness(
  CUserAuth*  Caller,
  String*  UserId
);

Parameters

Caller

Specifies the identity of the caller. The caller must have the prvReadBusinessUnit 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.

Return Value

Returns a String type that specifies the XML data containing the user information. The XML schema is described by businessunit.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#]
// 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();

   // Retrieve the business unit for the specified user
   string strBizXml = bizUser.RetrieveBusiness(userAuth, strUserID);
}
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

© 2003 Microsoft Corporation. All rights reserved.