CRMOpportunityProduct.Create Method

The Create method creates an opportunity product.

Syntax

[Visual Basic .NET]
Public Function Create(
  ByVal Caller As CUserAuth,
  ByVal OpportunityProductXml As String
) As String
[C#]
public string Create(
  CUserAuth  Caller,
  string  OpportunityProductXml
);
[C++]
public: String* Create(
  CUserAuth*  Caller,
  String*  OpportunityProductXml
);

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must have the prvReadProduct and prvAppendToOpportunity privileges and access rights on the objects. See CUserAuth.

OpportunityProductXml

Specifies an XML string representing an opportunity product. The XML schema is described by opportunityproduct.xsd.

Return Value

Returns a String type that specifies the ID of the new opportunity product.

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";

// CRMOpportunityProduct proxy object
Microsoft.Crm.Platform.Proxy.CRMOpportunityProduct  opportunityproduct = new Microsoft.Crm.Platform.Proxy.CRMOpportunityProduct();
opportunityproduct.Credentials = System.Net.CredentialCache.DefaultCredentials;
opportunityproduct.Url = strDir + "CRMOpportunityProduct.srf";

string strErrorMsg;
string strOpportunityId = "{3BDFF384-0E6B-42F8-924E-61A40514E6F6}";
string strProductId = "{9BA55E02-89B9-4257-B541-07F926E03B0B

try
{
   Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Set up the XML string for the opportunity
   string strOpportunityXml = "<opportunityproduct>";
   strOpportunityXml += "<productid>" +  strProductId + "</productid>";
   strOpportunityXml += "<opportunityid>" + strOpportunityId + "</opportunityid>";
   strOpportunityXml += "<quantity>12</quantity></opportunityproduct>";

   // Create the opportunity
   string strOpportunityId = opportunityproduct.Create (userAuth, strOpportunityXml);

}
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.