BizMerchant.RetrieveMerchant Method
The RetrieveMerchant method retrieves the business information for the root business unit.
Syntax
[Visual Basic .NET]
Public Function RetrieveMerchant(
ByVal Caller As CUserAuth,
ByVal BusinessId As String
) As String
[C#]
public string RetrieveMerchant(
CUserAuth Caller,
string BusinessId
);
[C++]
public: String* RetrieveMerchant(
CUserAuth* Caller,
String* BusinessId
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvReadBusinessUnit privilege and access rights on the object 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.
Return Value
Returns a String type that contains the XML data describing the business information. The XML schema is described by businessunit.xsd.
Remarks
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();
string strResultXml = merchant.RetrieveMerchant(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.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also