Share via

CRMActivity.RetrieveByObject Method

  • Article

The RetrieveByObject method retrieves all related activities for a specified object:

  • If the object is a contact, retrieve all Activities with ContactId and all Activity - ActivityParties with ContactId.
  • If the object is an account, retrieve all Activities with ActivityId and all Activity - ActivityParties with ActivityId.
  • If the object is an opportunity, incident (case), or lead, retrieve all activities that are linked to the object.

Syntax

[Visual Basic .NET]
Public Function RetrieveByObject(
  ByVal Caller As CUserAuth,
  ByVal Entity As CObjectName,
  ByVal StartDate As String,
  ByVal EndDate As String,
  ByVal ActivityTypeCode As ObjectType(),
  ByVal ActivityStateCode As ACTIVITY_STATE(),
  ByVal ColumnSetXml As String
) As String

[C#]
public string RetrieveByObject(
  CUserAuth  Caller,
  CObjectName  Entity,
  string  StartDate,
  string  EndDate,
  ObjectType[]  ActivityTypeCode,
  ACTIVITY_STATE[]  ActivityStateCode,
  string  ColumnSetXml
);

[C++]
public: String* RetrieveByObject(
  CUserAuth*  Caller,
  CObjectName*  Entity,
  String*  StartDate,
  String*  EndDate,
  ObjectType  ActivityTypeCode __gc[],
  ACTIVITY_STATE  ActivityStateCode __gc[],
  String*  ColumnSetXml
);

Parameters

Caller

Specifies the identity of the caller. The caller must have the prvReadActivity privilege to perform this action. See CUserAuth.

Entity

Specifies the object (account, contact, opportunity, incident, or lead) to find. See CObjectName.

StartDate

Specifies the start date. Use this to retrieve activities that happen after this date.

EndDate

Specifies the end date. Use this to retrieve activities that happen before this date.

ActivityTypeCode

Retrieve the types of activities specified in this array.

ActivityStateCode

Retrieve activities in the states specified in this array. See ACTIVITY_STATE.

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

Return Value

Returns a String type that specifies the XML data containing the requested activities. The fields that are returned depend on what fields are specified in the ColumnSetXml parameter. The XML schema is described by activity.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";

// CRMActivity proxy object
Microsoft.CRM.Proxy.CRMActivity activity = new Microsoft.CRM.Proxy.CRMActivity ();
activity.Credentials = System.Net.CredentialCache.DefaultCredentials;
activity.Url = strDir + "CRMActivity.srf";

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

string strErrorMsg;
string strLeadId = "{75682232-E34F-47E1-8998-F0818D1E1CBD}"; 

try
{
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

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

   Microsoft.CRM.Proxy.CObjectName objName = new Microsoft.CRM.Proxy.CObjectName();
   objName.Id = strLeadId;
   objName.Type =Microsoft.CRM.Proxy.ObjectType.otLead;

   Microsoft.CRM.Proxy.ObjectType[] activityTypes = new Microsoft.CRM.Proxy.ObjectType[2];
   activityTypes[0] = Microsoft.CRM.Proxy.ObjectType.otLetterActivity;
   activityTypes[1] = Microsoft.CRM.Proxy.ObjectType.otActivity;

   Microsoft.CRM.Proxy.Flags.ACTIVITY_STATE[] activityStates = new Microsoft.CRM.Proxy.Flags.ACTIVITY_STATE[12];
   activityStates[0] = Microsoft.CRM.Proxy.Flags.ACTIVITY_STATE.ACTS_OPEN;

   // Retrieve all the activities for the specified object
   // This example has no start date nor end date specified
   string strResultsXml = activity.RetrieveByObject(userAuth, objName, "", "", activityTypes, activityStates, 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

© 2003 Microsoft Corporation. All rights reserved.