Share via


CRMActivity.Retrieve Method

The Retrieve method retrieves all the information for the specified activity.

Syntax

[Visual Basic .NET]
Public Function Retrieve(
  ByVal Caller As CUserAuth,
  ByVal ActivityId As String,
  ByRef OutPartiesXml As String
) As String

[C#]
public string Retrieve(
  CUserAuth  Caller,
  string  ActivityId,
  out string  OutPartiesXml
);

[C++]
public: String* Retrieve(
  CUserAuth*  Caller,
  String*  ActivityId,
  String**  OutPartiesXml
);

Parameters

Caller

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

ActivityId

Specifies the ID of the activity to retrieve.

OutPartiesXml

[out]  Specifies an XML string containing the requested parties. The XML schema is described by activityparty.xsd.

Return Value

Returns a String type that specifies the XML data containing the requested activities. 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";

string strErrorMsg;
string strPartiesXml;
string strActivityId = "{33A081D8-ABFF-4103-9E9B-DB0A4B1FD48E}";

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

   // Retrieve all the information for the activity
   string strResultsXml = activity.Retrieve(userAuth, strActivityId, out strPartiesXml);
} 
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.