CRMCompetitor.Retrieve Method

The Retrieve method retrieves a competitor.

Syntax

[Visual Basic .NET]
Public Function Retrieve(
  ByVal Caller As CUserAuth,
  ByVal CompetitorId As String,
  ByVal ColumnSetXML As String
) As String
[C#]
public string Retrieve(
  CUserAuth  Caller,
  string  CompetitorId,
  string  ColumnSetXML
);
[C++]
public: String* Retrieve(
  CUserAuth*  Caller,
  String*  CompetitorId,
  String*  ColumnSetXML
);

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must have the prvReadCompetitor privilege and access rights on the object to be retrieved. See CUserAuth.

CompetitorId

Specifies the ID of the competitor to retrieve.

ColumnSetXML

Specifies an XML string describing the set of columns that is 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 competitor.xsd. See also ColumnSetXML Schema.

Return Value

Returns a String type that specifies the XML data representing a competitor. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. The XML schema is described by competitor.xsd.

Remarks

This method always returns a single object so any filter criteria specified in the ColumnSetXML parameter are ignored.

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 = "http://" + 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";

// CRMCompetitor proxy object
Microsoft.Crm.Platform.Proxy.CRMCompetitor competitor = new Microsoft.Crm.Platform.Proxy.CRMCompetitor ();
competitor.Credentials = System.Net.CredentialCache.DefaultCredentials;
competitor.Url = strDir + "CRMCompetitor.srf";

string strErrorMsg;
string strCompetitorId = "{FC4D3D50-C934-4AB9-BDB3-6DE223A5F686}";
try
{
   Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Set up the columns that you want to retrieve
   string strColumnSetXml = "<columnset>";
   strColumnSetXml += "<column>name</column>";
   strColumnSetXml += "<column>strengths</column>";
   strColumnSetXml += "<column>weaknesses</column>";
   strColumnSetXml += "<column>opportunities</column>";
   strColumnSetXml += "</columnset>";

   // Retrieve the competitor
   string strCompetitorXml = competitor.Retrieve(userAuth, strCompetitorId, 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

© 2005 Microsoft Corporation. All rights reserved.