CRMQueueItem.RetrieveByQueue Method
The RetrieveByQueue method retrieves all queue items for an existing queue.
Syntax
[Visual Basic .NET]
Public Function RetrieveByQueue(
ByVal Caller As CUserAuth,
ByVal QueueId As String,
ByVal ColumnSetXML As String
) As String
[C#]
public string RetrieveByQueue(
CUserAuth Caller,
string QueueId,
string ColumnSetXML
);
[C++]
public: String* RetrieveByQueue(
CUserAuth* Caller,
String* QueueId,
String* ColumnSetXML
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadQueue privilege to perform this action. See CUserAuth.
QueueId
Specifies the ID of the queue.
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 queueitem.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data representing the set of queue items associated with the queue. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. The XML schema is described by queueitem.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 = "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.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMQueueItem proxy object
Microsoft.CRM.Proxy.CRMQueueItem queueitem = new Microsoft.CRM.Proxy.CRMQueueItem();
queueitem.Credentials = System.Net.CredentialCache.DefaultCredentials;
queueitem.Url = strDir + "CRMQueueItem.srf";
string strErrorMsg;
string strQueueId = "{0961553A-D5DD-462E-AB11-C3750DC1A9F9}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Retrieve the queue items for the queue
string strQueueItemsXml = queueitem.RetrieveByQueue(userAuth, strQueueId, "");
}
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