CRMQueue.RetrieveQueues Method
The RetrieveQueues method retrieves private, WipBin, or public queues for the specified business or organization.
Syntax
[Visual Basic .NET]
Public Function RetrieveQueues(
ByVal Caller As CUserAuth,
ByVal QueueTypeCode As QUEUE_TYPE_CODE(),
ByVal UserId As String,
ByVal Object As CObjectName,
ByVal ColumnSetXML As String
) As String
[C#]
public string RetrieveQueues(
CUserAuth Caller,
QUEUE_TYPE_CODE[] QueueTypeCode,
string UserId,
CObjectName Object,
string ColumnSetXML
);
[C++]
public: String* RetrieveQueues(
CUserAuth* Caller,
QUEUE_TYPE_CODE QueueTypeCode __gc[],
String* UserId,
CObjectName* Object,
String* ColumnSetXML
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvReadQueue privilege and access rights on the objects to be retrieved. See CUserAuth.
QueueTypeCode
Specifies the types of queues that are to be retrieved. See QUEUE_TYPE_CODE.
UserId
Specifies the ID of the user for Private or WIP Bin queues.
Object
Specifies the public queue filter (BusinessUnit or Organization). See CObjectName.
ColumnSetXML
Specifies an XML string describing the queue. Passing an empty string or null returns all columns (Nothing or "" in VB .NET). You can find the valid column names in queue.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data representing the set of queues associated with the specified business or organization. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. This XML string is in the format
<queues> + queue1..N + </queues>
where the XML schema for each queue is described by queue.xsd.
Remarks
The XML string returned from this method may contain multiple objects. If no objects are returned the method simply returns an XML document for the object type with no data.
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 = "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.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMQueue proxy object
Microsoft.Crm.Platform.Proxy.CRMQueue queue = new Microsoft.Crm.Platform.Proxy.CRMQueue();
queue.Credentials = System.Net.CredentialCache.DefaultCredentials;
queue.Url = strDir + "CRMQueue.srf";
string strErrorMsg;
string strBizID = "{0876468B-8FC4-4381-8D81-C0B4D05E9386}";
string strUserId = "{ECF99EF1-3858-4E06-ABD9-EBFE526BF9FF}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
Microsoft.Crm.Platform.Proxy.CObjectName objName = new Microsoft.Crm.Platform.Proxy.CObjectName();
objName.Id = strBizID;
objName.Type = Microsoft.Crm.Platform.Proxy.ObjectType.otBusinessUnit;
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>name</column>";
strColumnSetXml += "<column>description</column>";
strColumnSetXml += "</columnset>";
// Set the value for queue type
Microsoft.Crm.Platform.Proxy.QUEUE_TYPE_CODE[] typecode = new Microsoft.Crm.Platform.Proxy.QUEUE_TYPE_CODE[1];
typecode[0] = Microsoft.Crm.Platform.Proxy.QUEUE_TYPE_CODE.QTC_PUBLIC;
// Retrieve the queues
string strQueuesXml = queue.RetrieveQueues(userAuth, typecode, strUserId, objName, 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.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also