CRMIncident.UpdateAndRetrieve Method

The UpdateAndRetrieve method updates an existing incident and then retrieves it.

Syntax

[Visual Basic .NET]
Public Function UpdateAndRetrieve(
  ByVal Caller As CUserAuth,
  ByVal IncidentId As String,
  ByVal IncidentXML As String
) As String
[C#]
public string UpdateAndRetrieve(
  CUserAuth  Caller,
  string  IncidentId,
  string  IncidentXML
);
[C++]
public: String* UpdateAndRetrieve(
  CUserAuth*  Caller,
  String*  IncidentId,
  String*  IncidentXML
);

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must have the prvWriteIncident and prvReadIncident privileges and access rights on the object to be updated. See CUserAuth.

IncidentId

Specifies the ID of the incident to be updated.

IncidentXML

Specifies an XML string containing the incident information. The XML schema is described by incident.xsd.

Return Value

Returns a String type that specifies the XML data containing the incident information. The XML schema is described by incident.xsd.

Remarks

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 = "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.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";

// CRMIncident proxy object
Microsoft.Crm.Platform.Proxy.CRMIncident  incident = new Microsoft.Crm.Platform.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.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Set up the XML string to update the incident
   string strIncidentXml = "<incident><title>New Title</title></incident>";

   // Update the incident
   string strResultXml = incident.UpdateAndRetrieve(userAuth, strIncidentId, strIncidentXml);
}
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

© 2005 Microsoft Corporation. All rights reserved.