CRMLead.UpdateAndRetrieve Method
The UpdateAndRetrieve method updates an existing lead and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function UpdateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal LeadId As String,
ByVal InLeadXML As String
) As String
[C#]
public string UpdateAndRetrieve(
CUserAuth Caller,
string LeadId,
string InLeadXML
);
[C++]
public: String* UpdateAndRetrieve(
CUserAuth* Caller,
String* LeadId,
String* InLeadXML
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvWriteLead and prvReadLead privileges and access rights on the object to be updated. See CUserAuth.
LeadId
Specifies the ID of the lead to be updated.
InLeadXML
Specifies an XML string containing the lead information. The XML schema is described by lead.xsd.
Return Value
Returns a String type that specifies the XML data containing the requested lead information. The XML schema is described by lead.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";
// CRMLead proxy object
Microsoft.Crm.Platform.Proxy.CRMLead lead = new Microsoft.Crm.Platform.Proxy.CRMLead ();
lead.Credentials = System.Net.CredentialCache.DefaultCredentials;
lead.Url = strDir + "CRMLead.srf";
string strErrorMsg;
string strLeadId = "{0876468B-8FC4-4381-8D81-C0B4D05E9386}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Update the XML string for the lead
string strLeadXml = "<lead>";
strLeadXml += "<firstname>George</firstname>";
strLeadXml += "</lead>";
// Now update and then retrieve the lead
string strNewLeadXml = lead.UpdateAndRetrieve(userAuth, strLeadId, strLeadXml);
}
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