CRMOpportunity.UpdateAndRetrieve Method
The UpdateAndRetrieve method updates an opportunity and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function UpdateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal OpportunityId As String,
ByVal InOpportunityXML As String
) As String
[C#]
public string UpdateAndRetrieve(
CUserAuth Caller,
string OpportunityId,
string InOpportunityXML
);
[C++]
public: String* UpdateAndRetrieve(
CUserAuth* Caller,
String* OpportunityId,
String* InOpportunityXML
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvWriteOpportunity and prvReadOpportunity privileges and access rights on the object to be updated. See CUserAuth.
OpportunityId
Specifies the ID of the opportunity to be updated.
InOpportunityXML
Specifies an XML string representing the opportunity. The XML schema is described by opportunity.xsd.
Return Value
Returns a String type that specifies the XML data containing the requested opportunity information. The XML schema is described by opportunity.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";
// CRMOpportunity proxy object
Microsoft.Crm.Platform.Proxy.CRMOpportunity opportunity = new Microsoft.Crm.Platform.Proxy.CRMOpportunity();
opportunity.Credentials = System.Net.CredentialCache.DefaultCredentials;
opportunity.Url = strDir + "CRMOpportunity.srf";
string strErrorMsg;
string strOpportunityId= "{3BDFF384-0E6B-42F8-924E-61A40514E6F6}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up XML string to update the opportunity
strOpportunityXml = "<opportunity><name>New Opportunity Name</name></opportunity>";
// Now update and retrieve the opportunity
string strResultsXml = opportunity.UpdateAndRetrieve(userAuth, strOpportunityId, 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