CRMActivity.UpdateAndRetrieve Method
The UpdateAndRetrieve method updates an activity and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function UpdateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal ActivityId As String,
ByVal ActivityXml As String,
ByVal PartiesXml As String,
ByRef OutPartiesXml As String
) As String
[C#]
public string UpdateAndRetrieve(
CUserAuth Caller,
string ActivityId,
string ActivityXml,
string PartiesXml,
out string OutPartiesXml
);
[C++]
public: String* UpdateAndRetrieve(
CUserAuth* Caller,
String* ActivityId,
String* ActivityXml,
String* PartiesXml,
String** OutPartiesXml
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvWriteActivity and prvReadActivity privileges and access rights on the object to be updated. See CUserAuth.
ActivityId
Specifies the ID of the activity to be updated.
ActivityXml
Specifies an XML string containing the activity information. The XML schema is described by activity.xsd.
PartiesXml
Specifies an XML string describing the parties. The XML schema is described by activityparty.xsd.
OutPartiesXml
[out] Specifies an XML string containing the parties retrieved. The XML schema is described by activityparty.xsd.
Return Value
Returns a String type that specifies the XML data containing the activities retrieved. The XML schema is described by activity.xsd.
Remarks
Parties of the type ACTIVITY_PARTY_OWNER and ACTIVITY_PARTY_REGARDING are read-only. This method ignores activity parties of these types.
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 strNewPartiesXml;
string strLeadId = "{75682232-E34F-47E1-8998-F0818D1E1CBD}";
string strActivityId = "{33A081D8-ABFF-4103-9E9B-DB0A4B1FD48E}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the XML string to update the activity
string strXml = "<activity>";
strXml += "<description>This is to discuss our new project.</description>";
strXml += "</activity>";
string activityPartyXml = "<activityparties>";
activityPartyXml += "<activityparty><partyid>" + strLeadId + "</partyid>";
activityPartyXml += "<partyobjecttypecode>" + Microsoft.Crm.Platform.Types.ObjectType.otLead.ToString();
activityPartyXml += "</partyobjecttypecode>";
activityPartyXml += "<participationtypemask>" + Microsoft.Crm.Platform.Types.ACTIVITY_PARTY_TYPE.ACTIVITY_PARTY_REQUIREDATTENDEE.ToString();
activityPartyXml += "</participationtypemask></activityparty></activityparties>";
// Now update and then retrieve the activity
string strNewActivityXml = activity.UpdateAndRetrieve(userAuth, strActivityId, strXml, activityPartyXml, out strNewPartiesXml);
}
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