CRMIncident.Close Method

The Close method sets the state of the incident to Closed.

Note   The Microsoft CRM application uses “Resolved” in the user interface for this state.

Syntax

[Visual Basic .NET]
Public Sub Close(
  ByVal Caller As CUserAuth,
  ByVal ActivityXml As String,
  ByVal PartiesXml As String,
  ByVal Status As Integer
)
[C#]
public void Close(
  CUserAuth  Caller,
  string  ActivityXml,
  string  PartiesXml,
  int  Status
);
[C++]
public: void Close(
  CUserAuth*  Caller,
  String*  ActivityXml,
  String*  PartiesXml,
  long  Status
);

Parameters

Caller

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

ActivityXml

Specifies an XML string representing an activity. . The XML schema is described by incidentresolutionactivity.xsd.

PartiesXml

Specifies an XML string representing the activity party information. . The XML schema is described by activityparty.xsd.

Status

Specifies the new status for the incident. You can use this parameter to specify application status. See Remarks.

Return Value

No return value.

Remarks

Note   The Status parameter corresponds to Status Reason in the Microsoft CRM application. If you pass -1 for this parameter, the platform sets the status to the appropriate value for the Microsoft CRM application. You can use the RetrieveStatus method to retrieve the status codes used in the application.

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

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

// CRMIncident proxy object
Microsoft.CRM.Proxy.CRMIncident  incident = new Microsoft.CRM.Proxy.CRMIncident();
incident.Credentials = System.Net.CredentialCache.DefaultCredentials;
incident.Url = strDir + "CRMIncident.srf";
string strErrorMsg;
string strIncidentId = "{A7BBE89E-99A1-408A-9BA7-BE7013F2049B}";

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

   // Set up the XML string for the closing incident activity
   string strXml = "<activity><activitytypecode>140</activitytypecode>";
   strXml += "<objecttypecode>112</objecttypecode>";
   strXml += "<objectid>" + strIncidentId + "</objectid>";
   strXml += "<ownerid type=\"" + Microsoft.CRM.Flags.ObjectType.otSystemUser.ToString() +"\">";
   strXml += userAuth.UserId + "</ownerid></activity>";

   // Close the incident
   incident.Close(userAuth, strXml, "", -1);
}
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.