CRMOpportunityProduct.UpdateAndRetrieve Method
The UpdateAndRetrieve method updates an opportunity product and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function UpdateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal OpportunityProductId As String,
ByVal InOpportunityProductXml As String
) As String
[C#]
public string UpdateAndRetrieve(
CUserAuth Caller,
string OpportunityProductId,
string InOpportunityProductXml
);
[C++]
public: String* UpdateAndRetrieve(
CUserAuth* Caller,
String* OpportunityProductId,
String* InOpportunityProductXml
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have prvAppendToOpportunity, prvReadProduct, and prvReadOpportunity privileges and access rights on the objects to be updated. See CUserAuth.
OpportunityProductId
Specifies the ID of the opportunity product to be updated.
InOpportunityProductXml
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 XML data representing the opportunity product. The XML schema is described by opportunityproduct.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";
// 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 strOpportunityProductId = "{69869894-638F-J892-A692-E2BC7ED23557}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the XML string to update the opportunity
string strOpportunityXml = "<opportunityproduct>";
strOpportunityXml += "<descriptionMy new description</description>";
strOpportunityXml += "<quantity>12</quantity></opportunityproduct>";
// Update the opportunity product, and then retrieve it
string strResultsXml = opportunityproduct.UpdateAndRetrieve (userAuth, strOpportunityProductId, 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