BizMerchant.Retrieve Method

The Retrieve method retrieves business information.

Syntax

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

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 to retrieve.

ColumnSetXml

Specifies an XML string describing the fields you would like returned for each team. Passing "" or null returns all columns. The XML schema is described by businessunit.xsd. See also ColumnSetXML Schema.

Return Value

Returns a String type that specifies the XML data containing the business unit information. The fields that are returned depend on what fields are specified in the ColumnSetXml parameter. 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#]
// 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 = "http://" + 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;
string strColumnSetXml;
string strResultXml;
try
{
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Set up the columns that you want to retrieve
   strColumnSetXml = "<columnset>";
   strColumnSetXml += "<column>businessunitid</column>";
   strColumnSetXml += "<column>name</column>";
   strColumnSetXml += "<column>address1_line1</column>";
   strColumnSetXml += "<column>address1_line2</column>";
   strColumnSetXml += "<column>address1_line3</column>";
   strColumnSetXml += "<column>address1_city</column>";
   strColumnSetXml += "<column>address1_stateorprovince</column>";
   strColumnSetXml += "<column>address1_postalcode</column>";
   strColumnSetXml += "<column>address1_telephone1</column>";
   strColumnSetXml += "</columnset>";

   // Retrieve the merchant
   strResultXml = merchant.Retrieve(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.Proxy

Assembly: microsoft.crm.proxy.dll

See Also

© 2003 Microsoft Corporation. All rights reserved.