Share via

CRMLead.Recall Method

  • Article

The Recall method recalls a lead. A lead can be recalled when it has been assigned to a user or team but has not yet been accepted.

Syntax

[Visual Basic .NET]
Public Sub Recall(
  ByVal Caller As CUserAuth,
  ByVal LeadId As String,
  ByVal Principal As CSecurityPrincipal
)
[C#]
public void Recall(
  CUserAuth  Caller,
  string  LeadId,
  CSecurityPrincipal  Principal
);
[C++]
public: void Recall(
  CUserAuth*  Caller,
  String*  LeadId,
  CSecurityPrincipal*  Principal
);

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must have the prvWriteLead privilege and access rights on the object to be recalled. See CUserAuth.

LeadId

Specifies the ID of the lead to be recalled.

Principal

Specifies the security principal from whom the lead is to be recalled. See CSecurityPrincipal.

Return Value

No return value.

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#]
// 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}";
string strUserId = "{ECF99EF1-3858-4E06-ABD9-EBFE526BF9FF}";
try
{
   Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Create a new security principal
   Microsoft.Crm.Platform.Proxy.CSecurityPrincipal securityPrincipal = new Microsoft.Crm.Platform.Proxy.CSecurityPrincipal();
   securityPrincipal.Id = strUserId;
   securityPrincipal.Type = Microsoft.Crm.Platform.Proxy.SecurityPrincipalType.sptUser;

   // Assign the lead, pending acceptance.
   lead.AssignPendingAcceptance(userAuth, strLeadId, securityPrincipal);

   // Now recall the lead
   lead.Recall(userAuth, strLeadId, securityPrincipal);
}
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

© 2005 Microsoft Corporation. All rights reserved.