CRMActivity.GetActivityParties Method
The GetActivityParties method retrieves a list of the involved parties for the specified activity.
Syntax
[Visual Basic .NET]
Public Function GetActivityParties(
ByVal Caller As CUserAuth,
ByVal ActivityId As String,
ByVal ColumnSetXml As String
) As String
[C#]
public string GetActivityParties(
CUserAuth Caller,
string ActivityId,
string ColumnSetXml
);
[C++]
public: String* GetActivityParties(
CUserAuth* Caller,
String* ActivityId,
String* ColumnSetXml
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvReadActivity privilege and access rights on the objects being retrieved. See CUserAuth.
ActivityId
Specifies the ID of the activity to find.
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 activityparty.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data containing the requested parties. The fields that are returned depend on what fields are specified in the ColumnSetXml parameter. This XML string is in the format
<activityparties> + activityparty1..N + </activityparties>
where the XML schema for each activity party is described by activityparty.xsd.
Remarks
Note When using GetActivityParties to retrieve the XML string for passing it to the SetActivityParties method, you must strip from the string any parties of type ACTIVITY_PARTY_OWNER or ACTIVITY_PARTY_REGARDING because they are read only.
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 = "https://" + 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";
// CRMActivity proxy object
Microsoft.Crm.Platform.Proxy.CRMActivity activity = new Microsoft.Crm.Platform.Proxy.CRMActivity ();
activity.Credentials = System.Net.CredentialCache.DefaultCredentials;
activity.Url = strDir + "CRMActivity.srf";
string strErrorMsg;
string strActivityId = "{33A081D8-ABFF-4103-9E9B-DB0A4B1FD48E}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>activitypartyid</column>";
strColumnSetXml += "<column>partyid</column>";
strColumnSetXml += "</columnset>";
string strPartiesXML = activity.GetActivityParties(userAuth, strActivityId, 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