BizMerchant.Update Method

The Update method updates business information.

Syntax

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

Parameters

Caller

Specifies the identity of the caller. The caller must have the prvWriteBusinessUnit privilege to perform this action. See CUserAuth.

BusinessId

Specifies the ID of the business unit to update.

BusinessXML

Specifies an XML string containing the business information. The XML schema is described by businessunit.xsd.

Return Value

No return value.

Remarks

The following fields cannot be updated by using this method: Name, ParentBusinessUnitId, and IsDisabled. To change these fields, use the ChangeName, SetParent, and Disable methods.

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 strResultXml;
string strColumnSetXml;

try
{
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Set up the columns that you want to retrieve
   strColumnSetXml = "<columnset>";
   strColumnSetXml += "<column>description</column>";
   strColumnSetXml += "</columnset>";

   // Retrieve the current information
   strResultXml = merchant.Retrieve(userAuth, userAuth.MerchantId, strColumnSetXml);

   // Change the desired data
   XmlDocument xmlDoc = new XmlDocument();
   xmlDoc.LoadXml(strResultXml);

   // Update the description. (Add a description if one is not already there)
   XmlNodeList xmlNodes = xmlDoc.GetElementsByTagName("description");

   if (xmlNodes == null || xmlNodes.Count == 0) 
   {
      System.Xml.XmlElement oElement = xmlDoc.CreateElement("description");
      oElement.InnerText  = "A wonderful business.";
      xmlDoc.FirstChild.AppendChild((System.Xml.XmlNode)oElement);
   }
   else
   {
      xmlNodes.Item(0).InnerText = "A wonderful business.";
   }

   strResultXml = xmlDoc.InnerXml;

   // Update the business
   merchant.Update(userAuth, userAuth.MerchantId, strResultXml);
} 
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.