CRMOpportunityProduct.Retrieve Method
The Retrieve method retrieves an opportunity product.
Syntax
[Visual Basic .NET]
Public Function Retrieve(
ByVal Caller As CUserAuth,
ByVal OpportunityProductId As String,
ByVal ColumnSetXml As String
) As String
[C#]
public string Retrieve(
CUserAuth Caller,
string OpportunityProductId,
string ColumnSetXml
);
[C++]
public: String* Retrieve(
CUserAuth* Caller,
String* OpportunityProductId,
String* ColumnSetXml
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvReadOpportunity and prvReadProduct privileges and access rights on the object to be retrieved. See CUserAuth.
OpportunityProductId
Specifies the ID of the opportunity product to be retrieved.
ColumnSetXml
Specifies an XML string describing the set of columns to be retrieved. Passing an empty string or null returns all columns (Nothing or "" in VB .NET). You can find the valid column names in opportunityproduct.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data representing the opportunity product. The fields that are returned depend on what fields are specified in the ColumnSetXml parameter. The XML schema is described by opportunityproduct.xsd.
Remarks
This method always returns a single object so any filter criteria specified in the ColumnSetXml parameter are ignored.
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.CRMOpportunity opportunity = new Microsoft.Crm.Platform.Proxy.CRMOpportunity();
opportunity.Credentials = System.Net.CredentialCache.DefaultCredentials;
opportunity.Url = strDir + "CRMOpportunity.srf";
string strErrorMsg;
string strOpportunityProductId = "{69869894-638F-J892-A692-E2BC7ED23557}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>description</column>";
strColumnSetXml += "<column>priceperunit</column>";
strColumnSetXml += "</columnset>";
// Retrieve the opportunity product
string strResultsXml = opportunityproduct.Retrieve (userAuth, strOpportunityProductId, 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.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also