Share via


CRMIncident.Route Method

The Route method routes an incident. This moves it to the user private queue, to the public queue, or to auto routing from the queue specified by SourceQueueId.

Syntax

[Visual Basic .NET]
Public Sub Route(
  ByVal Caller As CUserAuth,
  ByVal IncidentId As String,
  ByVal SourceQueueId As String,
  ByVal RouteTypeCode As ROUTE_TYPE_CODE,
  ByVal EndPointId As String
)
[C#]
public void Route(
  CUserAuth  Caller,
  string  IncidentId,
  string  SourceQueueId,
  ROUTE_TYPE_CODE  RouteTypeCode,
  string  EndPointId
);
[C++]
public: void Route(
  CUserAuth*  Caller,
  String*  IncidentId,
  String*  SourceQueueId,
  ROUTE_TYPE_CODE  RouteTypeCode,
  String*  EndPointId
);

Parameters

Caller

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

IncidentId

Specifies the ID of the incident.

SourceQueueId

Specifies the ID of the source queue.

ROUTE_TYPE_CODE

Specifies the route type. See ROUTE_TYPE_CODE. See Remarks.

EndPointId

Specifies the ID of the end point. See Remarks.

Return Value

No return value.

Remarks

If the ROUTE_TYPE_CODE is RTC_QUEUE, EndPointID must be the ID of a queue.

If the ROUTE_TYPE_CODE is RTC_USER, EndPointID must be the ID of a user.

If the ROUTE_TYPE_CODE is RTC_AUTO, EndPointID is ignored.

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;
try
{
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   string strQueueId = "{D985D31D-3C83-4FAD-BDE4-404565615CBA}";
   string strIncidentId = "{A9A6EBFD-0A6E-49A2-9245-27D9BC810704}"; 

   // Route the incident
   incident.Route(userAuth, strIncidentId, strQueueId, Microsoft.CRM.Proxy.ROUTE_TYPE_CODE.RTC_AUTO, "");
}
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.