CRMProduct.RetrieveSubstitutes Method
The RetrieveSubstitutes method retrieves all of the products that are substitutes for the specified product
Syntax
[Visual Basic .NET]
Public Function RetrieveSubstitutes(
ByVal Caller As CUserAuth,
ByVal ProductId As String,
ByVal ColumnSetXml As String
) As String
[C#]
public string RetrieveSubstitutes(
CUserAuth Caller,
string ProductId,
string ColumnSetXml
);
[C++]
public: String* RetrieveSubstitutes(
CUserAuth* Caller,
String* ProductId,
String* ColumnSetXml
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadProduct privilege to perform this action. See CUserAuth.
ProductId
Specifies the ID of the product.
ColumnSetXml
Specifies an XML string describing the set of columns that is to be retrieved. Passing "" or null returns all columns. You can find the valid column names in product.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data representing the set of substitute products associated with the specified product. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. The XML schema is described by product.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";
// CRMProduct proxy object
Microsoft.CRM.Proxy.CRMProduct product = new Microsoft.CRM.Proxy.CRMProduct();
product.Credentials = System.Net.CredentialCache.DefaultCredentials;
product.Url = strDir + "CRMProduct.srf";
string strErrorMsg;
string strProductId = "{9BA55E02-89B9-4257-B541-07F926E03B0B}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>name</column>";
strColumnSetXml += "<column>description</column>";
strColumnSetXml += "<column>price</column>";
strColumnSetXml += "</columnset>";
// Retrieve the substitutes for the product
string strResultsXml = product.RetrieveSubstitutes(userAuth, strProductId, 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