CRMOpportunity.Retrieve Method
The Retrieve method retrieves an existing opportunity.
Syntax
[Visual Basic .NET]
Public Function Retrieve(
ByVal Caller As CUserAuth,
ByVal OpportunityId As String,
ByVal ColumnSetXML As String
) As String
[C#]
public string Retrieve(
CUserAuth Caller,
string OpportunityId,
string ColumnSetXML
);
[C++]
public: String* Retrieve(
CUserAuth* Caller,
String* OpportunityId,
String* ColumnSetXML
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadOpportunity privilege to perform this action. See CUserAuth.
OpportunityId
Specifies the ID of the opportunity that is to be retrieved.
ColumnSetXML
Specifies an XML striing describing the set of columns that is to be retrieved. Passing "" or null returns all columns. You can find the valid column names in opportunity.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data containing the requested opportunity information. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. The XML schema is described by opportunity.xsd.
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.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";
// CRMAccount proxy object
Microsoft.CRM.Proxy.CRMAccount account = new Microsoft.CRM.Proxy.CRMAccount ();
account.Credentials = System.Net.CredentialCache.DefaultCredentials;
account.Url = strDir + "CRMAccount.srf";
string strErrorMsg;
string strOpportunityId= "{3BDFF384-0E6B-42F8-924E-61A40514E6F6}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>opportunityid</column>";
strColumnSetXml += "<column>name</column>";
strColumnSetXml += "</columnset>";
// Now retrieve the opportunity
string strNewOpportunity = opportunity.Retrieve(userAuth, strOpportunityId, strColumnSetXml);
}
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