BizMerchant.RetrieveParent Method

The RetrieveParent method retrieves parent business information for a business unit.

Syntax

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

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.

Return Value

Returns a String type that specifies the XML data containing the parent business information. The XML schema is described by businessunit.xsd.

Remarks

The method fails if the business unit does not have a parent business unit.

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();

   string strResultXml = merchant.RetrieveParent(userAuth, userAuth.MerchantId);
}
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.