CRMOpportunity.Open Method

  • Article

The Open method sets the state of an opportunity to Open. The state of the opportunity must be Closed for this method to be successful.

Syntax

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

Parameters

Caller

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

OpportunityId

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

Status

Specifies the status of the opportunity. 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";

// CRMOpportunity proxy object
Microsoft.CRM.Proxy.CRMOpportunity opportunity = new Microsoft.CRM.Proxy.CRMOpportunity();
opportunity.Credentials = System.Net.CredentialCache.DefaultCredentials;
opportunity.Url = strDir + "CRMOpportunity.srf";

string strErrorMsg;
try
{
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   string strOpportunityId = "{0A9DB802-CB58-44E7-B8E2-460D3761EB39}";

   // Set up the XML string for the activity
   string activityXML = "<activity>";
   activityXML += "<activitytypecode>" +  Microsoft.CRM.Flags.ObjectType.otOpportunityCloseActivity.ToString() + "</activitytypecode>";
   activityXML += "<objectid>" + strOpportunityId + "</objectid>";
   activityXML += "<objecttypecode>" +  Microsoft.CRM.Flags.ObjectType.otOpportunity.ToString() + "</objecttypecode>";
   activityXML += "<ownerid type=\"" + Microsoft.CRM.Flags.ObjectType.otSystemUser.ToString() +"\">";
   activityXML += userAuth.UserId + "</ownerid></activity>";

   // The opportunity must be “won” or “lost” before calling this method
   opportunity.Win(userAuth, activityXML, "", -1);

   // Now open the opportunity
   opportunity.Open(userAuth, strOpportunityId, -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.