Share via

CRMLead.Open Method

  • Article

The Open method sets the state of a lead to Open.

Syntax

[Visual Basic .NET]
Public Sub Open(
  ByVal Caller As CUserAuth,
  ByVal LeadId As String,
  ByVal Status As Integer
)
[C#]
public void Open(
  CUserAuth  Caller,
  string  LeadId,
  int  Status
);
[C++]
public: void Open(
  CUserAuth*  Caller,
  String*  LeadId,
  long  Status
);

Parameters

Caller

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

LeadId

Specifies the ID of the lead that is to be opened.

Status

Specifies the status of the lead. You can use this parameter to specify application status. See Remarks.

Return Value

No return value.

Remarks

Note   The Status parameter corresponds to Status Reason in the Microsoft CRM application. If you pass -1 for this parameter, the platform sets the status to the appropriate value for the Microsoft CRM application. You can use the RetrieveStatus method to retrieve the status codes used in the application.

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.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";

// CRMLead proxy object
Microsoft.CRM.Proxy.CRMLead lead = new Microsoft.CRM.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.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Disqualify the lead; this is necessary to set the state to Open
   lead.Disqualify(userAuth, strLeadId, -1);

   // Now open the lead
   lead.Open(userAuth, strLeadId, -1);
}
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.