CRMIncident.Retrieve Method
The Retrieve method retrieves an existing incident.
Syntax
[Visual Basic .NET]
Public Function Retrieve(
ByVal Caller As CUserAuth,
ByVal IncidentId As String,
ByVal ColumnSetXML As String
) As String
[C#]
public string Retrieve(
CUserAuth Caller,
string IncidentId,
string ColumnSetXML
);
[C++]
public: String* Retrieve(
CUserAuth* Caller,
String* IncidentId,
String* ColumnSetXML
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadIncident privilege to perform this action. See CUserAuth.
IncidentId
Specifies the ID of the incident that is to be retrieved.
ColumnSetXML
Specifies an XML string describing the set of columns that is to be retrieved. Passing "" or null returns all columns. You can find the valid column names in incident.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data containing the incident information. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. The XML schema is described by incident.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 = "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 columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>incidentid</column>";
// Put the incidents in order by contract
strColumnSetXml += "<ascend>contractid</ascend>";
// Filter the incidents
strColumnSetXml += "<filter column='title' operator='like' value='incident1,incident1)*' />";
strColumnSetXml += "</columnset>";
// Now retrieve the incidents
string strResultsXml = incident.Retrieve(userAuth, strIncidentId, 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.Proxy
Assembly: microsoft.crm.proxy.dll
See Also