BizMerchant.UpdateAndRetrieve Method
The UpdateAndRetrieve method updates business information and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function UpdateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal BusinessId As String,
ByVal InBusinessXML As String
) As String
[C#]
public string UpdateAndRetrieve(
CUserAuth Caller,
string BusinessId,
string InBusinessXML
);
[C++]
public: String* UpdateAndRetrieve(
CUserAuth* Caller,
String* BusinessId,
String* InBusinessXML
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvWriteBusinessUnit and prvReadBusinessUnit privileges and access rights on the object to be updated. See CUserAuth.
BusinessId
Specifies the ID of the business unit to be updated.
InBusinessXML
Specifies an XML string containing the business information. The XML schema is described by businessunit.xsd.
Return Value
Returns a String type that specifies the XML data containing the updated business information. The XML schema is described by businessunit.xsd.
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.
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();
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>description</column>";
strColumnSetXml += "</columnset>";
// Retrieve the current information
string strResultXml = merchant.Retrieve(userAuth, userAuth.MerchantId, strColumnSetXml);
// Change the desired data
XmlDocument oDoc = new XmlDocument();
oDoc.LoadXml(strResultXml);
// Update the description. (Add a description if one is not already there)
XmlNodeList oNodes = oDoc.GetElementsByTagName("description");
if (oNodes == null || oNodes.Count == 0)
{
System.Xml.XmlElement oElement = oDoc.CreateElement("description");
oElement.InnerText = "My new business description.";
oDoc.FirstChild.AppendChild((System.Xml.XmlNode)oElement);
}
else
{
oNodes.Item(0).InnerText = "My new business description.";
}
strResultXml = oDoc.InnerXml;
// Update the merchant object
string outXml = merchant.UpdateAndRetrieve(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.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also