CRMLead.RetrieveByObject Method

The RetrieveByObject method retrieves all leads that are associated with the specified object (contact or account).

Syntax

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

Parameters

Caller

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

Object

Specifies the object (contact or account) for which leads are to be retrieved. See CObjectName.

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 lead.xsd. See also ColumnSetXML Schema.

Return Value

Returns a String type that specifies the XML data containing the set of leads associated with the specified object (contact or account). The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. This XML string is in the format

<leads> + lead1..N + </leads>

where the XML schema for each lead is described by lead.xsd.

Remarks

Unlike the Retrieve method, the XML string returned from this method may contain multiple objects. If no objects are returned the method simply returns an XML document for the object type with no data.

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";

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

string strErrorMsg;
string strLeadId = "{0876468B-8FC4-4381-8D81-C0B4D05E9386}";
string strAccountId = "{3E24E79C-7EC5-4473-95FF-7E46FEBB534B}";
try
{
   Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Create an object name
   Microsoft.Crm.Platform.Proxy.CObjectName objName = new Microsoft.Crm.Platform.Proxy.CObjectName();
   objName.Id = strAccountId;
   objName.Type = Microsoft.Crm.Platform.Proxy.ObjectType.otAccount;

   // Set an association with the account object
   lead.SetAssociation (userAuth, strLeadId, objName);

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

   // Retrieve all of the leads for the specified object
   string strLeadsXml = lead.RetrieveByObject(userAuth, objName, 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.