CRMQuery.RetrieveSharedTeams Method
The RetrieveSharedTeams method retrieves all of the teams that have access to the specified query. This method returns an empty collection XML string if the query has been made available to the whole organization.
Syntax
[Visual Basic .NET]
Public Function RetrieveSharedTeams(
ByVal Caller As CUserAuth,
ByVal QueryId As String,
ByVal ColumnSetXML As String
) As String
[C#]
public string RetrieveSharedTeams(
CUserAuth Caller,
string QueryId,
string ColumnSetXML
);
[C++]
public: String* RetrieveSharedTeams(
CUserAuth* Caller,
String* QueryId,
String* ColumnSetXML
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadQuery privilege to perform this action. See CUserAuth.
QueryId
Specifies the ID of the query.
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 savedquery.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data containing the set of teams who have access to the query. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. The XML schema is described by savedquery.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";
// CRMQuery proxy object
Microsoft.CRM.Proxy.CRMQuery query = new Microsoft.CRM.Proxy.CRMQuery();
query.Credentials = System.Net.CredentialCache.DefaultCredentials;
query.Url = strDir + "CRMQuery.srf";
string strErrorMsg;
string strQueryId= "{DC5006D0-7FD7-4908-A747-D5723166EBDF}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the columns that you want to retrieve
string strColumns = "<columnset>";
strColumns += "<column>description</column>";
strColumns += "<column >name</column>";
strColumns += "</columnset>";
// Retrieve the teams that are sharing this query
string strResultsXml = query.RetrieveSharedTeams (userAuth, strQueryId, strColumns);
}
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