CRMCustomerAddress.UpdateAndRetrieve Method
The UpdateAndRetrieve method updates a customer address and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function UpdateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal EntityId As String,
ByVal EntityXml As String,
ByVal ColumnSet As String
) As String
[C#]
public string UpdateAndRetrieve(
CUserAuth Caller,
string EntityId,
string EntityXml,
string ColumnSet
);
[C++]
public: String* UpdateAndRetrieve(
CUserAuth* Caller,
String* EntityId,
String* EntityXml,
String* ColumnSet
);
Parameters
Caller
Specifies the identity of the caller. See CUserAuth.
EntityId
Specifies the ID of the customer address to be updated.
EntityXml
Specifies the XML string containing the new customer address information. The XML schema is described by customeraddress.xsd.
ColumnSet
Specifies the XML string describing the set of columns to be retrieved. Passing an empty string or null returns all columns (Nothing or "" in VB .NET). You can find the valid column names in customeraddress.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data containing the customer address information. The fields that are returned depend on what fields are specified in the ColumnSet parameter. The XML schema is described by customeraddress.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#]
// 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";
// CRMCustomerAddress proxy object
Microsoft.Crm.Platform.Proxy.CRMCustomerAddress customeraddress = new Microsoft.Crm.Platform.Proxy.CRMCustomerAddress ();
customeraddress.Credentials = System.Net.CredentialCache.DefaultCredentials;
customeraddress.Url = strDir + "CRMCustomerAddress.srf";
string strErrorMsg;
string strCustomerAddressId = "{398912CF-1576-4EB8-A6CE-3AE25BD101D4}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Update the XML string for the customer address
string strCustomerAddressXML = "<customeraddress>";
strCustomerAddressXML += "<city>Seattle</city>";
strCustomerAddressXML += "</customeraddress>";
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>customeraddressid</column>";
strColumnSetXml += "<column>name</column>";
strColumnSetXml += "</columnset>";
// Now update the customer address
string strResultsXml = customeraddress.UpdateAndRetrieve(userAuth, strCustomerAddressId, strCustomerAddressXML, 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.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also